regina::NNormalSurfaceList::VectorIterator Class Reference

A bidirectional iterator that runs through the raw vectors for surfaces in this list. More...

#include <surfaces/nnormalsurfacelist.h>

List of all members.

Public Member Functions
	VectorIterator ()
	Creates a new uninitialised iterator.
	VectorIterator (const VectorIterator &cloneMe)
	Creates a copy of the given iterator.
VectorIterator &	operator= (const VectorIterator &cloneMe)
	Makes this a copy of the given iterator.
bool	operator== (const VectorIterator &other) const
	Compares this with the given operator for equality.
bool	operator!= (const VectorIterator &other) const
	Compares this with the given operator for inequality.
const NNormalSurfaceVector *	operator* () const
	Returns the raw vector for the normal surface that this iterator is currently pointing to.
VectorIterator &	operator++ ()
	The preincrement operator.
VectorIterator	operator++ (int)
	The postincrement operator.
VectorIterator &	operator-- ()
	The predecrement operator.
VectorIterator	operator-- (int)
	The postdecrement operator.
Friends
class	NNormalSurfaceList

---

Detailed Description

A bidirectional iterator that runs through the raw vectors for surfaces in this list.

Python:

Not present.

---

Constructor & Destructor Documentation

regina::NNormalSurfaceList::VectorIterator::VectorIterator

(

)

[inline]

Creates a new uninitialised iterator.

regina::NNormalSurfaceList::VectorIterator::VectorIterator

(

const VectorIterator &

cloneMe

)

[inline]

Creates a copy of the given iterator.

Parameters:

cloneMe

the iterator to clone.

---

Member Function Documentation

bool regina::NNormalSurfaceList::VectorIterator::operator!=

(

const VectorIterator &

other

)

const [inline]

Compares this with the given operator for inequality.

Parameters:

other

the iterator to compare this with.

Returns:

false if the iterators point to the same element of the same normal surface list, or true if they do not.

const NNormalSurfaceVector * regina::NNormalSurfaceList::VectorIterator::operator*

(

)

const [inline]

Returns the raw vector for the normal surface that this iterator is currently pointing to.

Precondition:

This iterator is dereferenceable (in particular, it is not past-the-end).

Returns:

the corresponding normal surface vector.

NNormalSurfaceList::VectorIterator & regina::NNormalSurfaceList::VectorIterator::operator++

(

)

[inline]

The preincrement operator.

Returns:

a reference to this iterator after the increment.

NNormalSurfaceList::VectorIterator regina::NNormalSurfaceList::VectorIterator::operator++

(

int

)

[inline]

The postincrement operator.

Returns:

a copy of this iterator before the increment took place.

NNormalSurfaceList::VectorIterator & regina::NNormalSurfaceList::VectorIterator::operator--

(

)

[inline]

The predecrement operator.

Returns:

a reference to this iterator after the decrement.

NNormalSurfaceList::VectorIterator regina::NNormalSurfaceList::VectorIterator::operator--

(

int

)

[inline]

The postdecrement operator.

Returns:

a copy of this iterator before the decrement took place.

NNormalSurfaceList::VectorIterator & regina::NNormalSurfaceList::VectorIterator::operator=

(

const VectorIterator &

cloneMe

)

[inline]

Makes this a copy of the given iterator.

Parameters:

cloneMe

the iterator to clone.

Returns:

a reference to this iterator.

bool regina::NNormalSurfaceList::VectorIterator::operator==

(

const VectorIterator &

other

)

const [inline]

Compares this with the given operator for equality.

Parameters:

other

the iterator to compare this with.

Returns:

true if the iterators point to the same element of the same normal surface list, or false if they do not.

---

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

• surfaces/nnormalsurfacelist.h