Regina Calculation Engine
Public Member Functions | Public Attributes | List of all members
regina::NormalHypersurfaces::HypersurfaceInserter Struct Reference

An output iterator used to insert hypersurfaces into an NormalHypersurfaces. More...

#include <hypersurface/normalhypersurfaces.h>

Inheritance diagram for regina::NormalHypersurfaces::HypersurfaceInserter:

Public Member Functions

 HypersurfaceInserter (NormalHypersurfaces &list, Triangulation< 4 > *owner)
 Creates a new output iterator. More...
 
 HypersurfaceInserter (const HypersurfaceInserter &cloneMe)=default
 Creates a new output iterator that is a clone of the given iterator. More...
 
HypersurfaceInserteroperator= (const HypersurfaceInserter &cloneMe)=default
 Sets this iterator to be a clone of the given output iterator. More...
 
HypersurfaceInserteroperator= (NormalHypersurface *hypersurface)
 Appends a normal hypersurface to the end of the appropriate surface list. More...
 
HypersurfaceInserteroperator= (NormalHypersurfaceVector *vector)
 Appends the normal hypersurface corresponding to the given vector to the end of the appropriate hypersurface list. More...
 
HypersurfaceInserteroperator* ()
 Returns a reference to this output iterator. More...
 
HypersurfaceInserteroperator++ ()
 Returns a reference to this output iterator. More...
 
HypersurfaceInserteroperator++ (int)
 Returns a reference to this output iterator. More...
 

Public Attributes

NormalHypersurfaceslist_
 The list into which hypersurfaces will be inserted. More...
 
Triangulation< 4 > * owner_
 The triangulation in which the hypersurfaces to be inserted are contained. More...
 

Detailed Description

An output iterator used to insert hypersurfaces into an NormalHypersurfaces.

Objects of type NormalHypersurface* and NormalHypersurfaceVector* can be assigned to this iterator. In the latter case, a surrounding NormalHypersurface will be automatically created.

Constructor & Destructor Documentation

◆ HypersurfaceInserter() [1/2]

regina::NormalHypersurfaces::HypersurfaceInserter::HypersurfaceInserter ( NormalHypersurfaces list,
Triangulation< 4 > *  owner 
)
inline

Creates a new output iterator.

The member variables of this iterator will be initialised according to the parameters passed to this constructor.

Parameters
listthe list into which hypersurfaces will be inserted.
ownerthe triangulation in which the hypersurfaces to be inserted are contained.

◆ HypersurfaceInserter() [2/2]

regina::NormalHypersurfaces::HypersurfaceInserter::HypersurfaceInserter ( const HypersurfaceInserter cloneMe)
default

Creates a new output iterator that is a clone of the given iterator.

Parameters
cloneMethe output iterator to clone.

Member Function Documentation

◆ operator*()

NormalHypersurfaces::HypersurfaceInserter & regina::NormalHypersurfaces::HypersurfaceInserter::operator* ( )
inline

Returns a reference to this output iterator.

Returns
this output iterator.

◆ operator++() [1/2]

NormalHypersurfaces::HypersurfaceInserter & regina::NormalHypersurfaces::HypersurfaceInserter::operator++ ( )
inline

Returns a reference to this output iterator.

Returns
this output iterator.

◆ operator++() [2/2]

NormalHypersurfaces::HypersurfaceInserter & regina::NormalHypersurfaces::HypersurfaceInserter::operator++ ( int  )
inline

Returns a reference to this output iterator.

Returns
this output iterator.

◆ operator=() [1/3]

HypersurfaceInserter& regina::NormalHypersurfaces::HypersurfaceInserter::operator= ( const HypersurfaceInserter cloneMe)
default

Sets this iterator to be a clone of the given output iterator.

Parameters
cloneMethe output iterator to clone.
Returns
this output iterator.

◆ operator=() [2/3]

NormalHypersurfaces::HypersurfaceInserter & regina::NormalHypersurfaces::HypersurfaceInserter::operator= ( NormalHypersurface hypersurface)
inline

Appends a normal hypersurface to the end of the appropriate surface list.

The given hypersurface will be deallocated with the other hypersurfaces in this list when the list is eventually destroyed.

Parameters
hypersurfacethe normal hypersurface to insert.
Returns
this output iterator.

◆ operator=() [3/3]

NormalHypersurfaces::HypersurfaceInserter & regina::NormalHypersurfaces::HypersurfaceInserter::operator= ( NormalHypersurfaceVector vector)
inline

Appends the normal hypersurface corresponding to the given vector to the end of the appropriate hypersurface list.

The given vector will be owned by the newly created normal hypersurface and will be deallocated with the other hypersurfaces in this list when the list is eventually destroyed.

Parameters
vectorthe vector of the normal hypersurface to insert.
Returns
this output iterator.

Member Data Documentation

◆ list_

NormalHypersurfaces* regina::NormalHypersurfaces::HypersurfaceInserter::list_

The list into which hypersurfaces will be inserted.

◆ owner_

Triangulation<4>* regina::NormalHypersurfaces::HypersurfaceInserter::owner_

The triangulation in which the hypersurfaces to be inserted are contained.


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

Copyright © 1999-2021, The Regina development team
This software is released under the GNU General Public License, with some additional permissions; see the source code for details.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@maths.uq.edu.au).