CASM  1.1.0
A Clusters Approach to Statistical Mechanics
CASM::SymGroupRepHandle Class Reference

#include <SymGroupRep.hh>

Detailed Description

SymGroupRepHandle is used to provide easy remote access to a SymGroup representation The head group may be a subgroup of the MasterSymGroup where the SymGroupRep is stored.

Definition at line 185 of file SymGroupRep.hh.

Public Member Functions

 SymGroupRepHandle ()
 
 SymGroupRepHandle (const SymGroup &head_group, SymGroupRepID symrep_ID)
 
Index size () const
 Size of the associated SymGroupRep. More...
 
SymGroupRepID symrep_ID () const
 
Index dim () const
 Matrix dimension of representation. More...
 
bool empty () const
 
SymGroupRep const * rep_ptr () const
 
SymGroupRep const * operator-> () const
 
SymOpRepresentation const * operator[] (Index i) const
 
bool operator== (const SymGroupRepHandle &RHS) const
 
void set_rep (const SymGroup &head_group, SymGroupRepID symrep_ID)
 

Private Attributes

SymGroupRep const * m_group_rep
 Pointer to the SymGroupRep this is providing an interface to. More...
 
std::vector< Indexm_subgroup_op_inds
 MasterSymGroup indices of the operations in this SymGroupRep. More...
 

Constructor & Destructor Documentation

◆ SymGroupRepHandle() [1/2]

CASM::SymGroupRepHandle::SymGroupRepHandle ( )
inline

Definition at line 194 of file SymGroupRep.hh.

◆ SymGroupRepHandle() [2/2]

CASM::SymGroupRepHandle::SymGroupRepHandle ( const SymGroup head_group,
SymGroupRepID  symrep_ID 
)
inline

Definition at line 196 of file SymGroupRep.hh.

Member Function Documentation

◆ dim()

Index CASM::SymGroupRepHandle::dim ( ) const
inline

Matrix dimension of representation.

Definition at line 215 of file SymGroupRep.hh.

◆ empty()

bool CASM::SymGroupRepHandle::empty ( ) const
inline

Definition at line 219 of file SymGroupRep.hh.

◆ operator->()

SymGroupRep const* CASM::SymGroupRepHandle::operator-> ( ) const
inline

Definition at line 223 of file SymGroupRep.hh.

◆ operator==()

bool CASM::SymGroupRepHandle::operator== ( const SymGroupRepHandle RHS) const
inline

Definition at line 233 of file SymGroupRep.hh.

◆ operator[]()

SymOpRepresentation const* CASM::SymGroupRepHandle::operator[] ( Index  i) const
inline

SymOpRepresentation for this->rep_ptr()[i]

Parameters
iIndex into SymGroup, which may be a subgroup of the MasterSymGroup

Definition at line 229 of file SymGroupRep.hh.

◆ rep_ptr()

SymGroupRep const* CASM::SymGroupRepHandle::rep_ptr ( ) const
inline

Definition at line 221 of file SymGroupRep.hh.

◆ set_rep()

void CASM::SymGroupRepHandle::set_rep ( const SymGroup head_group,
SymGroupRepID  symrep_ID 
)
inline

Definition at line 238 of file SymGroupRep.hh.

◆ size()

Index CASM::SymGroupRepHandle::size ( ) const
inline

Size of the associated SymGroupRep.

Definition at line 210 of file SymGroupRep.hh.

◆ symrep_ID()

SymGroupRepID CASM::SymGroupRepHandle::symrep_ID ( ) const
inline

Definition at line 212 of file SymGroupRep.hh.

Member Data Documentation

◆ m_group_rep

SymGroupRep const* CASM::SymGroupRepHandle::m_group_rep
private

Pointer to the SymGroupRep this is providing an interface to.

Definition at line 188 of file SymGroupRep.hh.

◆ m_subgroup_op_inds

std::vector<Index> CASM::SymGroupRepHandle::m_subgroup_op_inds
private

MasterSymGroup indices of the operations in this SymGroupRep.

Definition at line 191 of file SymGroupRep.hh.


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