Bial::AdjacencyIterator Class Reference

Adjacency iterator. More...

#include <AdjacencyIterator.hpp>

Collaboration diagram for Bial::AdjacencyIterator:

Public Member Functions
	AdjacencyIterator (const Adjacency &adj, const Vector< size_t > &dim, size_t index)
	Basic Constructor. More...
template<class D >
	AdjacencyIterator (const Adjacency &adj, const Matrix< D > &mat, size_t index)
	Basic Constructor. More...
template<class D >
	AdjacencyIterator (const Adjacency &adj, const Image< D > &mat, size_t index)
	Basic Constructor. More...
void	begin ()
	Sets position to first valid index. More...
void	end ()
	Sets position to adjacency.size( ). More...
AdjacencyIterator &	operator++ ()
	Sets position to the next valid element or to space size if finished. More...
AdjacencyIterator	operator++ (int)
	Sets position to the next valid element or to space size if finished. More...
bool	operator== (const AdjacencyIterator &cmp) const
	Checks if this position is the same as cmp position. More...
bool	operator!= (const AdjacencyIterator &cmp) const
	Checks if this position is different of cmp position. More...
size_t	operator* () const
	Returns a ponter to the next valid element. More...
size_t	Position () const
	Returns the position of current adjacent element. More...

Friends
class	Adjacency

Detailed Description

Adjacency iterator.

Definition at line 29 of file AdjacencyIterator.hpp.

Constructor & Destructor Documentation

Bial::AdjacencyIterator::AdjacencyIterator	(	const Adjacency &	adj,
		const Vector< size_t > &	dim,
		size_t	index
	)

Basic Constructor.

Date

2012/Sep/24

Parameters

adj	An adjacency relation.
dim	Matrix dimensions.
index	Index of reference pixel in the adjacency relation.

Returns

none.

Warning

none.

template<class D >

Bial::AdjacencyIterator::AdjacencyIterator	(	const Adjacency &	adj,
		const Matrix< D > &	mat,
		size_t	index
	)

Basic Constructor.

Date

2012/Sep/24

Parameters

adj	An adjacency relation.
mat	A matrix.
index	Index of reference pixel in the adjacency relation.

Returns

none.

Warning

none.

template<class D >

Bial::AdjacencyIterator::AdjacencyIterator	(	const Adjacency &	adj,
		const Image< D > &	mat,
		size_t	index
	)

Basic Constructor.

Date

2014/Apr/14

Parameters

adj	An adjacency relation.
img	An image.
index	Index of reference pixel in the adjacency relation.

Returns

none.

Warning

none.

Member Function Documentation

void Bial::AdjacencyIterator::begin

(

)

Sets position to first valid index.

Date

2012/Sep/24

Parameters

none

Returns

none.

Warning

none.

void Bial::AdjacencyIterator::end

(

)

Sets position to adjacency.size( ).

Date

2012/Sep/24

Parameters

none

Returns

none.

Warning

none.

bool Bial::AdjacencyIterator::operator!=

(

const AdjacencyIterator &

cmp

)

const

Checks if this position is different of cmp position.

Date

2012/Sep/24

Parameters

cmp	iterator to which this iterator is compared.

Returns

True, if this position is different of cmp position.

Warning

none.

size_t Bial::AdjacencyIterator::operator*

(

)

const

Returns a ponter to the next valid element.

Date

2012/Sep/24

Parameters

none.

Returns

Ponter to the next valid element.

Warning

none.

AdjacencyIterator& Bial::AdjacencyIterator::operator++

(

)

Sets position to the next valid element or to space size if finished.

Date

2013/Oct/23

Parameters

none.

Returns

Reference to this.

Warning

none.

AdjacencyIterator Bial::AdjacencyIterator::operator++

(

int

)

Sets position to the next valid element or to space size if finished.

Date

2013/Oct/23

Parameters

none.

Returns

Copy to this, moved to next valid element.

Warning

none.

bool Bial::AdjacencyIterator::operator==

(

const AdjacencyIterator &

cmp

)

const

Checks if this position is the same as cmp position.

Date

2012/Sep/24

Parameters

cmp	iterator to which this iterator is compared.

Returns

True, if this position is the same as cmp position.

Warning

none.

size_t Bial::AdjacencyIterator::Position

(

)

const

Returns the position of current adjacent element.

Date

2015/Jun/10

Parameters

none.

Returns

The position of current adjacent element.

Warning

none.

Friends And Related Function Documentation

friend class Adjacency

friend

Definition at line 153 of file AdjacencyIterator.hpp.

---

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

• bial/inc/AdjacencyIterator.hpp