Border: iterator. More...

#include <aims/border/borderiterator.h>

Inheritance diagram for aims::BorderIterator< T >::iterator:

Collaboration diagram for aims::BorderIterator< T >::iterator:

[legend]

Public Member Functions
	iterator ()
	Default constructor Create a non initialized iterator than cannot be incremented or accessed. More...

	iterator (const iterator &other)
	Copy constructor from an iterator. More...

iterator &	operator= (const iterator &other)
	assignment from iterator More...

iterator &	operator++ ()
	increment (prefix) More...

iterator	operator++ (int)

T &	operator* ()

T *	operator-> ()

Public Member Functions inherited from aims::BorderIterator< T >::const_iterator
	const_iterator ()
	Default constructor Create a non initialized iterator than cannot be incremented or accessed. More...

	const_iterator (const const_iterator &other)
	Copy constructor from a const_iterator. More...

	const_iterator (const iterator &other)
	Copy constructor from an iterator. More...

const_iterator &	operator= (const const_iterator &other)
	assignment from const_iterator More...

const_iterator &	operator= (const iterator &other)
	assignment from iterator More...

const_iterator &	operator++ ()
	increment (prefix) More...

const_iterator	operator++ (int)
	increment (suffix) More...

const T &	operator* () const

const T *	operator-> () const

bool	operator== (const const_iterator &other) const

bool	operator== (const iterator &other) const

bool	operator!= (const const_iterator &other) const

bool	operator!= (const iterator &other) const

Point4dl	coordinate () const
	Returns the coordinates of the current point in the linked volume. More...

carto::VolumeRef< T >	volume ()
	Returns a reference to the linked volume. More...

Protected Member Functions
	iterator (BorderIterator< T > &b, bool end=false)
	Utility constructor: returns the iterator at position begin() if `end` is false, and end() if `end` is false. More...

	iterator (BorderIterator< T > &b, const Point4dl &current)
	Utility constructor: returns the iterator at position `current`. More...

Protected Member Functions inherited from aims::BorderIterator< T >::const_iterator
	const_iterator (BorderIterator< T > &b, bool end=false)
	Utility constructor: returns the iterator at position begin() if `end` is false, and end() if `end` is false. More...

	const_iterator (BorderIterator< T > &b, const Point4dl &current)
	Utility constructor: returns the iterator at position `current`. More...

bool	isBorder (const Point4dl &p) const
	returns true if the `p` is in the border described by _border More...

bool	isNonBorderImage (const Point4dl &p) const
	returns true if `p` is in the image but not in the border. More...

Point4dl	reset (const Point4dl &p, const Point4dl &move) const
	Sets the coordinate (in the dimension described by `move`) at its most inferior (i.e. More...

Point4dl	nextMove (const Point4dl &move) const
	Computes the next move. More...

Point4dl	computeNext (const Point4dl &p) const
	computeNext(p) returns the next point in the border. More...

Point4dl	end () const
	Point value for the "end" iterator (which points to no voxel). More...

long	jumpX () const
	Gives the size of the non-border volume in the X dimension. More...

Friends
class	BorderIterator< T >

Additional Inherited Members
Protected Attributes inherited from aims::BorderIterator< T >::const_iterator
BorderIterator< T >	_border

Point4dl	_current

Detailed Description

template<typename T>
class aims::BorderIterator< T >::iterator

Border: iterator.

Definition at line 206 of file borderiterator.h.

Constructor & Destructor Documentation

◆ iterator() [1/4]

template<typename T >

aims::BorderIterator< T >::iterator::iterator

Default constructor Create a non initialized iterator than cannot be incremented or accessed.

Definition at line 537 of file borderiterator.h.

◆ iterator() [2/4]

template<typename T >

aims::BorderIterator< T >::iterator::iterator ( const iterator & other )

Copy constructor from an iterator.

◆ iterator() [3/4]

template<typename T >

aims::BorderIterator< T >::iterator::iterator	(	BorderIterator< T > &	b,
		bool	end = `false`
	)

protected

Utility constructor: returns the iterator at position begin() if end is false, and end() if end is false.

Definition at line 542 of file borderiterator.h.

◆ iterator() [4/4]

template<typename T >

aims::BorderIterator< T >::iterator::iterator	(	BorderIterator< T > &	b,
		const Point4dl &	current
	)

protected

Utility constructor: returns the iterator at position current.

Definition at line 547 of file borderiterator.h.

Member Function Documentation

◆ operator*()

template<typename T >

T & aims::BorderIterator< T >::iterator::operator*

Definition at line 566 of file borderiterator.h.

References aims::BorderIterator< T >::const_iterator::_border, and aims::BorderIterator< T >::const_iterator::_current.

◆ operator++() [1/2]

template<typename T >

BorderIterator< T >::iterator & aims::BorderIterator< T >::iterator::operator++

increment (prefix)

Definition at line 586 of file borderiterator.h.

References aims::BorderIterator< T >::const_iterator::_current, and aims::BorderIterator< T >::const_iterator::computeNext().

◆ operator++() [2/2]

template<typename T >

BorderIterator< T >::iterator aims::BorderIterator< T >::iterator::operator++ ( int )

Definition at line 594 of file borderiterator.h.

References aims::BorderIterator< T >::const_iterator::_current, and aims::BorderIterator< T >::const_iterator::computeNext().

◆ operator->()

template<typename T >

T * aims::BorderIterator< T >::iterator::operator->

Definition at line 576 of file borderiterator.h.

References aims::BorderIterator< T >::const_iterator::_border, and aims::BorderIterator< T >::const_iterator::_current.

◆ operator=()

template<typename T >

BorderIterator< T >::iterator & aims::BorderIterator< T >::iterator::operator= ( const iterator & other )

assignment from iterator

Definition at line 558 of file borderiterator.h.

References aims::BorderIterator< T >::const_iterator::operator=().

Friends And Related Function Documentation

◆ BorderIterator< T >

template<typename T >

friend class BorderIterator< T >

friend

Definition at line 231 of file borderiterator.h.

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

aims/border/borderiterator.h

Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

template<typename T> class aims::BorderIterator< T >::iterator

Constructor & Destructor Documentation

◆ iterator() [1/4]

◆ iterator() [2/4]

◆ iterator() [3/4]

◆ iterator() [4/4]

Member Function Documentation

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator->()

◆ operator=()

Friends And Related Function Documentation

◆ BorderIterator< T >

template<typename T>
class aims::BorderIterator< T >::iterator