CASM
AClustersApproachtoStatisticalMechanics
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules
CASM::FilteredConfigIterator< IteratorType > Class Template Reference

#include <FilteredConfigIterator.hh>

+ Inheritance diagram for CASM::FilteredConfigIterator< IteratorType >:

Detailed Description

template<typename IteratorType>
class CASM::FilteredConfigIterator< IteratorType >

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 13 of file FilteredConfigIterator.hh.

Public Types

using pointer = typename IteratorType::pointer
 
using reference = typename IteratorType::reference
 

Public Member Functions

 FilteredConfigIterator ()
 
 FilteredConfigIterator (const IteratorType &_begin, const IteratorType &_end, const std::string &filter_expr, const DataFormatterDictionary< Configuration > &_dict)
 
 FilteredConfigIterator (const IteratorType &_begin, const IteratorType &_end, const std::vector< std::string > &filter_expr, const DataFormatterDictionary< Configuration > &_dict)
 
 FilteredConfigIterator (const IteratorType &_end)
 
reference operator* () const
 
pointer operator-> () const
 
bool operator== (const FilteredConfigIterator &iter) const
 
bool operator!= (const FilteredConfigIterator &iter) const
 
FilteredConfigIteratoroperator++ ()
 
FilteredConfigIterator operator++ (int)
 

Private Attributes

IteratorType m_it
 
IteratorType m_end
 
DataFormatter< Configurationm_filter
 

Friends

void swap (FilteredConfigIterator &a, FilteredConfigIterator &b)
 Definitions. More...
 

Member Typedef Documentation

template<typename IteratorType>
using CASM::FilteredConfigIterator< IteratorType >::pointer = typename IteratorType::pointer

Definition at line 26 of file FilteredConfigIterator.hh.

template<typename IteratorType>
using CASM::FilteredConfigIterator< IteratorType >::reference = typename IteratorType::reference

Definition at line 27 of file FilteredConfigIterator.hh.

Constructor & Destructor Documentation

template<typename IteratorType>
CASM::FilteredConfigIterator< IteratorType >::FilteredConfigIterator ( )
inline

Definition at line 29 of file FilteredConfigIterator.hh.

template<typename IteratorType>
CASM::FilteredConfigIterator< IteratorType >::FilteredConfigIterator ( const IteratorType &  _begin,
const IteratorType &  _end,
const std::string &  filter_expr,
const DataFormatterDictionary< Configuration > &  _dict 
)
inline

Definition at line 31 of file FilteredConfigIterator.hh.

template<typename IteratorType>
CASM::FilteredConfigIterator< IteratorType >::FilteredConfigIterator ( const IteratorType &  _begin,
const IteratorType &  _end,
const std::vector< std::string > &  filter_expr,
const DataFormatterDictionary< Configuration > &  _dict 
)
inline

Definition at line 44 of file FilteredConfigIterator.hh.

template<typename IteratorType>
CASM::FilteredConfigIterator< IteratorType >::FilteredConfigIterator ( const IteratorType &  _end)
inline

Definition at line 57 of file FilteredConfigIterator.hh.

Member Function Documentation

template<typename IteratorType>
bool CASM::FilteredConfigIterator< IteratorType >::operator!= ( const FilteredConfigIterator< IteratorType > &  iter) const
inline

Definition at line 76 of file FilteredConfigIterator.hh.

template<typename IteratorType>
reference CASM::FilteredConfigIterator< IteratorType >::operator* ( ) const
inline

Definition at line 64 of file FilteredConfigIterator.hh.

template<typename IteratorType>
FilteredConfigIterator& CASM::FilteredConfigIterator< IteratorType >::operator++ ( )
inline

Definition at line 80 of file FilteredConfigIterator.hh.

template<typename IteratorType>
FilteredConfigIterator CASM::FilteredConfigIterator< IteratorType >::operator++ ( int  )
inline

Definition at line 90 of file FilteredConfigIterator.hh.

template<typename IteratorType>
pointer CASM::FilteredConfigIterator< IteratorType >::operator-> ( ) const
inline

Definition at line 68 of file FilteredConfigIterator.hh.

template<typename IteratorType>
bool CASM::FilteredConfigIterator< IteratorType >::operator== ( const FilteredConfigIterator< IteratorType > &  iter) const
inline

Definition at line 72 of file FilteredConfigIterator.hh.

Friends And Related Function Documentation

template<typename IteratorType>
void swap ( FilteredConfigIterator< IteratorType > &  a,
FilteredConfigIterator< IteratorType > &  b 
)
friend

Definitions.

Definition at line 106 of file FilteredConfigIterator.hh.

Member Data Documentation

template<typename IteratorType>
IteratorType CASM::FilteredConfigIterator< IteratorType >::m_end
private

Definition at line 99 of file FilteredConfigIterator.hh.

template<typename IteratorType>
DataFormatter<Configuration> CASM::FilteredConfigIterator< IteratorType >::m_filter
private

Definition at line 100 of file FilteredConfigIterator.hh.

template<typename IteratorType>
IteratorType CASM::FilteredConfigIterator< IteratorType >::m_it
private

Definition at line 99 of file FilteredConfigIterator.hh.


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