Regina Calculation Engine
Public Member Functions | Static Public Member Functions
regina::NNormalSurfaceVectorQuadOct Class Reference

An almost normal surface vector using quad-oct coordinates. More...

#include <surfaces/nsquadoct.h>

Inheritance diagram for regina::NNormalSurfaceVectorQuadOct:
regina::NNormalSurfaceVectorMirrored regina::NNormalSurfaceVector regina::NRay regina::NVector< NLargeInteger >

List of all members.

Public Member Functions

 NNormalSurfaceVectorQuadOct (unsigned length)
 Creates a new vector all of whose entries are initialised to zero.
 NNormalSurfaceVectorQuadOct (const NVector< NLargeInteger > &cloneMe)
 Creates a new vector that is a clone of the given vector.
virtual NNormalSurfaceVectormakeMirror (NTriangulation *triang) const
 Creates a new mirror vector corresponding to this vector.
virtual bool allowsAlmostNormal () const
 Determines if the specific underlying coordinate system allows for almost normal surfaces, that is, allows for octagonal discs.
virtual bool allowsSpun () const
 Determines if the specific underlying coordinate system allows for spun normal surfaces; that is, surfaces with infinitely many triangles.
virtual const NVertexisVertexLink (NTriangulation *triang) const
 Determines if a rational multiple of the normal surface represented is the link of a single vertex.
virtual NNormalSurfaceVectorclone () const
 Creates a newly allocated clone of this vector.

Static Public Member Functions

static NNormalSurfaceVectormakeZeroVector (const NTriangulation *triangulation)
 Returns a new normal surface vector of the appropriate length for the given triangulation and for the flavour of coordinate system corresponding to this subclass of NNormalSurfaceVector.
static NMatrixIntmakeMatchingEquations (NTriangulation *triangulation)
 Creates a new set of normal surface matching equations for the given triangulation using the flavour of coordinate system corresponding to this particular subclass of NNormalSurfaceVector.
static NEnumConstraintListmakeEmbeddedConstraints (NTriangulation *triangulation)
 Creates a new set of validity constraints representing the condition that normal surfaces be embedded.

Detailed Description

An almost normal surface vector using quad-oct coordinates.

If there are t tetrahedra in the underlying triangulation, there must be precisely 6t coordinates. The first six coordinates will be for the first tetrahedron, the next six for the second tetrahedron and so on. For each tetrahedron, the first three coordinates represent the number of quadrilateral discs of type 0, 1 and 2 (see NNormalSurface::getQuadCoord()), and the final three represent the number of octagonal discs of type 0, 1 and 2 (see NNormalSurface::getOctCoord()).

Python:
Not present.

Constructor & Destructor Documentation

regina::NNormalSurfaceVectorQuadOct::NNormalSurfaceVectorQuadOct ( unsigned  length) [inline]

Creates a new vector all of whose entries are initialised to zero.

Parameters:
lengththe number of elements in the new vector.
regina::NNormalSurfaceVectorQuadOct::NNormalSurfaceVectorQuadOct ( const NVector< NLargeInteger > &  cloneMe) [inline]

Creates a new vector that is a clone of the given vector.

Parameters:
cloneMethe vector to clone.

Member Function Documentation

virtual bool regina::NNormalSurfaceVectorQuadOct::allowsAlmostNormal ( ) const [virtual]

Determines if the specific underlying coordinate system allows for almost normal surfaces, that is, allows for octagonal discs.

Note that this has nothing to do with whether or not this specific surface contains octagonal discs.

Returns:
true if and only if almost normal surfaces are allowed.

Implements regina::NNormalSurfaceVector.

virtual bool regina::NNormalSurfaceVectorQuadOct::allowsSpun ( ) const [virtual]

Determines if the specific underlying coordinate system allows for spun normal surfaces; that is, surfaces with infinitely many triangles.

Note that this has nothing to do with whether or not this specific surface contains infinitely many triangles.

Returns:
true if and only if spun normal surfaces are allowed.

Implements regina::NNormalSurfaceVector.

virtual NNormalSurfaceVector* regina::NNormalSurfaceVectorQuadOct::clone ( ) const [virtual]

Creates a newly allocated clone of this vector.

The clone will be of the same subclass of NNormalSurfaceVector as this vector.

Implements regina::NNormalSurfaceVector.

const NVertex * regina::NNormalSurfaceVectorQuadOct::isVertexLink ( NTriangulation triang) const [inline, virtual]

Determines if a rational multiple of the normal surface represented is the link of a single vertex.

The default implementation for this routine involves counting the number of discs of every type. Subclasses of NNormalSurfaceVector should override this if they can provide a faster implementation.

Parameters:
triangthe triangulation in which this normal surface lives.
Returns:
the vertex linked by this surface, or 0 if this surface is not the link of a single vertex.

Reimplemented from regina::NNormalSurfaceVector.

static NEnumConstraintList* regina::NNormalSurfaceVectorQuadOct::makeEmbeddedConstraints ( NTriangulation triangulation) [static]

Creates a new set of validity constraints representing the condition that normal surfaces be embedded.

The validity constraints will be expressed relative to the flavour of coordinate system corresponding to this particular subclass of NNormalSurfaceVector.

Parameters:
triangulationthe triangulation upon which these validity constraints will be based.
Returns:
a newly allocated set of constraints.

Reimplemented from regina::NNormalSurfaceVector.

static NMatrixInt* regina::NNormalSurfaceVectorQuadOct::makeMatchingEquations ( NTriangulation triangulation) [static]

Creates a new set of normal surface matching equations for the given triangulation using the flavour of coordinate system corresponding to this particular subclass of NNormalSurfaceVector.

See makeMatchingEquations() for further details.

Parameters:
triangulationthe triangulation upon which these matching equations will be based.
Returns:
a newly allocated set of matching equations.

Reimplemented from regina::NNormalSurfaceVector.

virtual NNormalSurfaceVector* regina::NNormalSurfaceVectorQuadOct::makeMirror ( NTriangulation triang) const [virtual]

Creates a new mirror vector corresponding to this vector.

The mirror vector should represent the same normal surface as this vector, and should have fast coordinate lookup routines (getTriangleCoord(), getQuadCord() and so on). It is recommended that the mirror vector be an NNormalSurfaceVectorStandard or an NNormalSurfaceVectorANStandard.

Parameters:
triangthe triangulation in which this normal surface lives.
Returns:
a newly created mirror vector.

Implements regina::NNormalSurfaceVectorMirrored.

static NNormalSurfaceVector* regina::NNormalSurfaceVectorQuadOct::makeZeroVector ( const NTriangulation triangulation) [static]

Returns a new normal surface vector of the appropriate length for the given triangulation and for the flavour of coordinate system corresponding to this subclass of NNormalSurfaceVector.

All elements of the new vector will be initialised to zero.

See makeZeroVector() for further details.

Parameters:
triangulationthe triangulation upon which the underlying coordinate system is based.
Returns:
a new zero vector of the correct class and length.

Reimplemented from regina::NNormalSurfaceVector.


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

Copyright © 1999-2011, The Regina development team
This software is released under the GNU General Public License.
For further information, or to submit a bug or other problem, please contact Ben Burton (bab@debian.org).