#include <DGtal/base/LabelledMap.h>

Public Types
typedef BlockConstIterator	Self

typedef TData	Value

typedef const Value *	Pointer

typedef const Value &	Reference

typedef std::ptrdiff_t	DifferenceType
	only positive offsets allowed.

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
	~BlockConstIterator ()

	BlockConstIterator ()

	BlockConstIterator (const BlockConstIterator &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
	BlockConstIterator (const __FirstBlock &block, unsigned int idx, unsigned int size)

Protected Attributes
unsigned int	myIdx
	current index in myDatas of the iterator

unsigned int	myNbDatas
	number of valid datas in array myDatas

const Data *	myDatas
	array of myNbDatas datas.

const __AnyBlock *	myNext
	pointer to next block or 0 if last block.

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 >::BlockConstIterator

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

Definition at line 511 of file LabelledMap.h.

Member Typedef Documentation

◆ difference_type

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

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

Definition at line 522 of file LabelledMap.h.

◆ DifferenceType

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

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

only positive offsets allowed.

Definition at line 517 of file LabelledMap.h.

◆ iterator_category

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

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

Definition at line 526 of file LabelledMap.h.

◆ Pointer

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

const Value* DGtal::LabelledMap< TData, L, TWord, N, M >::BlockConstIterator::Pointer

Definition at line 515 of file LabelledMap.h.

◆ pointer

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

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

Definition at line 523 of file LabelledMap.h.

◆ Reference

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

const Value& DGtal::LabelledMap< TData, L, TWord, N, M >::BlockConstIterator::Reference

Definition at line 516 of file LabelledMap.h.

◆ reference

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

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

Definition at line 524 of file LabelledMap.h.

◆ Self

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

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

Definition at line 513 of file LabelledMap.h.

◆ size_type

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

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

Definition at line 521 of file LabelledMap.h.

◆ Value

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

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

Definition at line 514 of file LabelledMap.h.

◆ value_type

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

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

Definition at line 520 of file LabelledMap.h.

Constructor & Destructor Documentation

◆ BlockConstIterator() [1/3]

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

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

protected

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

◆ ~BlockConstIterator()

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

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

Default destructor.

◆ BlockConstIterator() [2/3]

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

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

Default constructor.

◆ BlockConstIterator() [3/3]

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

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

Copy constructor.

Parameters

other the object to clone.

Member Function Documentation

◆ operator!=()

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

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

Inequality operator.

Parameters

other any other iterator.

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

◆ operator*()

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

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

Dereference operator.

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

◆ operator++() [1/2]

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

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

Pre-increment operator.

Returns: a reference to itself.

◆ operator++() [2/2]

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

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

Post-increment operator.

Returns: a reference to itself.

◆ operator+=()

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

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

Addition operator. Moves the iterator at position + n.

Parameters

n	any positive integer

Returns: a reference to itself.

◆ operator->()

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

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

Pointer dereference operator.

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

◆ operator=()

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

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

Assignment.

Parameters

other the object to copy.

Returns: a reference on 'this'.

◆ operator==()

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

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

Equality operator.

Parameters

other any other iterator.

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

◆ operator[]()

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

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

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

Parameters

n	any positive integer

Returns: a reference to itself.

Friends And Related Symbol Documentation

◆ LabelledMap

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

friend class LabelledMap

friend

Definition at line 535 of file LabelledMap.h.

Field Documentation

◆ myDatas

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

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

protected

array of myNbDatas datas.

Definition at line 532 of file LabelledMap.h.

◆ myIdx

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

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

protected

current index in myDatas of the iterator

Definition at line 530 of file LabelledMap.h.

◆ myNbDatas

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

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

protected

number of valid datas in array myDatas

Definition at line 531 of file LabelledMap.h.

◆ myNext

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

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

protected

pointer to next block or 0 if last block.

Definition at line 533 of file LabelledMap.h.

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

LabelledMap.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ difference_type

◆ DifferenceType

◆ iterator_category

◆ Pointer

◆ pointer

◆ Reference

◆ reference

◆ Self

◆ size_type

◆ Value

◆ value_type

Constructor & Destructor Documentation

◆ BlockConstIterator() [1/3]

◆ ~BlockConstIterator()

◆ BlockConstIterator() [2/3]

◆ BlockConstIterator() [3/3]

Member Function Documentation

◆ operator!=()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator+=()

◆ operator->()

◆ operator=()

◆ operator==()

◆ operator[]()

Friends And Related Symbol Documentation

◆ LabelledMap

Field Documentation

◆ myDatas

◆ myIdx

◆ myNbDatas

◆ myNext