Open
Graph Drawing
Framework

 v. 2022.02 (Dogwood)
 

ogdf::HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ > Class Template Reference

Const-iterator for 2D-hash arrays. More...

#include <ogdf/basic/HashIterator2D.h>

+ Inheritance diagram for ogdf::HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ >:

Public Member Functions

 HashConstIterator2D ()
 Creates an (invalid) iterator. More...
 
 HashConstIterator2D (const HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ > &it)
 Copy constructor. More...
 
 HashConstIterator2D (const HashConstIterator< Tuple2< I1_, I2_ >, E_, HashFuncTuple< I1_, I2_, Hash1_, Hash2_ > > &it)
 Copy constructor (from HashConstIterator). More...
 
const E_ & info () const
 Returns the information of the element pointed to. More...
 
const I1_ & key1 () const
 Returns the first key of the hash element pointed to. More...
 
const I2_ & key2 () const
 Returns the second key of the hash element pointed to. More...
 
HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ > & operator++ ()
 Sets the iterator to the next element in the 2D-hash array. More...
 
HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ > & operator= (const HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ > &it)
 Assignemnt operator. More...
 
bool valid () const
 Returns true iff the iterator points to an element. More...
 

Additional Inherited Members

- Private Member Functions inherited from ogdf::HashConstIterator< Tuple2< I1_, I2_ >, E_, HashFuncTuple< I1_, I2_, DefHashFunc< I1_ >, DefHashFunc< I2_ > > >
 HashConstIterator ()
 Creates a hash iterator pointing to no element. More...
 
 HashConstIterator (const HashConstIterator< Tuple2< I1_, I2_ >, E_, HashFuncTuple< I1_, I2_, DefHashFunc< I1_ >, DefHashFunc< I2_ > > > &it)
 Copy constructor. More...
 
 HashConstIterator (HashElement< Tuple2< I1_, I2_ >, E_ > *pElement, HashElement< Tuple2< I1_, I2_ >, E_ > **pList, const Hashing< Tuple2< I1_, I2_ >, E_, HashFuncTuple< I1_, I2_, DefHashFunc< I1_ >, DefHashFunc< I2_ > > > *pHashing)
 Creates a hash iterator pointing to element pElement in list pList of hash table pHashing. More...
 
const E_ & info () const
 Returns the information of the hash element pointed to. More...
 
const Tuple2< I1_, I2_ > & key () const
 Returns the key of the hash element pointed to. More...
 
HashConstIterator< Tuple2< I1_, I2_ >, E_, HashFuncTuple< I1_, I2_, DefHashFunc< I1_ >, DefHashFunc< I2_ > > > & operator++ ()
 Moves this hash iterator to the next element (iterator gets invalid if no more elements). More...
 
HashConstIteratoroperator= (const HashConstIterator< Tuple2< I1_, I2_ >, E_, HashFuncTuple< I1_, I2_, DefHashFunc< I1_ >, DefHashFunc< I2_ > > > &it)
 Assignment operator. More...
 
bool valid () const
 Returns true if the hash iterator points to an element. More...
 

Detailed Description

template<class I1_, class I2_, class E_, class Hash1_ = DefHashFunc<I1_>, class Hash2_ = DefHashFunc<I2_>>
class ogdf::HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ >

Const-iterator for 2D-hash arrays.

Definition at line 48 of file HashIterator2D.h.

Constructor & Destructor Documentation

◆ HashConstIterator2D() [1/3]

template<class I1_ , class I2_ , class E_ , class Hash1_ = DefHashFunc<I1_>, class Hash2_ = DefHashFunc<I2_>>
ogdf::HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ >::HashConstIterator2D ( )
inline

Creates an (invalid) iterator.

Definition at line 53 of file HashIterator2D.h.

◆ HashConstIterator2D() [2/3]

template<class I1_ , class I2_ , class E_ , class Hash1_ = DefHashFunc<I1_>, class Hash2_ = DefHashFunc<I2_>>
ogdf::HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ >::HashConstIterator2D ( const HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ > &  it)
inline

Copy constructor.

Definition at line 56 of file HashIterator2D.h.

◆ HashConstIterator2D() [3/3]

template<class I1_ , class I2_ , class E_ , class Hash1_ = DefHashFunc<I1_>, class Hash2_ = DefHashFunc<I2_>>
ogdf::HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ >::HashConstIterator2D ( const HashConstIterator< Tuple2< I1_, I2_ >, E_, HashFuncTuple< I1_, I2_, Hash1_, Hash2_ > > &  it)
inline

Copy constructor (from HashConstIterator).

Definition at line 60 of file HashIterator2D.h.

Member Function Documentation

◆ info()

template<class I1_ , class I2_ , class E_ , class Hash1_ = DefHashFunc<I1_>, class Hash2_ = DefHashFunc<I2_>>
const E_& ogdf::HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ >::info ( ) const
inline

Returns the information of the element pointed to.

Definition at line 87 of file HashIterator2D.h.

◆ key1()

template<class I1_ , class I2_ , class E_ , class Hash1_ = DefHashFunc<I1_>, class Hash2_ = DefHashFunc<I2_>>
const I1_& ogdf::HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ >::key1 ( ) const
inline

Returns the first key of the hash element pointed to.

Definition at line 77 of file HashIterator2D.h.

◆ key2()

template<class I1_ , class I2_ , class E_ , class Hash1_ = DefHashFunc<I1_>, class Hash2_ = DefHashFunc<I2_>>
const I2_& ogdf::HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ >::key2 ( ) const
inline

Returns the second key of the hash element pointed to.

Definition at line 82 of file HashIterator2D.h.

◆ operator++()

template<class I1_ , class I2_ , class E_ , class Hash1_ = DefHashFunc<I1_>, class Hash2_ = DefHashFunc<I2_>>
HashConstIterator2D<I1_,I2_,E_,Hash1_,Hash2_>& ogdf::HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ >::operator++ ( )
inline

Sets the iterator to the next element in the 2D-hash array.

Definition at line 92 of file HashIterator2D.h.

◆ operator=()

template<class I1_ , class I2_ , class E_ , class Hash1_ = DefHashFunc<I1_>, class Hash2_ = DefHashFunc<I2_>>
HashConstIterator2D<I1_,I2_,E_,Hash1_,Hash2_>& ogdf::HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ >::operator= ( const HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ > &  it)
inline

Assignemnt operator.

Definition at line 65 of file HashIterator2D.h.

◆ valid()

template<class I1_ , class I2_ , class E_ , class Hash1_ = DefHashFunc<I1_>, class Hash2_ = DefHashFunc<I2_>>
bool ogdf::HashConstIterator2D< I1_, I2_, E_, Hash1_, Hash2_ >::valid ( ) const
inline

Returns true iff the iterator points to an element.

Definition at line 72 of file HashIterator2D.h.


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