CASM::ScelIsCanonical< _ElementType > Struct Template Reference

#include <ScelOrbitGeneration.hh>

Detailed Description

template<typename _ElementType>
struct CASM::ScelIsCanonical< _ElementType >

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

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

Definition at line 74 of file ScelOrbitGeneration.hh.

Public Types
typedef _ElementType	Element
typedef ScelPeriodicSymCompare< Element >	SymCompareType

Public Member Functions
	ScelIsCanonical (const Supercell &_scel)
const Supercell &	supercell () const
const SymCompareType &	sym_compare () const
bool	operator() (const Element &e) const
	Applies symmetry to check if any Element is greater than e. More...
template<typename PermuteIteratorIt >
bool	operator() (const Element &e, PermuteIteratorIt begin, PermuteIteratorIt end) const
	Applies symmetry to check if any Element is greater than e. More...

Public Attributes
const Supercell *	m_scel
SymCompareType	m_sym_compare

Member Typedef Documentation

Element

template<typename _ElementType >

typedef _ElementType CASM::ScelIsCanonical< _ElementType >::Element

Definition at line 75 of file ScelOrbitGeneration.hh.

SymCompareType

template<typename _ElementType >

typedef ScelPeriodicSymCompare<Element> CASM::ScelIsCanonical< _ElementType >::SymCompareType

Definition at line 76 of file ScelOrbitGeneration.hh.

Constructor & Destructor Documentation

ScelIsCanonical()

template<typename _ElementType >

CASM::ScelIsCanonical< _ElementType >::ScelIsCanonical

(

const Supercell &

_scel

)

Definition at line 88 of file ScelOrbitGeneration_impl.hh.

Member Function Documentation

operator()() [1/2]

template<typename _ElementType >

bool CASM::ScelIsCanonical< _ElementType >::operator()

(

const Element &

e

)

const

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

• Use [supercell().permute_begin(), supercell().permute_end()) to canonicalize

Definition at line 106 of file ScelOrbitGeneration_impl.hh.

operator()() [2/2]

template<typename _ElementType >

template<typename PermuteIteratorIt >

bool CASM::ScelIsCanonical< _ElementType >::operator()	(	const Element &	e,
		PermuteIteratorIt	begin,
		PermuteIteratorIt	end
	)		const

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

Definition at line 114 of file ScelOrbitGeneration_impl.hh.

supercell()

template<typename _ElementType >

const Supercell & CASM::ScelIsCanonical< _ElementType >::supercell

Definition at line 94 of file ScelOrbitGeneration_impl.hh.

sym_compare()

template<typename _ElementType >

const ScelIsCanonical< _ElementType >::SymCompareType & CASM::ScelIsCanonical< _ElementType >::sym_compare

Definition at line 100 of file ScelOrbitGeneration_impl.hh.

Member Data Documentation

m_scel

template<typename _ElementType >

const Supercell* CASM::ScelIsCanonical< _ElementType >::m_scel

Definition at line 94 of file ScelOrbitGeneration.hh.

m_sym_compare

template<typename _ElementType >

SymCompareType CASM::ScelIsCanonical< _ElementType >::m_sym_compare

Definition at line 95 of file ScelOrbitGeneration.hh.

---

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

• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/clex/ScelOrbitGeneration.hh
• /Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/clex/ScelOrbitGeneration_impl.hh