#include <LabelledMap.h>

Collaboration diagram for DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator:

Public Types
typedef BlockIterator	Self
typedef TData	Value
typedef Value *	Pointer
typedef Value &	Reference
typedef std::ptrdiff_t	DifferenceType
typedef Value	value_type
typedef std::size_t	size_type
typedef DifferenceType	difference_type
typedef Pointer	pointer
typedef Reference	reference
typedef std::forward_iterator_tag	iterator_category

Public Member Functions
	~BlockIterator ()
	BlockIterator ()
	BlockIterator (const BlockIterator &other)
Self &	operator= (const Self &other)
Reference	operator* () const
Pointer	operator-> () const
Self &	operator++ ()
Self	operator++ (int)
Self &	operator+= (DifferenceType n)
Reference	operator[] (DifferenceType n) const
bool	operator== (const Self &other) const
bool	operator!= (const Self &other) const

Protected Member Functions
	BlockIterator (__FirstBlock &block, unsigned int idx, unsigned int size)

Protected Attributes
unsigned int	myIdx
unsigned int	myNbDatas
Data *	myDatas
__AnyBlock *	myNext

Friends
class	LabelledMap

Detailed Description

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>
class DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator

Pseudo-random iterator to visit LabelledMap (it is only a random forward iterator). Model of boost::ForwardIterator. Provides also + and += arithmetic.

Definition at line 394 of file LabelledMap.h.

Member Typedef Documentation

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

typedef DifferenceType DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::difference_type

Definition at line 405 of file LabelledMap.h.

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

typedef std::ptrdiff_t DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::DifferenceType

Definition at line 400 of file LabelledMap.h.

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

typedef std::forward_iterator_tag DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::iterator_category

Definition at line 409 of file LabelledMap.h.

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

typedef Value* DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::Pointer

Definition at line 398 of file LabelledMap.h.

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

typedef Pointer DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::pointer

Definition at line 406 of file LabelledMap.h.

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

typedef Value& DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::Reference

Definition at line 399 of file LabelledMap.h.

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

typedef Reference DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::reference

Definition at line 407 of file LabelledMap.h.

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

typedef BlockIterator DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::Self

Definition at line 396 of file LabelledMap.h.

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

typedef std::size_t DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::size_type

Definition at line 404 of file LabelledMap.h.

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

typedef TData DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::Value

Definition at line 397 of file LabelledMap.h.

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

typedef Value DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::value_type

Definition at line 403 of file LabelledMap.h.

Constructor & Destructor Documentation

template<typename TData , unsigned int L, typename TWord , unsigned int N, unsigned int M>

DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::BlockIterator	(	__FirstBlock &	block,
		unsigned int	idx,
		unsigned int	size
	)

protected

Constructor from first block and index. Used by class LabelledMap.

Definition at line 64 of file LabelledMap.ih.

References DGtal::LabelledMap< TData, L, TWord, N, M >::__FirstBlock::data, DGtal::LabelledMap< TData, L, TWord, N, M >::__FirstBlock::datas, and DGtal::LabelledMap< TData, L, TWord, N, M >::DataOrBlockPointer::nextBlock.

{
  ASSERT( idx <= size );
  if ( size <= N+1 )
    {
      if ( idx <= N )
        {
          myIdx = idx;
          myNbDatas = N + 1;
          myDatas = block.datas;
          myNext = 0;
        }
      else
        { // end iterator.
          myIdx = 0;
          myNbDatas = 0;
          myDatas = 0;
          myNext = 0;
        }
    }
  else
    {
      ASSERT( block.data.nextBlock != 0 );
      myNext = block.data.nextBlock;
      if ( idx < N )
        {
          myIdx = idx;
          myNbDatas = N;
          myDatas = block.datas;
        }
      else
        {
          idx -= N;
          while ( idx >= M )
            {
              idx -= M;
              myNext = ( myNext != 0 ) ? myNext->next : 0;
            }
          if ( myNext == 0 )
            {
              myIdx = 0;
              myNbDatas = 0;
              myDatas = 0;
            }
          else
            {
              myIdx = idx;
              myNbDatas = M;
              myDatas = myNext->datas;
            }
        }
    }
}

template<typename TData , unsigned int L, typename TWord , unsigned int N, unsigned int M>

DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::~BlockIterator ( )

Default destructor.

Definition at line 46 of file LabelledMap.ih.

{}

template<typename TData , unsigned int L, typename TWord , unsigned int N, unsigned int M>

DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::BlockIterator ( )

Default constructor.

Definition at line 51 of file LabelledMap.ih.

: myIdx( 0 ), myDatas( 0 )

{}

template<typename TData , unsigned int L, typename TWord , unsigned int N, unsigned int M>

DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::BlockIterator ( const BlockIterator & other )

Copy constructor.

Parameters:

other the object to clone.

Definition at line 57 of file LabelledMap.ih.

  : myIdx( other.myIdx ), myNbDatas( other.myNbDatas ), 
    myDatas( other.myDatas ), myNext( other.myNext )
{}

Member Function Documentation

template<typename TData , unsigned int L, typename TWord , unsigned int N, unsigned int M>

bool DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator!= ( const Self & other ) const

inline

Inequality operator.

Parameters:

other any other iterator.

Returns:: 'true' iff the iterators points on different elements.

Definition at line 187 of file LabelledMap.ih.

References DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::myDatas, and DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::myIdx.

{
  return ( myDatas != other.myDatas ) || ( myIdx != other.myIdx );
}

template<typename TData , unsigned int L, typename TWord , unsigned int N, unsigned int M>

DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::Reference DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator* ( ) const

inline

Dereference operator.

Returns:: the current data of the iterator, if valid.

Definition at line 138 of file LabelledMap.ih.

{
  ASSERT( myDatas != 0 );
  return myDatas[ myIdx ];
}

template<typename TData , unsigned int L, typename TWord , unsigned int N, unsigned int M>

DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::Self & DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator++ ( )

inline

Pre-increment operator.

Returns:: a reference to itself.

Definition at line 158 of file LabelledMap.ih.

{
  return this->operator+=( 1 );
}

template<typename TData , unsigned int L, typename TWord , unsigned int N, unsigned int M>

DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::Self DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator++ ( int )

inline

Post-increment operator.

Returns:: a reference to itself.

Definition at line 167 of file LabelledMap.ih.

{
  Self tmp( *this );
  this->operator++();
  return tmp;
}

template<typename TData , unsigned int L, typename TWord , unsigned int N, unsigned int M>

DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::Self & DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator+= ( DifferenceType n )

inline

Addition operator. Moves the iterator at position + n.

Parameters:

n	any positive integer

Returns:: a reference to itself.

Definition at line 196 of file LabelledMap.ih.

{
  myIdx += n;
  while ( myIdx >= myNbDatas )
    {
      if ( myNext == 0 )
        {
          myDatas = 0;
          myIdx = 0;
          break;
        }
      myIdx -= myNbDatas;
      myDatas = myNext->datas;
      myNbDatas = M;
      myNext = myNext->next;
    }
  return *this;  
}

template<typename TData , unsigned int L, typename TWord , unsigned int N, unsigned int M>

DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::Pointer DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator-> ( ) const

inline

Pointer dereference operator.

Returns:: a non-mutable pointer on the current data.

Definition at line 148 of file LabelledMap.ih.

{
  ASSERT( myDatas != 0 );
  return myDatas + myIdx;
}

template<typename TData , unsigned int L, typename TWord , unsigned int N, unsigned int M>

DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::Self & DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator= ( const Self & other )

inline

Assignment.

Parameters:

other the object to copy.

Returns:: a reference on 'this'.

Definition at line 122 of file LabelledMap.ih.

References DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::myDatas, DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::myIdx, DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::myNbDatas, and DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::myNext.

{
  if ( this != &other )
    {
      myIdx = other.myIdx; 
      myNbDatas = other.myNbDatas; 
      myDatas = other.myDatas;
      myNext = other.myNext;
    }
  return *this;
}

template<typename TData , unsigned int L, typename TWord , unsigned int N, unsigned int M>

bool DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator== ( const Self & other ) const

inline

Equality operator.

Parameters:

other any other iterator.

Returns:: 'true' iff the iterators points on the same element.

Definition at line 178 of file LabelledMap.ih.

References DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::myDatas, and DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::myIdx.

{
  return ( myDatas == other.myDatas ) && ( myIdx == other.myIdx );
}

template<typename TData , unsigned int L, typename TWord , unsigned int N, unsigned int M>

DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::Reference DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator[] ( DifferenceType n ) const

inline

Positive offset dereference operator. Moves the iterator at position + n.

Parameters:

n	any positive integer

Returns:: a reference to itself.

Definition at line 219 of file LabelledMap.ih.

{
  Self tmp( *this );
  tmp += n;
  return *tmp;
}

Friends And Related Function Documentation

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

friend class LabelledMap

friend

Definition at line 418 of file LabelledMap.h.

Field Documentation

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

Data* DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::myDatas

protected

Definition at line 415 of file LabelledMap.h.

Referenced by DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator!=(), DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator=(), and DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator==().

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

unsigned int DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::myIdx

protected

Definition at line 413 of file LabelledMap.h.

Referenced by DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator!=(), DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator=(), and DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator==().

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

unsigned int DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::myNbDatas

protected

Definition at line 414 of file LabelledMap.h.

Referenced by DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator=().

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>

__AnyBlock* DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::myNext

protected

Definition at line 416 of file LabelledMap.h.

Referenced by DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator::operator=().

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M> class DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Field Documentation

template<typename TData, unsigned int L, typename TWord, unsigned int N, unsigned int M>
class DGtal::LabelledMap< TData, L, TWord, N, M >::BlockIterator