mpqc::StringToSortedVector< String, Value, Compare, Equal, HashMap >::Iterator Struct Reference
Collaboration diagram for mpqc::StringToSortedVector< String, Value, Compare, Equal, HashMap >::Iterator:

Documentation

template<typename String, typename Value, typename Compare, typename Equal, template< typename... > class HashMap>
struct mpqc::StringToSortedVector< String, Value, Compare, Equal, HashMap >::Iterator

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

Public Member Functions

 Iterator (const StringToSortedVector *mat, bool end=false)
 
 Iterator (const Iterator &) noexcept=default
 
 Iterator (Iterator &&) noexcept=default
 
Iteratoroperator= (const Iterator &) noexcept=default
 
Iteratoroperator= (Iterator &&) noexcept=default
 
const Value & dereference () const
 
bool equal (const Iterator &other) const
 
void increment ()
 
void decrement ()
 

Friends

class boost::iterator_core_access
 

Constructor & Destructor Documentation

◆ Iterator() [1/3]

template<typename String , typename Value , typename Compare , typename Equal , template< typename... > class HashMap>
mpqc::StringToSortedVector< String, Value, Compare, Equal, HashMap >::Iterator::Iterator ( const StringToSortedVector mat,
bool  end = false 
)
inlineexplicit

creates an iterator

Parameters
endif true, will point to the end

◆ Iterator() [2/3]

template<typename String , typename Value , typename Compare , typename Equal , template< typename... > class HashMap>
mpqc::StringToSortedVector< String, Value, Compare, Equal, HashMap >::Iterator::Iterator ( const Iterator )
defaultnoexcept

◆ Iterator() [3/3]

template<typename String , typename Value , typename Compare , typename Equal , template< typename... > class HashMap>
mpqc::StringToSortedVector< String, Value, Compare, Equal, HashMap >::Iterator::Iterator ( Iterator &&  )
defaultnoexcept

Member Function Documentation

◆ decrement()

template<typename String , typename Value , typename Compare , typename Equal , template< typename... > class HashMap>
void mpqc::StringToSortedVector< String, Value, Compare, Equal, HashMap >::Iterator::decrement ( )
inline

◆ dereference()

template<typename String , typename Value , typename Compare , typename Equal , template< typename... > class HashMap>
const Value& mpqc::StringToSortedVector< String, Value, Compare, Equal, HashMap >::Iterator::dereference ( ) const
inline

◆ equal()

template<typename String , typename Value , typename Compare , typename Equal , template< typename... > class HashMap>
bool mpqc::StringToSortedVector< String, Value, Compare, Equal, HashMap >::Iterator::equal ( const Iterator other) const
inline

Comparison operator.

Parameters
[in]other
Returns
true if other and *this point to the same determinant in the same container

◆ increment()

template<typename String , typename Value , typename Compare , typename Equal , template< typename... > class HashMap>
void mpqc::StringToSortedVector< String, Value, Compare, Equal, HashMap >::Iterator::increment ( )
inline

◆ operator=() [1/2]

template<typename String , typename Value , typename Compare , typename Equal , template< typename... > class HashMap>
Iterator& mpqc::StringToSortedVector< String, Value, Compare, Equal, HashMap >::Iterator::operator= ( const Iterator )
defaultnoexcept

◆ operator=() [2/2]

template<typename String , typename Value , typename Compare , typename Equal , template< typename... > class HashMap>
Iterator& mpqc::StringToSortedVector< String, Value, Compare, Equal, HashMap >::Iterator::operator= ( Iterator &&  )
defaultnoexcept

Friends And Related Function Documentation

◆ boost::iterator_core_access

template<typename String , typename Value , typename Compare , typename Equal , template< typename... > class HashMap>
friend class boost::iterator_core_access
friend

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