regina::NormalSurfaces::VectorIterator Class Reference

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

#include <surface/normalsurfaces.h>

Public Member Functions
	VectorIterator ()=default
	Creates a new uninitialised iterator.
	VectorIterator (const VectorIterator &)=default
	Creates a copy of the given iterator.
VectorIterator &	operator= (const VectorIterator &)=default
	Makes this a copy of the given iterator.
bool	operator== (const VectorIterator &other) const
	Compares this with the given iterator for equality.
bool	operator!= (const VectorIterator &other) const
	Compares this with the given iterator for inequality.
const Vector< LargeInteger > &	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	NormalSurfaces

Detailed Description

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

As of Regina 7.3.1, this class no longer provides the iterator type aliases value_type, iterator_category, difference_type, pointer and reference. Instead you can access these through std::iterator_traits.

Python

Not present. Instead NormalSurfaces::vectors() returns an object of a different (hidden) class that supports the Python iterable/iterator interface.

Constructor & Destructor Documentation

VectorIterator() [1/2]

regina::NormalSurfaces::VectorIterator::VectorIterator ( )

default

Creates a new uninitialised iterator.

VectorIterator() [2/2]

regina::NormalSurfaces::VectorIterator::VectorIterator ( const VectorIterator & )

default

Creates a copy of the given iterator.

Member Function Documentation

operator!=()

bool regina::NormalSurfaces::VectorIterator::operator!= ( const VectorIterator & other ) const

inline

Compares this with the given iterator 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.

operator*()

const Vector< LargeInteger > & regina::NormalSurfaces::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.

operator++() [1/2]

NormalSurfaces::VectorIterator & regina::NormalSurfaces::VectorIterator::operator++ ( )

inline

The preincrement operator.

Returns

a reference to this iterator after the increment.

operator++() [2/2]

NormalSurfaces::VectorIterator regina::NormalSurfaces::VectorIterator::operator++ ( int )

inline

The postincrement operator.

Returns

a copy of this iterator before the increment took place.

operator--() [1/2]

NormalSurfaces::VectorIterator & regina::NormalSurfaces::VectorIterator::operator-- ( )

inline

The predecrement operator.

Returns

a reference to this iterator after the decrement.

operator--() [2/2]

NormalSurfaces::VectorIterator regina::NormalSurfaces::VectorIterator::operator-- ( int )

inline

The postdecrement operator.

Returns

a copy of this iterator before the decrement took place.

operator=()

VectorIterator & regina::NormalSurfaces::VectorIterator::operator= ( const VectorIterator & )

default

Makes this a copy of the given iterator.

Returns

a reference to this iterator.

operator==()

bool regina::NormalSurfaces::VectorIterator::operator== ( const VectorIterator & other ) const

inline

Compares this with the given iterator 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:

• surface/normalsurfaces.h