CASM::IsCanonical< _OrbitType > Struct Template Reference

#include <OrbitGeneration.hh>

Detailed Description

template<typename _OrbitType>
struct CASM::IsCanonical< _OrbitType >

Functor to find to check if element is in canonical form.

• Uses generating SymGroup, SymCompareType::prepare, SymCompareType::compare

Definition at line 141 of file OrbitGeneration.hh.

Public Types
typedef _OrbitType	OrbitType
typedef OrbitType::Element	Element
typedef OrbitType::SymCompareType	SymCompareType

Public Member Functions
	IsCanonical (const std::vector< SymOp > &_generating_group, const SymCompareType &_sym_compare)
bool	operator() (const Element &e) const
	Applies symmetry to check if any Element is greater than e. More...

Public Attributes
const std::vector< SymOp > &	generating_group
const SymCompareType &	sym_compare

Member Typedef Documentation

Element

template<typename _OrbitType >

typedef OrbitType::Element CASM::IsCanonical< _OrbitType >::Element

Definition at line 143 of file OrbitGeneration.hh.

OrbitType

template<typename _OrbitType >

typedef _OrbitType CASM::IsCanonical< _OrbitType >::OrbitType

Definition at line 142 of file OrbitGeneration.hh.

SymCompareType

template<typename _OrbitType >

typedef OrbitType::SymCompareType CASM::IsCanonical< _OrbitType >::SymCompareType

Definition at line 144 of file OrbitGeneration.hh.

Constructor & Destructor Documentation

IsCanonical()

template<typename _OrbitType >

CASM::IsCanonical< _OrbitType >::IsCanonical	(	const std::vector< SymOp > &	_generating_group,
		const SymCompareType &	_sym_compare
	)

Definition at line 169 of file OrbitGeneration_impl.hh.

Member Function Documentation

operator()()

template<typename _OrbitType >

bool CASM::IsCanonical< _OrbitType >::operator()

(

const Element &

e

)

const

Applies symmetry to check if any Element is greater than e.

Definition at line 176 of file OrbitGeneration_impl.hh.

Member Data Documentation

generating_group

template<typename _OrbitType >

const std::vector<SymOp>& CASM::IsCanonical< _OrbitType >::generating_group

Definition at line 146 of file OrbitGeneration.hh.

sym_compare

template<typename _OrbitType >

const SymCompareType& CASM::IsCanonical< _OrbitType >::sym_compare

Definition at line 147 of file OrbitGeneration.hh.

---

The documentation for this struct was generated from the following files:

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