#include <ConfigEnumByPermutation.hh>

Inheritance diagram for CASM::ConfigEnumByPermutation:

Detailed Description

Enumerate all equivalent Configurations obtained by permuations in a Supercell.

The 'begin' Configuration is always the canonical form
Note that there may be other Configurations equivalent by primitive Structure factor group symmetry that can not be generated by permutations using the Supercell factor group symmetry

Definition at line 22 of file ConfigEnumByPermutation.hh.

Public Types
typedef InputEnumIterator< Configuration, true >	iterator

typedef ValueType	value_type

typedef CASM_TMP::ConstSwitch< IsConst, ValueType > &	reference

typedef long	step_type

Public Member Functions
	ConfigEnumByPermutation (const Configuration &config)

	ConfigEnumByPermutation (const Configuration &config, PermuteIterator begin, PermuteIterator end)

std::string	name () const override
	Derived enumerators must implement name, via ENUM_MEMBERS. More...

const Configuration &	generator () const

const typename std::iterator_traits< PermuteIterator >::value_type &	sym_op () const

const std::vector< typename std::iterator_traits< PermuteIterator >::value_type > &	invariant_subgroup () const

iterator	begin ()

iterator	end ()

reference	current () const
	Access the current ObjectType by reference. More...

virtual std::string	name () const=0
	Derived enumerators must implement name, via ENUM_MEMBERS. More...

virtual jsonParser	source (step_type step) const

virtual jsonParser	source (step_type step) const

step_type	step () const
	Increments with each enumerated object. More...

step_type	step () const
	Increments with each enumerated object. More...

bool	valid () const
	Returns false if enumeration is complete. More...

bool	valid () const
	Returns false if enumeration is complete. More...

Static Public Attributes
static const std::string	enumerator_name

Protected Member Functions
void	_initialize (CASM_TMP::ConstSwitch< IsConst, value_type > *_initial)

void	_initialize ()

void	_set_current_ptr (CASM_TMP::ConstSwitch< IsConst, value_type > *_new)
	Change the pointer. More...

void	_decrement_step ()
	Decrement current step value. More...

void	_increment_step ()
	Increment current step value. More...

void	_invalidate ()
	Call if enumeration complete. More...

void	_set_step (step_type val)
	Set current step value. More...

void	_set_step (step_type val)
	Set current step value. More...

void	_validate ()
	Used if random access enumerator step is moved into valid range. More...

Private Member Functions
void	increment () override
	Implement increment. More...

bool	_check (const typename std::iterator_traits< PermuteIterator >::value_type &X) const

Private Attributes
notstd::cloneable_ptr< Configuration >	m_initial

notstd::cloneable_ptr< Configuration >	m_current

PermuteIterator	m_symop_it

PermuteIterator	m_symop_end

std::vector< typename std::iterator_traits< PermuteIterator >::value_type >	m_invariant_subgroup

std::less< typename std::iterator_traits< PermuteIterator >::value_type >	m_compare

friend	InputEnumIteratorBase< ValueType, IsConst >

CASM_TMP::ConstSwitch< IsConst, value_type > *	m_current_ptr

bool	m_valid

step_type	m_step

Member Typedef Documentation

◆ iterator

typedef InputEnumIterator<Configuration , true > CASM::InputEnumeratorBase< Configuration , true >::iterator

inherited

Definition at line 204 of file InputEnumerator.hh.

◆ reference

template<typename ValueType , bool IsConst = true>

typedef CASM_TMP::ConstSwitch<IsConst, ValueType>& CASM::ValEnumerator< ValueType, IsConst >::reference

inherited

Definition at line 174 of file Enumerator.hh.

◆ step_type

template<typename ValueType , bool IsConst = true>

typedef long CASM::EnumeratorBase::step_type

inherited

Definition at line 107 of file Enumerator.hh.

◆ value_type

template<typename ValueType , bool IsConst = true>

typedef ValueType CASM::ValEnumerator< ValueType, IsConst >::value_type

inherited

Definition at line 173 of file Enumerator.hh.

Constructor & Destructor Documentation

◆ ConfigEnumByPermutation() [1/2]

CASM::ConfigEnumByPermutation::ConfigEnumByPermutation ( const Configuration & config )

Definition at line 31 of file ConfigEnumByPermutation.cc.

◆ ConfigEnumByPermutation() [2/2]

CASM::ConfigEnumByPermutation::ConfigEnumByPermutation	(	const Configuration &	config,
		PermuteIterator	begin,
		PermuteIterator	end
	)

Definition at line 36 of file ConfigEnumByPermutation.cc.

Member Function Documentation

◆ _check()

bool CASM::EnumEquivalents< Configuration , PermuteIterator , typename std::iterator_traits<PermuteIterator >::value_type , std::less<typename std::iterator_traits<PermuteIterator >::value_type > >::_check ( const typename std::iterator_traits<PermuteIterator >::value_type & X ) const

inlineprivateinherited

Returns true for one element (the "minimum" SymOp) of the left cosets of the invariant subgroup

Definition at line 122 of file EnumEquivalents.hh.

◆ _decrement_step()

template<typename ValueType , bool IsConst = true>

void CASM::EnumeratorBase::_decrement_step

inlineprotectedinherited

Decrement current step value.

Definition at line 156 of file Enumerator.hh.

◆ _increment_step()

template<typename ValueType , bool IsConst = true>

void CASM::EnumeratorBase::_increment_step

inlineprotectedinherited

Increment current step value.

Definition at line 153 of file Enumerator.hh.

◆ _initialize() [1/2]

template<typename ValueType , bool IsConst = true>

void CASM::EnumeratorBase::_initialize

inlineprotectedinherited

Initialize

Sets step to 0
Sets valid to true

Definition at line 144 of file Enumerator.hh.

◆ _initialize() [2/2]

template<typename ValueType , bool IsConst = true>

void CASM::ValEnumerator< ValueType, IsConst >::_initialize ( CASM_TMP::ConstSwitch< IsConst, value_type > * _initial )

inlineprotectedinherited

Initialize

Sets current to point at _initial
Sets step to 0
Sets valid to true

Definition at line 197 of file Enumerator.hh.

◆ _invalidate()

template<typename ValueType , bool IsConst = true>

void CASM::EnumeratorBase::_invalidate

inlineprotectedinherited

Call if enumeration complete.

Definition at line 159 of file Enumerator.hh.

◆ _set_current_ptr()

template<typename ValueType , bool IsConst = true>

void CASM::ValEnumerator< ValueType, IsConst >::_set_current_ptr ( CASM_TMP::ConstSwitch< IsConst, value_type > * _new )

inlineprotectedinherited

Change the pointer.

Definition at line 215 of file Enumerator.hh.

◆ _set_step() [1/2]

void CASM::EnumeratorBase::_set_step ( step_type val )

inlineprotectedinherited

Set current step value.

Definition at line 150 of file Enumerator.hh.

◆ _set_step() [2/2]

template<typename ValueType , bool IsConst = true>

void CASM::EnumeratorBase::_set_step

inlineprotectedinherited

Set current step value.

Definition at line 150 of file Enumerator.hh.

◆ _validate()

void CASM::EnumeratorBase::_validate ( )

inlineprotectedinherited

Used if random access enumerator step is moved into valid range.

Definition at line 162 of file Enumerator.hh.

◆ begin()

iterator CASM::InputEnumeratorBase< Configuration , true >::begin ( )

inlineinherited

Definition at line 216 of file InputEnumerator.hh.

◆ current()

template<typename ValueType , bool IsConst = true>

reference CASM::ValEnumerator< ValueType, IsConst >::current ( ) const

inlineinherited

Access the current ObjectType by reference.

Definition at line 211 of file Enumerator.hh.

◆ end()

iterator CASM::InputEnumeratorBase< Configuration , true >::end ( )

inlineinherited

Definition at line 220 of file InputEnumerator.hh.

◆ generator()

const Configuration & CASM::EnumEquivalents< Configuration , PermuteIterator , typename std::iterator_traits<PermuteIterator >::value_type , std::less<typename std::iterator_traits<PermuteIterator >::value_type > >::generator ( ) const

inlineinherited

Definition at line 91 of file EnumEquivalents.hh.

◆ increment()

void CASM::EnumEquivalents< Configuration , PermuteIterator , typename std::iterator_traits<PermuteIterator >::value_type , std::less<typename std::iterator_traits<PermuteIterator >::value_type > >::increment ( )

inlineoverrideprivatevirtualinherited

Implement increment.

Implements CASM::InputEnumeratorBase< Configuration >.

Definition at line 103 of file EnumEquivalents.hh.

◆ invariant_subgroup()

const std::vector<typename std::iterator_traits<PermuteIterator >::value_type >& CASM::EnumEquivalents< Configuration , PermuteIterator , typename std::iterator_traits<PermuteIterator >::value_type , std::less<typename std::iterator_traits<PermuteIterator >::value_type > >::invariant_subgroup ( ) const

inlineinherited

Definition at line 95 of file EnumEquivalents.hh.

◆ name() [1/2]

std::string CASM::ConfigEnumByPermutation::name ( ) const

inlineoverridevirtual

Derived enumerators must implement name, via ENUM_MEMBERS.

Implements CASM::EnumeratorBase.

Definition at line 32 of file ConfigEnumByPermutation.hh.

◆ name() [2/2]

template<typename ValueType , bool IsConst = true>

virtual std::string CASM::EnumeratorBase::name

inherited

Derived enumerators must implement name, via ENUM_MEMBERS.

◆ source() [1/2]

virtual jsonParser CASM::EnumeratorBase::source ( step_type step ) const

inlinevirtualinherited

Default Object source just uses step#

Returns:

{
  "enumerated_by": "<enumerator_type>",
  "step": <step #>
}

Definition at line 129 of file Enumerator.hh.

◆ source() [2/2]

template<typename ValueType , bool IsConst = true>

virtual jsonParser CASM::EnumeratorBase::source

inlineinherited

Default Object source just uses step#

Returns:

{
  "enumerated_by": "<enumerator_type>",
  "step": <step #>
}

Definition at line 129 of file Enumerator.hh.

◆ step() [1/2]

step_type CASM::EnumeratorBase::step ( ) const

inlineinherited

Increments with each enumerated object.

Definition at line 115 of file Enumerator.hh.

◆ step() [2/2]

template<typename ValueType , bool IsConst = true>

step_type CASM::EnumeratorBase::step

inlineinherited

Increments with each enumerated object.

Definition at line 115 of file Enumerator.hh.

◆ sym_op()

const typename std::iterator_traits<PermuteIterator >::value_type & CASM::EnumEquivalents< Configuration , PermuteIterator , typename std::iterator_traits<PermuteIterator >::value_type , std::less<typename std::iterator_traits<PermuteIterator >::value_type > >::sym_op ( ) const

inlineinherited

Definition at line 93 of file EnumEquivalents.hh.

◆ valid() [1/2]

bool CASM::EnumeratorBase::valid ( ) const

inlineinherited

Returns false if enumeration is complete.

Definition at line 118 of file Enumerator.hh.

◆ valid() [2/2]

template<typename ValueType , bool IsConst = true>

bool CASM::EnumeratorBase::valid

inlineinherited

Returns false if enumeration is complete.

Definition at line 118 of file Enumerator.hh.

Member Data Documentation

◆ enumerator_name

const std::string CASM::ConfigEnumByPermutation::enumerator_name

static

Initial value:

=

"ConfigEnumByPermutation"

Definition at line 34 of file ConfigEnumByPermutation.hh.

◆ InputEnumIteratorBase< ValueType, IsConst >

friend CASM::InputEnumeratorBase< Configuration , true >::InputEnumIteratorBase< Configuration , true >

privateinherited

Definition at line 198 of file InputEnumerator.hh.

◆ m_compare

std::less<typename std::iterator_traits<PermuteIterator >::value_type > CASM::EnumEquivalents< Configuration , PermuteIterator , typename std::iterator_traits<PermuteIterator >::value_type , std::less<typename std::iterator_traits<PermuteIterator >::value_type > >::m_compare

privateinherited

Definition at line 133 of file EnumEquivalents.hh.

◆ m_current

notstd::cloneable_ptr<Configuration > CASM::EnumEquivalents< Configuration , PermuteIterator , typename std::iterator_traits<PermuteIterator >::value_type , std::less<typename std::iterator_traits<PermuteIterator >::value_type > >::m_current

privateinherited

Definition at line 129 of file EnumEquivalents.hh.

◆ m_current_ptr

template<typename ValueType , bool IsConst = true>

CASM_TMP::ConstSwitch<IsConst, value_type>* CASM::ValEnumerator< ValueType, IsConst >::m_current_ptr

privateinherited

Definition at line 220 of file Enumerator.hh.

◆ m_initial

notstd::cloneable_ptr<Configuration > CASM::EnumEquivalents< Configuration , PermuteIterator , typename std::iterator_traits<PermuteIterator >::value_type , std::less<typename std::iterator_traits<PermuteIterator >::value_type > >::m_initial

privateinherited

Definition at line 128 of file EnumEquivalents.hh.

◆ m_invariant_subgroup

std::vector<typename std::iterator_traits<PermuteIterator >::value_type > CASM::EnumEquivalents< Configuration , PermuteIterator , typename std::iterator_traits<PermuteIterator >::value_type , std::less<typename std::iterator_traits<PermuteIterator >::value_type > >::m_invariant_subgroup

privateinherited

Definition at line 132 of file EnumEquivalents.hh.

◆ m_step

step_type CASM::EnumeratorBase::m_step

privateinherited

Definition at line 167 of file Enumerator.hh.

◆ m_symop_end

PermuteIterator CASM::EnumEquivalents< Configuration , PermuteIterator , typename std::iterator_traits<PermuteIterator >::value_type , std::less<typename std::iterator_traits<PermuteIterator >::value_type > >::m_symop_end

privateinherited

Definition at line 131 of file EnumEquivalents.hh.

◆ m_symop_it

PermuteIterator CASM::EnumEquivalents< Configuration , PermuteIterator , typename std::iterator_traits<PermuteIterator >::value_type , std::less<typename std::iterator_traits<PermuteIterator >::value_type > >::m_symop_it

privateinherited

Definition at line 130 of file EnumEquivalents.hh.

◆ m_valid

bool CASM::EnumeratorBase::m_valid

privateinherited

Definition at line 165 of file Enumerator.hh.

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

/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/clex/ConfigEnumByPermutation.hh
/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/src/casm/clex/ConfigEnumByPermutation.cc

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ iterator

◆ reference

◆ step_type

◆ value_type

Constructor & Destructor Documentation

◆ ConfigEnumByPermutation() [1/2]

◆ ConfigEnumByPermutation() [2/2]

Member Function Documentation

◆ _check()

◆ _decrement_step()

◆ _increment_step()

◆ _initialize() [1/2]

◆ _initialize() [2/2]

◆ _invalidate()

◆ _set_current_ptr()

◆ _set_step() [1/2]

◆ _set_step() [2/2]

◆ _validate()

◆ begin()

◆ current()

◆ end()

◆ generator()

◆ increment()

◆ invariant_subgroup()

◆ name() [1/2]

◆ name() [2/2]

◆ source() [1/2]

◆ source() [2/2]

◆ step() [1/2]

◆ step() [2/2]

◆ sym_op()

◆ valid() [1/2]

◆ valid() [2/2]

Member Data Documentation

◆ enumerator_name

◆ InputEnumIteratorBase< ValueType, IsConst >

◆ m_compare

◆ m_current

◆ m_current_ptr

◆ m_initial

◆ m_invariant_subgroup

◆ m_step

◆ m_symop_end

◆ m_symop_it

◆ m_valid