mpqc::FermionStringCompleteSet< FString >::Iterator Struct Reference

Collaboration diagram for mpqc::FermionStringCompleteSet< FString >::Iterator:

Documentation

template<typename FString>
struct mpqc::FermionStringCompleteSet< FString >::Iterator

iterator is a proxy to a FString object, stores an ordinal

Public Types
using	ordinal_type = std::int64_t

Public Member Functions
	Iterator ()=default
	Iterator (int nstates, ordinal_type ord)
	Iterator (const FString &str)
	Iterator (const Iterator &)=default
	Iterator (Iterator &&)=default
Iterator &	operator= (const Iterator &)=default
Iterator &	operator= (Iterator &&)=default
std::pair< FString, ordinal_type > &	dereference () const
bool	equal (const Iterator &other) const
void	increment ()
auto	ordinal () const

Friends
class	boost::iterator_core_access

Member Typedef Documentation

ordinal_type

template<typename FString >

using mpqc::FermionStringCompleteSet< FString >::Iterator::ordinal_type = std::int64_t

Constructor & Destructor Documentation

Iterator() [1/5]

template<typename FString >

mpqc::FermionStringCompleteSet< FString >::Iterator::Iterator ( )

default

Iterator() [2/5]

template<typename FString >

mpqc::FermionStringCompleteSet< FString >::Iterator::Iterator ( int  nstates, ordinal_type  ord  )

inline

Iterator() [3/5]

template<typename FString >

mpqc::FermionStringCompleteSet< FString >::Iterator::Iterator ( const FString &  str )

inline

Iterator() [4/5]

template<typename FString >

mpqc::FermionStringCompleteSet< FString >::Iterator::Iterator ( const Iterator &  )

default

Iterator() [5/5]

template<typename FString >

mpqc::FermionStringCompleteSet< FString >::Iterator::Iterator ( Iterator &&  )

default

Member Function Documentation

dereference()

template<typename FString >

std::pair<FString, ordinal_type>& mpqc::FermionStringCompleteSet< FString >::Iterator::dereference ( ) const

inline

equal()

template<typename FString >

bool mpqc::FermionStringCompleteSet< FString >::Iterator::equal ( const Iterator &  other ) const

inline

Comparison operator.

Parameters

[in]

other

Returns

true if other and *this have same ordinal and same number of states

increment()

template<typename FString >

void mpqc::FermionStringCompleteSet< FString >::Iterator::increment ( )

inline

operator=() [1/2]

template<typename FString >

Iterator& mpqc::FermionStringCompleteSet< FString >::Iterator::operator= ( const Iterator &  )

default

operator=() [2/2]

template<typename FString >

Iterator& mpqc::FermionStringCompleteSet< FString >::Iterator::operator= ( Iterator &&  )

default

ordinal()

template<typename FString >

auto mpqc::FermionStringCompleteSet< FString >::Iterator::ordinal ( ) const

inline

Friends And Related Function Documentation

boost::iterator_core_access

template<typename FString >

friend class boost::iterator_core_access

friend

---

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

• mpqc/math/fock/string.h