regina::NNormalSurfaceVectorStandard Class Reference
[Normal Surfaces]

A normal surface vector using standard triangle-quad coordinates. More...

#include <nsstandard.h>

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

List of all members.

Public Member Functions

 NNormalSurfaceVectorStandard (unsigned length)
 Creates a new vector all of whose entries are initialised to zero.
 NNormalSurfaceVectorStandard (const NVector< NLargeInteger > &cloneMe)
 Creates a new vector that is a clone of the given vector.
virtual bool allowsAlmostNormal () const
 Determines if the specific underlying coordinate system allows for almost normal surfaces, that is, allows for octagonal discs.
virtual NLargeInteger getTriangleCoord (unsigned long tetIndex, int vertex, NTriangulation *triang) const
 Returns the number of triangular discs of the given type in this normal surface.
virtual NLargeInteger getQuadCoord (unsigned long tetIndex, int quadType, NTriangulation *triang) const
 Returns the number of quadrilateral discs of the given type in this normal surface.
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 NLargeInteger getEdgeWeight (unsigned long edgeIndex, NTriangulation *triang) const
 Returns the number of times this normal surface crosses the given edge.
virtual NLargeInteger getFaceArcs (unsigned long faceIndex, int faceVertex, NTriangulation *triang) const
 Returns the number of arcs in which this normal surface intersects the given face in the given direction.
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 standard triangle-quad coordinates.

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

Python:
Not present.

Constructor & Destructor Documentation

regina::NNormalSurfaceVectorStandard::NNormalSurfaceVectorStandard ( 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::NNormalSurfaceVectorStandard::NNormalSurfaceVectorStandard ( 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::NNormalSurfaceVectorStandard::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::NNormalSurfaceVectorStandard::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.

virtual NLargeInteger regina::NNormalSurfaceVectorStandard::getEdgeWeight ( unsigned long  edgeIndex,
NTriangulation triang 
) const [virtual]

Returns the number of times this normal surface crosses the given edge.

See NNormalSurface::getEdgeWeight() for further details.

Parameters:
edgeIndex the index in the triangulation of the edge in which we are interested; this should be between 0 and NTriangulation::getNumberOfEdges()-1 inclusive.
triang the triangulation in which this normal surface lives.
Returns:
the number of times this normal surface crosses the given edge.

Implements regina::NNormalSurfaceVector.

virtual NLargeInteger regina::NNormalSurfaceVectorStandard::getFaceArcs ( unsigned long  faceIndex,
int  faceVertex,
NTriangulation triang 
) const [virtual]

Returns the number of arcs in which this normal surface intersects the given face in the given direction.

See NNormalSurface::getFaceArcs() for further details.

Parameters:
faceIndex the index in the triangulation of the face in which we are interested; this should be between 0 and NTriangulation::getNumberOfFaces()-1 inclusive.
faceVertex the vertex of the face (0, 1 or 2) around which the arcs of intersection that we are interested in lie; only these arcs will be counted.
triang the triangulation in which this normal surface lives.
Returns:
the number of times this normal surface intersect the given face with the given arc type.

Implements regina::NNormalSurfaceVector.

NLargeInteger regina::NNormalSurfaceVectorStandard::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.

Implements regina::NNormalSurfaceVector.

NLargeInteger regina::NNormalSurfaceVectorStandard::getQuadCoord ( unsigned long  tetIndex,
int  quadType,
NTriangulation triang 
) const [inline, virtual]

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

See NNormalSurface::getQuadCoord() for further details.

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

Implements regina::NNormalSurfaceVector.

NLargeInteger regina::NNormalSurfaceVectorStandard::getTriangleCoord ( unsigned long  tetIndex,
int  vertex,
NTriangulation triang 
) const [inline, virtual]

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

See NNormalSurface::getTriangleCoord() for further details.

Parameters:
tetIndex the index in the triangulation of the tetrahedron in which the requested triangles reside; this should be between 0 and NTriangulation::getNumberOfTetrahedra()-1 inclusive.
vertex the vertex of the given tetrahedron around which the requested triangles lie; this should be between 0 and 3 inclusive.
triang the triangulation in which this normal surface lives.
Returns:
the number of triangular discs of the given type.

Implements regina::NNormalSurfaceVector.

static NEnumConstraintList* regina::NNormalSurfaceVectorStandard::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::NNormalSurfaceVectorStandard::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.

static NNormalSurfaceVector* regina::NNormalSurfaceVectorStandard::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).