#include <InputEnumerator.hh>

Inheritance diagram for CASM::InputEnumeratorBase< ValueType, IsConst >:

Detailed Description

template<typename ValueType, bool IsConst = true>
class CASM::InputEnumeratorBase< ValueType, IsConst >

Base class for implementing specialized input enumerators.

InputEnumerator allow single pass iteration over some objects of ValueType. The specialized class should document any guaranteed properties of the enumerated objects. For instance, some enumerators may guarantee that objects will be unique, others may not. Some may guarantee objects will be primitive or in canonical form, others may not. Etc.

Derived classes (ex. MyDerivedEnumClass) must implement:

constructors
- Must call _initialize or _set_current_ptr to set pointer to first valid object
- Ensure that the current step value = 0
- If due to the constructor arguments there are no valid objects, then call _invalidate
virtual destructor
void increment()
- Implementation must do work, using _set_current_ptr if necessary to point the enumerator at the object to be deferenced
- Then if still valid call _increment_step, or if no longer valid ('end' has been reached) call _invalidate

Derived classes should contain ENUMERATOR_MEMBERS(MyDerivedClass) in the class definition to automatically implement:

name

In CASM namespace near the derived class definition, include:

For enumerators only meant to be used internally:
- In header:
  - ENUMERATOR_TRAITS(MyDerivedEnumClass)
- In the source code file:
  - const std::string traits<MyDerivedEnumClass>::name = "MyDerivedEnumClass";
For enumerators only meant to be added to the API:
- In header:
  - ENUMERATOR_INTERFACE_TRAITS(MyDerivedClass)
- In the source code file:
  - const std::string traits<MyDerivedEnumClass>::name =
    
    "MyDerivedEnumClass"; const std::string
    
    traits<MyDerivedEnumClass>::help =
    
    "MyDerivedEnumClass: \n\n"
    
    " kwarg1: type (default=X) \n"
    
    " Description of kwarg1... \n\n"
    
    " kwarg2: type (default=X) \n"
    
    " Description of kwarg2... \n\n"
    
    " ... \n";
    
    int EnumInterface<MyDerivedEnumClass>::run(PrimClex &primclex, const
    
    jsonParser &kwargs) const {
    
    ...
    
    implementation to run a MyDerivedEnumClass enumerator constructed
    
    using the JSON input in 'kwargs' and store & save results in
    
    primclex
    
    ...
    
    return (returncode);
    
    }
    
    CASM::ConfigEnumIO::name
    GenericDatumFormatter< std::string, ConfigEnumDataType > name()
    Definition: ConfigEnumIO_impl.hh:54
    
    CASM::help
    std::string help()
    Uses 'multiline_help<T>()' by default.
    Definition: Help.hh:22
    
    primclex
    PrimClex * primclex
    Definition: settings.cc:135

Definition at line 197 of file InputEnumerator.hh.

Public Types
typedef InputEnumIterator< ValueType, IsConst >	iterator

typedef ValueType	value_type

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

typedef long	step_type

Public Member Functions
	InputEnumeratorBase ()

virtual	~InputEnumeratorBase ()

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 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...

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
virtual void	increment ()=0

Private Attributes
friend	InputEnumIteratorBase< ValueType, IsConst >

CASM_TMP::ConstSwitch< IsConst, value_type > *	m_current_ptr

bool	m_valid

step_type	m_step

Member Typedef Documentation

◆ iterator

template<typename ValueType , bool IsConst = true>

typedef InputEnumIterator<ValueType, IsConst> CASM::InputEnumeratorBase< ValueType, IsConst >::iterator

Definition at line 204 of file InputEnumerator.hh.

◆ reference

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

inherited

Definition at line 174 of file Enumerator.hh.

◆ step_type

typedef long CASM::EnumeratorBase::step_type

inherited

Definition at line 175 of file Enumerator.hh.

◆ value_type

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

inherited

Definition at line 173 of file Enumerator.hh.

Constructor & Destructor Documentation

◆ InputEnumeratorBase()

template<typename ValueType , bool IsConst = true>

CASM::InputEnumeratorBase< ValueType, IsConst >::InputEnumeratorBase ( )

inline

Definition at line 206 of file InputEnumerator.hh.

◆ ~InputEnumeratorBase()

template<typename ValueType , bool IsConst = true>

virtual CASM::InputEnumeratorBase< ValueType, IsConst >::~InputEnumeratorBase ( )

inlinevirtual

Definition at line 208 of file InputEnumerator.hh.

Member Function Documentation

◆ _decrement_step()

void CASM::EnumeratorBase::_decrement_step

inlineprotectedinherited

Decrement current step value.

Definition at line 202 of file Enumerator.hh.

◆ _increment_step()

void CASM::EnumeratorBase::_increment_step

inlineprotectedinherited

Increment current step value.

Definition at line 203 of file Enumerator.hh.

◆ _initialize() [1/2]

void CASM::EnumeratorBase::_initialize

inlineprotectedinherited

Initialize

Sets step to 0
Sets valid to true

Definition at line 190 of file Enumerator.hh.

◆ _initialize() [2/2]

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()

void CASM::EnumeratorBase::_invalidate

inlineprotectedinherited

Call if enumeration complete.

Definition at line 204 of file Enumerator.hh.

◆ _set_current_ptr()

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]

void CASM::EnumeratorBase::_set_step

inlineprotectedinherited

Set current step value.

Definition at line 205 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()

template<typename ValueType , bool IsConst = true>

iterator CASM::InputEnumeratorBase< ValueType, IsConst >::begin ( )

inline

Definition at line 216 of file InputEnumerator.hh.

◆ current()

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

inlineinherited

Access the current ObjectType by reference.

Definition at line 211 of file Enumerator.hh.

◆ end()

template<typename ValueType , bool IsConst = true>

iterator CASM::InputEnumeratorBase< ValueType, IsConst >::end ( )

inline

Definition at line 220 of file InputEnumerator.hh.

◆ increment()

template<typename ValueType , bool IsConst = true>

virtual void CASM::InputEnumeratorBase< ValueType, IsConst >::increment ( )

privatepure virtual

Implemented in CASM::EnumEquivalents< ObjectType, SymOpIterator, SymOpType, SymOpCompare >, CASM::EnumEquivalents< xtal::Lattice, std::vector< CASM::SymOp >::const_iterator, CASM::SymOp, SymRepIndexCompare >, CASM::EnumEquivalents< Configuration, PermuteIterator >, CASM::EnumEquivalents< Supercell, std::vector< SymOp >::const_iterator, SymOp, SymRepIndexCompare >, CASM::RandomAccessEnumeratorBase< ValueType, IsConst >, CASM::SuperConfigEnum, CASM::ScelEnumByProps, CASM::ConfigEnumStrain, CASM::ConfigEnumSiteDoFs, CASM::ConfigEnumRandomOccupations, CASM::ConfigEnumRandomLocal, and CASM::ConfigEnumAllOccupations.

◆ name() [1/2]

virtual std::string CASM::EnumeratorBase::name ( ) const

pure virtualinherited

Derived enumerators must implement name, via ENUM_MEMBERS.

Implemented in CASM::LatticeEnumEquivalents, CASM::SuperConfigEnum, CASM::ScelEnumEquivalents, CASM::ScelEnumByProps, CASM::ConfigEnumStrain, CASM::ConfigEnumSiteDoFs, CASM::ConfigEnumRandomOccupations, CASM::ConfigEnumRandomLocal, CASM::ConfigEnumByPermutation, and CASM::ConfigEnumAllOccupations.

◆ name() [2/2]

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]

virtual jsonParser CASM::EnumeratorBase::source

inlineinherited

Default Object source just uses step#

Returns:

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

Definition at line 185 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]

step_type CASM::EnumeratorBase::step

inlineinherited

Increments with each enumerated object.

Definition at line 186 of file Enumerator.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]

bool CASM::EnumeratorBase::valid

inlineinherited

Returns false if enumeration is complete.

Definition at line 187 of file Enumerator.hh.

Member Data Documentation

◆ InputEnumIteratorBase< ValueType, IsConst >

template<typename ValueType , bool IsConst = true>

friend CASM::InputEnumeratorBase< ValueType, IsConst >::InputEnumIteratorBase< ValueType, IsConst >

private

Definition at line 198 of file InputEnumerator.hh.

◆ m_current_ptr

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

privateinherited

Definition at line 220 of file Enumerator.hh.

◆ m_step

step_type CASM::EnumeratorBase::m_step

privateinherited

Definition at line 167 of file Enumerator.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 file:

/Users/bpuchala/Work/codes/CASMcode_v0.2.X_reference/include/casm/enumerator/InputEnumerator.hh

Detailed Description

template<typename ValueType, bool IsConst = true> class CASM::InputEnumeratorBase< ValueType, IsConst >

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ iterator

◆ reference

◆ step_type

◆ value_type

Constructor & Destructor Documentation

◆ InputEnumeratorBase()

◆ ~InputEnumeratorBase()

Member Function Documentation

◆ _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()

◆ increment()

◆ name() [1/2]

◆ name() [2/2]

◆ source() [1/2]

◆ source() [2/2]

◆ step() [1/2]

◆ step() [2/2]

◆ valid() [1/2]

◆ valid() [2/2]

Member Data Documentation

◆ InputEnumIteratorBase< ValueType, IsConst >

◆ m_current_ptr

◆ m_step

◆ m_valid

template<typename ValueType, bool IsConst = true>
class CASM::InputEnumeratorBase< ValueType, IsConst >