SymGroupRepID.hh

Go to the documentation of this file.

#ifndef SYMGROUPREPID_HH
#define SYMGROUPREPID_HH
 
#include <iostream>
#include <stdexcept>
 
#include "casm/global/definitions.hh"
 
namespace CASM {
 
class jsonParser;
 
 
class SymGroupRepID {
 public:
  SymGroupRepID(Index _group_index, Index _rep_index)
      : m_group_index(_group_index), m_rep_index(_rep_index) {
    if (!(valid_index(_group_index) && valid_index(_rep_index))) {
      throw std::runtime_error(std::string(
          "SymGroupRepID initialized with out-of-bounds values!\n"));
    }
  }
 
  SymGroupRepID() : SymGroupRepID(-1, -1, true) {}
 
  static SymGroupRepID identity(Index dim) {
    return SymGroupRepID(-2, dim, true);
  }
 
  Index group_index() const { return m_group_index; }
 
  Index rep_index() const { return m_rep_index; }
 
  bool is_identity() const { return group_index() == Index(-2); }
 
  bool empty() const {
    return group_index() == Index(-1) || rep_index() == Index(-1);
  }
 
  jsonParser const &from_json(jsonParser const &json);
 
 private:
  SymGroupRepID(Index _group_index, Index _rep_index, bool override)
      : m_group_index(_group_index), m_rep_index(_rep_index) {}
 
  Index m_group_index;
  Index m_rep_index;
};
 
inline bool operator==(SymGroupRepID const &a, SymGroupRepID const &b) {
  return a.group_index() == b.group_index() && a.rep_index() == b.rep_index();
}
 
inline bool operator!=(SymGroupRepID const &a, SymGroupRepID const &b) {
  return !(a == b);
}
 
inline bool operator<(SymGroupRepID const &a, SymGroupRepID const &b) {
  return (a.group_index() < b.group_index()) ||
         (a.group_index() == b.group_index() && a.rep_index() < b.rep_index());
}
 
jsonParser &to_json(SymGroupRepID const &_id, jsonParser &json);
 
jsonParser const &from_json(SymGroupRepID &_id, jsonParser const &json);
 
inline std::ostream &operator<<(std::ostream &out, SymGroupRepID const &_id) {
  out << "{group_index = " << _id.group_index()
      << ", rep_index = " << _id.rep_index() << "}";
  return out;
}
 
}  // namespace CASM
#endif