CASM::SymGroupRepID Class Reference

#include <SymGroupRepID.hh>

Detailed Description

Type-safe ID object for communicating and accessing Symmetry representation info.

SymGroupRepIDs can be returned by routines that creat a SymGroupRep inside the MasterSymGroup and then be shared among all objects that transform according to that representation. The representation can be accessed from the MasterSymGroup or from any SymOpRepresentation that belongs to the MasterSymGroup

Definition at line 19 of file SymGroupRepID.hh.

Public Member Functions
	SymGroupRepID (Index _group_index, Index _rep_index)
	Construct from group index (i.e., MasterSymGroup::group_index()) and representation index This constructor is typically only used by SymGroup class throws if _group_index or _rep_index are out-of-bounds (less than zero, for signed Index) More...
	SymGroupRepID ()
	Default constructor initializes group_index and rep_index as out-of-bounds SymGroupRepID::empty() returns true for default-constructed object. More...
Index	group_index () const
	Index of master group in which the corresponding SymGroupRep is stored Used internally to MasterSymGroup to verify provenance of the SymGroupRepID. More...
Index	rep_index () const
	Index of SymGroupRep within the master group Used internally to MasterSymGroup to access the correct representation. More...
bool	is_identity () const
	Returns true if SymGroupRepID corresponds to an Identity representation. More...
bool	empty () const
	Returns true if SymGroupRepID has not been initialized with valid group_index or rep_index. More...
jsonParser const &	from_json (jsonParser const &json)
	Output internal state to JSON. More...

Static Public Member Functions
static SymGroupRepID	identity (Index dim)
	Static function to construct an ID for identity representations. More...

Private Member Functions
	SymGroupRepID (Index _group_index, Index _rep_index, bool override)
	Private constructor skips bounds checks – Used for identity() and default construction. More...

Private Attributes
Index	m_group_index
Index	m_rep_index

Constructor & Destructor Documentation

CASM::SymGroupRepID::SymGroupRepID ( Index  _group_index, Index  _rep_index  )

inline

Construct from group index (i.e., MasterSymGroup::group_index()) and representation index This constructor is typically only used by SymGroup class throws if _group_index or _rep_index are out-of-bounds (less than zero, for signed Index)

Definition at line 24 of file SymGroupRepID.hh.

CASM::SymGroupRepID::SymGroupRepID ( )

inline

Default constructor initializes group_index and rep_index as out-of-bounds SymGroupRepID::empty() returns true for default-constructed object.

Definition at line 34 of file SymGroupRepID.hh.

CASM::SymGroupRepID::SymGroupRepID ( Index  _group_index, Index  _rep_index, bool  override  )

inlineprivate

Private constructor skips bounds checks – Used for identity() and default construction.

Definition at line 73 of file SymGroupRepID.hh.

Member Function Documentation

bool CASM::SymGroupRepID::empty ( ) const

inline

Returns true if SymGroupRepID has not been initialized with valid group_index or rep_index.

Definition at line 60 of file SymGroupRepID.hh.

jsonParser const& CASM::SymGroupRepID::from_json ( jsonParser const &  json )

inline

Output internal state to JSON.

Definition at line 65 of file SymGroupRepID.hh.

Index CASM::SymGroupRepID::group_index ( ) const

inline

Index of master group in which the corresponding SymGroupRep is stored Used internally to MasterSymGroup to verify provenance of the SymGroupRepID.

Definition at line 44 of file SymGroupRepID.hh.

static SymGroupRepID CASM::SymGroupRepID::identity ( Index  dim )

inlinestatic

Static function to construct an ID for identity representations.

Parameters

dim	is dimension of vector space

Definition at line 38 of file SymGroupRepID.hh.

bool CASM::SymGroupRepID::is_identity ( ) const

inline

Returns true if SymGroupRepID corresponds to an Identity representation.

Definition at line 55 of file SymGroupRepID.hh.

Index CASM::SymGroupRepID::rep_index ( ) const

inline

Index of SymGroupRep within the master group Used internally to MasterSymGroup to access the correct representation.

Definition at line 50 of file SymGroupRepID.hh.

Member Data Documentation

Index CASM::SymGroupRepID::m_group_index

private

Definition at line 79 of file SymGroupRepID.hh.

Index CASM::SymGroupRepID::m_rep_index

private

Definition at line 80 of file SymGroupRepID.hh.

---

The documentation for this class was generated from the following file:

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/symmetry/SymGroupRepID.hh