CASM::ConfigIterator< ConfigType, PrimClexType > Singleton Reference

#include <ConfigIterator.hh>

Inheritance diagram for CASM::ConfigIterator< ConfigType, PrimClexType >:

Detailed Description

template<typename ConfigType, typename PrimClexType>
singleton CASM::ConfigIterator< ConfigType, PrimClexType >

ConfigType bidirectional Iterator class Can iterate over all ConfigType in all Supercells of the PrimClex, where ConfigType = Configuration, const Configuration, Transition, or const Transition PrimClexType = PrimClex or const PrimClex

Definition at line 11 of file ConfigIterator.hh.

Public Member Functions
	ConfigIterator ()
	Definitions. More...
	ConfigIterator (PrimClexType *primclex, Index scel_index, Index config_index, bool _selected=false)
ConfigType &	operator* () const
	Specialize for Configuration, const Configuration, Transition, const Transition. More...
ConfigType *	operator-> () const
void	set_selected (bool _select)
bool	selected () const
bool	operator== (const ConfigIterator &iter) const
bool	operator!= (const ConfigIterator &iter) const
ConfigIterator &	operator++ ()
ConfigIterator	operator++ (int)
ConfigIterator &	operator-- ()
ConfigIterator	operator-- (int)
Index	config_ind () const
Index	scel_ind () const
template<>
void	set_selected (bool _select)
template<>
void	set_selected (bool _select)

Private Member Functions
int	config_list_size () const
void	_next_config ()
template<>
int	config_list_size () const
template<>
int	config_list_size () const

Private Attributes
PrimClexType *	m_primclex
Index	m_scel_index
Index	m_config_index
bool	m_selected

Friends
void	swap (ConfigIterator &a, ConfigIterator &b)

Constructor & Destructor Documentation

template<typename ConfigType , typename PrimClexType >

CASM::ConfigIterator< ConfigType, PrimClexType >::ConfigIterator

(

)

Definitions.

Definition at line 82 of file ConfigIterator.hh.

template<typename ConfigType , typename PrimClexType>

CASM::ConfigIterator< ConfigType, PrimClexType >::ConfigIterator	(	PrimClexType *	primclex,
		Index	scel_index,
		Index	config_index,
		bool	_selected = false
	)

Definition at line 92 of file ConfigIterator.hh.

Member Function Documentation

template<typename ConfigType , typename PrimClexType >

void CASM::ConfigIterator< ConfigType, PrimClexType >::_next_config ( )

private

Definition at line 139 of file ConfigIterator.hh.

template<typename ConfigType, typename PrimClexType>

Index CASM::ConfigIterator< ConfigType, PrimClexType >::config_ind ( ) const

inline

Definition at line 62 of file ConfigIterator.hh.

template<>

int CASM::ConfigIterator< Configuration, PrimClex >::config_list_size ( ) const

private

Definition at line 46 of file ConfigIterator.cc.

template<>

int CASM::ConfigIterator< const Configuration, const PrimClex >::config_list_size ( ) const

private

Definition at line 51 of file ConfigIterator.cc.

template<typename ConfigType, typename PrimClexType>

int CASM::ConfigIterator< ConfigType, PrimClexType >::config_list_size ( ) const

private

template<typename ConfigType , typename PrimClexType >

bool CASM::ConfigIterator< ConfigType, PrimClexType >::operator!=

(

const ConfigIterator< ConfigType, PrimClexType > &

iter

)

const

Definition at line 133 of file ConfigIterator.hh.

template<typename ConfigType , typename PrimClexType >

ConfigType & CASM::ConfigIterator< ConfigType, PrimClexType >::operator*

(

)

const

Specialize for Configuration, const Configuration, Transition, const Transition.

Definition at line 109 of file ConfigIterator.hh.

template<typename ConfigType , typename PrimClexType >

ConfigIterator< ConfigType, PrimClexType > & CASM::ConfigIterator< ConfigType, PrimClexType >::operator++

(

)

Definition at line 149 of file ConfigIterator.hh.

template<typename ConfigType , typename PrimClexType >

ConfigIterator< ConfigType, PrimClexType > CASM::ConfigIterator< ConfigType, PrimClexType >::operator++

(

int

)

Definition at line 167 of file ConfigIterator.hh.

template<typename ConfigType , typename PrimClexType >

ConfigIterator< ConfigType, PrimClexType > & CASM::ConfigIterator< ConfigType, PrimClexType >::operator--

(

)

Definition at line 175 of file ConfigIterator.hh.

template<typename ConfigType , typename PrimClexType >

ConfigIterator< ConfigType, PrimClexType > CASM::ConfigIterator< ConfigType, PrimClexType >::operator--

(

int

)

Definition at line 187 of file ConfigIterator.hh.

template<typename ConfigType , typename PrimClexType >

ConfigType * CASM::ConfigIterator< ConfigType, PrimClexType >::operator->

(

)

const

Definition at line 118 of file ConfigIterator.hh.

template<typename ConfigType , typename PrimClexType >

bool CASM::ConfigIterator< ConfigType, PrimClexType >::operator==

(

const ConfigIterator< ConfigType, PrimClexType > &

iter

)

const

Definition at line 128 of file ConfigIterator.hh.

template<typename ConfigType, typename PrimClexType>

Index CASM::ConfigIterator< ConfigType, PrimClexType >::scel_ind ( ) const

inline

Definition at line 65 of file ConfigIterator.hh.

template<typename ConfigType , typename PrimClexType >

bool CASM::ConfigIterator< ConfigType, PrimClexType >::selected

(

)

const

Definition at line 123 of file ConfigIterator.hh.

template<>

void CASM::ConfigIterator< Configuration, PrimClex >::set_selected

(

bool

_select

)

Specialize for Configuration, const Configuration, Transition, const Transition

Definition at line 35 of file ConfigIterator.cc.

template<>

void CASM::ConfigIterator< const Configuration, const PrimClex >::set_selected

(

bool

_select

)

Definition at line 40 of file ConfigIterator.cc.

template<typename ConfigType, typename PrimClexType>

void CASM::ConfigIterator< ConfigType, PrimClexType >::set_selected

(

bool

_select

)

Friends And Related Function Documentation

template<typename ConfigType, typename PrimClexType>

void swap ( ConfigIterator< ConfigType, PrimClexType > &  a, ConfigIterator< ConfigType, PrimClexType > &  b  )

friend

Definition at line 195 of file ConfigIterator.hh.

Member Data Documentation

template<typename ConfigType, typename PrimClexType>

Index CASM::ConfigIterator< ConfigType, PrimClexType >::m_config_index

private

Definition at line 26 of file ConfigIterator.hh.

template<typename ConfigType, typename PrimClexType>

PrimClexType* CASM::ConfigIterator< ConfigType, PrimClexType >::m_primclex

private

Definition at line 24 of file ConfigIterator.hh.

template<typename ConfigType, typename PrimClexType>

Index CASM::ConfigIterator< ConfigType, PrimClexType >::m_scel_index

private

Definition at line 25 of file ConfigIterator.hh.

template<typename ConfigType, typename PrimClexType>

bool CASM::ConfigIterator< ConfigType, PrimClexType >::m_selected

private

Definition at line 27 of file ConfigIterator.hh.

---

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

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