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 Types
using	iterator_category = std::bidirectional_iterator_tag
	Declares this to be a bidirectional iterator type. More...
using	value_type = Vector< LargeInteger >
	Indicates what type the iterator points to. More...
using	difference_type = typename std::vector< NormalSurface >::const_iterator::difference_type
	The type obtained by subtracting iterators. More...
using	pointer = const Vector< LargeInteger > *
	A pointer to value_type. More...
using	reference = const Vector< LargeInteger > &
	The type obtained when dereferencing iterators. More...

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

Friends
class	NormalSurfaces

Detailed Description

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

Python

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

Member Typedef Documentation

difference_type

using regina::NormalSurfaces::VectorIterator::difference_type = typename std::vector<NormalSurface>::const_iterator::difference_type

The type obtained by subtracting iterators.

iterator_category

using regina::NormalSurfaces::VectorIterator::iterator_category = std::bidirectional_iterator_tag

Declares this to be a bidirectional iterator type.

pointer

using regina::NormalSurfaces::VectorIterator::pointer = const Vector<LargeInteger>*

A pointer to value_type.

reference

using regina::NormalSurfaces::VectorIterator::reference = const Vector<LargeInteger>&

The type obtained when dereferencing iterators.

value_type

using regina::NormalSurfaces::VectorIterator::value_type = Vector<LargeInteger>

Indicates what type the iterator points to.

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