DGtal  1.5.beta
Public Member Functions | Protected Attributes
DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator Class Reference

Built-in iterator on an HashTree. This iterator visits all node in the tree. More...

#include <DGtal/images/ImageContainerByHashTree.h>

Public Member Functions

 Iterator (Node **data, unsigned int position, unsigned int arraySize)
 
bool isAtEnd () const
 
Value & operator* ()
 
bool operator++ ()
 
bool operator== (const Iterator &it)
 
bool operator!= (const Iterator &it)
 
HashKey getKey () const
 
bool next ()
 

Protected Attributes

Node * myNode
 
unsigned int myCurrentCell
 
unsigned int myArraySize
 
Node ** myContainerData
 

Detailed Description

template<typename TDomain, typename TValue, typename THashKey = typename DGtal::uint64_t>
class DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator

Built-in iterator on an HashTree. This iterator visits all node in the tree.

Iterator inner-class

Definition at line 516 of file ImageContainerByHashTree.h.

Constructor & Destructor Documentation

◆ Iterator()

template<typename TDomain , typename TValue , typename THashKey = typename DGtal::uint64_t>
DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::Iterator ( Node **  data,
unsigned int  position,
unsigned int  arraySize 
)
inline

Definition at line 519 of file ImageContainerByHashTree.h.

520  {
521  myArraySize = arraySize;
522  myContainerData = data;
523  myNode = data[0];
524  myCurrentCell = position;
525  while ((!myNode) && (myCurrentCell < myArraySize))
526  {
527  myNode = myContainerData[++myCurrentCell];
528  }
529  }

References DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::data(), DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::myArraySize, DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::myContainerData, DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::myCurrentCell, and DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::myNode.

Member Function Documentation

◆ getKey()

template<typename TDomain , typename TValue , typename THashKey = typename DGtal::uint64_t>
HashKey DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::getKey ( ) const
inline

Definition at line 556 of file ImageContainerByHashTree.h.

557  {
558  return myNode->getKey();
559  }

References DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Node::getKey(), and DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::myNode.

◆ isAtEnd()

template<typename TDomain , typename TValue , typename THashKey = typename DGtal::uint64_t>
bool DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::isAtEnd ( ) const
inline

Definition at line 530 of file ImageContainerByHashTree.h.

531  {
532  return myCurrentCell >= myArraySize;
533  }

References DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::myArraySize, and DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::myCurrentCell.

Referenced by DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::operator!=(), and DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::operator==().

◆ next()

template<typename TDomain , typename TValue , typename THashKey = typename DGtal::uint64_t>
bool DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::next ( )

Referenced by DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::operator++().

◆ operator!=()

template<typename TDomain , typename TValue , typename THashKey = typename DGtal::uint64_t>
bool DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::operator!= ( const Iterator &  it)
inline

Definition at line 549 of file ImageContainerByHashTree.h.

550  {
551  if (isAtEnd() && it.isAtEnd())
552  return false;
553  else
554  return (myNode != it.myNode);
555  }

References DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::isAtEnd(), and DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::myNode.

◆ operator*()

template<typename TDomain , typename TValue , typename THashKey = typename DGtal::uint64_t>
Value& DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::operator* ( )
inline

Definition at line 534 of file ImageContainerByHashTree.h.

535  {
536  return myNode->getObject();
537  }

References DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Node::getObject(), and DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::myNode.

◆ operator++()

template<typename TDomain , typename TValue , typename THashKey = typename DGtal::uint64_t>
bool DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::operator++ ( )
inline

Definition at line 538 of file ImageContainerByHashTree.h.

539  {
540  return next();
541  }

References DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::next().

◆ operator==()

template<typename TDomain , typename TValue , typename THashKey = typename DGtal::uint64_t>
bool DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::operator== ( const Iterator &  it)
inline

Definition at line 542 of file ImageContainerByHashTree.h.

543  {
544  if (isAtEnd() && it.isAtEnd())
545  return true;
546  else
547  return (myNode == it.myNode);
548  }

References DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::isAtEnd(), and DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::myNode.

Field Documentation

◆ myArraySize

template<typename TDomain , typename TValue , typename THashKey = typename DGtal::uint64_t>
unsigned int DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::myArraySize
protected

Definition at line 564 of file ImageContainerByHashTree.h.

Referenced by DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::isAtEnd(), and DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::Iterator().

◆ myContainerData

template<typename TDomain , typename TValue , typename THashKey = typename DGtal::uint64_t>
Node** DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::myContainerData
protected

Definition at line 565 of file ImageContainerByHashTree.h.

Referenced by DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::Iterator().

◆ myCurrentCell

template<typename TDomain , typename TValue , typename THashKey = typename DGtal::uint64_t>
unsigned int DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::myCurrentCell
protected

Definition at line 563 of file ImageContainerByHashTree.h.

Referenced by DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::isAtEnd(), and DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::Iterator().

◆ myNode

template<typename TDomain , typename TValue , typename THashKey = typename DGtal::uint64_t>
Node* DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::myNode
protected

Definition at line 562 of file ImageContainerByHashTree.h.

Referenced by DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::getKey(), DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::Iterator(), DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::operator!=(), DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::operator*(), and DGtal::experimental::ImageContainerByHashTree< TDomain, TValue, THashKey >::Iterator::operator==().

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