CASM  1.1.0
A Clusters Approach to Statistical Mechanics
Public Types | Public Member Functions | Private Attributes | Friends | List of all members
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 26 of file FilteredConfigIterator.hh.

Public Types

using pointer = typename IteratorType::pointer
 
using reference = typename IteratorType::reference
 
using DataObject = typename IteratorType::value_type
 

Public Member Functions

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

Private Attributes

IteratorType m_it
 
IteratorType m_end
 
DataFormatter< DataObject > m_filter
 

Friends

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

Member Typedef Documentation

◆ DataObject

template<typename IteratorType >
using CASM::FilteredConfigIterator< IteratorType >::DataObject = typename IteratorType::value_type

Definition at line 32 of file FilteredConfigIterator.hh.

◆ pointer

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

Definition at line 30 of file FilteredConfigIterator.hh.

◆ reference

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

Definition at line 31 of file FilteredConfigIterator.hh.

Constructor & Destructor Documentation

◆ FilteredConfigIterator() [1/4]

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

Definition at line 34 of file FilteredConfigIterator.hh.

◆ FilteredConfigIterator() [2/4]

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

Definition at line 36 of file FilteredConfigIterator.hh.

◆ FilteredConfigIterator() [3/4]

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

Definition at line 48 of file FilteredConfigIterator.hh.

◆ FilteredConfigIterator() [4/4]

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

Definition at line 60 of file FilteredConfigIterator.hh.

Member Function Documentation

◆ operator!=()

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

Definition at line 75 of file FilteredConfigIterator.hh.

◆ operator*()

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

Definition at line 67 of file FilteredConfigIterator.hh.

◆ operator++() [1/2]

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

Definition at line 79 of file FilteredConfigIterator.hh.

◆ operator++() [2/2]

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

Definition at line 89 of file FilteredConfigIterator.hh.

◆ operator->()

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

Definition at line 69 of file FilteredConfigIterator.hh.

◆ operator==()

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

Definition at line 71 of file FilteredConfigIterator.hh.

Friends And Related Function Documentation

◆ swap

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

Definitions.

Definition at line 104 of file FilteredConfigIterator.hh.

Member Data Documentation

◆ m_end

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

Definition at line 98 of file FilteredConfigIterator.hh.

◆ m_filter

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

Definition at line 99 of file FilteredConfigIterator.hh.

◆ m_it

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

Definition at line 98 of file FilteredConfigIterator.hh.

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