regina::NNormalSurfaceVectorQuad Class Reference
[Normal Surfaces]

A normal surface vector using quad coordinates. More...

#include <nsquad.h>

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

List of all members.

Public Member Functions

 NNormalSurfaceVectorQuad (unsigned length)
 Creates a new vector all of whose entries are initialised to zero.
 NNormalSurfaceVectorQuad (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 const NVertexisVertexLink (NTriangulation *triang) const
 Determines if a rational multiple of the normal surface represented is the link of a single vertex.
virtual NLargeInteger getOctCoord (unsigned long tetIndex, int octType, NTriangulation *triang) const
 Returns the number of octagonal discs of the given type in this normal surface.
virtual NVector< NLargeInteger > * clone () const
 Makes 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

A normal surface vector using quad coordinates.

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

Python:
Not present.

Constructor & Destructor Documentation

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

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

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

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

Parameters:
cloneMe the vector to clone.

Member Function Documentation

virtual bool regina::NNormalSurfaceVectorQuad::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 NVector<NLargeInteger>* regina::NNormalSurfaceVectorQuad::clone (  )  const [virtual]

Makes a newly allocated clone of this vector.

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

Returns:
a clone of this vector.

Reimplemented from regina::NRay.

NLargeInteger regina::NNormalSurfaceVectorQuad::getOctCoord ( unsigned long  tetIndex,
int  octType,
NTriangulation triang 
) const [inline, virtual]

Returns the number of octagonal discs of the given type in this normal surface.

See NNormalSurface::getOctCoord() for further details.

Parameters:
tetIndex the index in the triangulation of the tetrahedron in which the requested octagons reside; this should be between 0 and NTriangulation::getNumberOfTetrahedra()-1 inclusive.
octType the number of the vertex splitting that this octagon type represents; this should be between 0 and 2 inclusive.
triang the triangulation in which this normal surface lives.
Returns:
the number of octagonal discs of the given type.

Reimplemented from regina::NNormalSurfaceVectorMirrored.

const NVertex * regina::NNormalSurfaceVectorQuad::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:
triang the 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::NNormalSurfaceVectorQuad::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:
triangulation the triangulation upon which these validity constraints will be based.
Returns:
a newly allocated set of constraints.

Reimplemented from regina::NNormalSurfaceVector.

static NMatrixInt* regina::NNormalSurfaceVectorQuad::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:
triangulation the triangulation upon which these matching equations will be based.
Returns:
a newly allocated set of matching equations.

Reimplemented from regina::NNormalSurfaceVector.

virtual NNormalSurfaceVector* regina::NNormalSurfaceVectorQuad::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:
triang the triangulation in which this normal surface lives.
Returns:
a newly created mirror vector.

Implements regina::NNormalSurfaceVectorMirrored.

static NNormalSurfaceVector* regina::NNormalSurfaceVectorQuad::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:
triangulation the 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-2009, Ben Burton
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).