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

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

#include <surfaces/nsquad.h>

Inheritance diagram for regina::NNormalSurfaceVectorQuad:
regina::NNormalSurfaceVectorMirrored regina::NNormalSurfaceVector regina::NRay 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 bool allowsSpun () const
 Determines if the specific underlying coordinate system allows for spun-normal surfaces; that is, surfaces with infinitely many triangles.
virtual bool allowsOriented () const
 Determines if the specific underlying coordinate system allows for transversely oriented normal surfaces.
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 NNormalSurfaceVectorclone () const
 Creates a newly allocated clone of this vector.
- Public Member Functions inherited from regina::NNormalSurfaceVectorMirrored
 NNormalSurfaceVectorMirrored (unsigned length)
 Creates a new vector all of whose entries are initialised to zero.
 NNormalSurfaceVectorMirrored (const NVector< NLargeInteger > &cloneMe)
 Creates a new vector that is a clone of the given vector.
 NNormalSurfaceVectorMirrored (const NNormalSurfaceVectorMirrored &cloneMe)
 Creates a new vector that is a clone of the given vector.
virtual ~NNormalSurfaceVectorMirrored ()
 Destroys this vector and its mirror if appropriate.
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 getOrientedTriangleCoord (unsigned long tetIndex, int vertex, NTriangulation *triang, bool orientation) const
 Returns the number of oriented 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 getOrientedQuadCoord (unsigned long tetIndex, int quadType, NTriangulation *triang, bool orientation) const
 Returns the number of oriented quadrilateral 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.
- Public Member Functions inherited from regina::NNormalSurfaceVector
 NNormalSurfaceVector (unsigned length)
 Creates a new vector all of whose entries are initialised to zero.
 NNormalSurfaceVector (const NVector< NLargeInteger > &cloneMe)
 Creates a new vector that is a clone of the given vector.
virtual ~NNormalSurfaceVector ()
 A virtual destructor.
virtual bool hasMultipleOctDiscs (NTriangulation *triang) const
 Determines if this normal surface has more than one octagonal disc.
virtual bool isCompact (NTriangulation *triang) const
 Determines if the normal surface represented is compact (has finitely many discs).
virtual bool isVertexLinking (NTriangulation *triang) const
 Determines if the normal surface represented is vertex linking.
virtual std::pair< const NEdge
*, const NEdge * > 
isThinEdgeLink (NTriangulation *triang) const
 Determines if a rational multiple of the normal surface represented is the thin link of a single edge.
virtual bool isSplitting (NTriangulation *triang) const
 Determines if the normal surface represented is a splitting surface in the given triangulation.
virtual NLargeInteger isCentral (NTriangulation *triang) const
 Determines if the normal surface represented is a central surface in the given triangulation.
- Public Member Functions inherited from regina::NRay
 NRay (unsigned length)
 Creates a new ray all of whose coordinates are initialised to zero.
 NRay (const NVector< NLargeInteger > &cloneMe)
 Creates a new ray that is a clone of the given ray.
void scaleDown ()
 Scales this vector down by the greatest common divisor of all its elements.
void negate ()
 Negates every element of this vector.
- Public Member Functions inherited from regina::NVector< NLargeInteger >
 NVector (unsigned newVectorSize)
 Creates a new vector.
 NVector (unsigned newVectorSize, const NLargeInteger &initValue)
 Creates a new vector and initialises every element to the given value.
 NVector (const NVector< NLargeInteger > &cloneMe)
 Creates a new vector that is a clone of the given vector.
 ~NVector ()
 Destroys this vector.
unsigned size () const
 Returns the number of elements in the vector.
const NLargeIntegeroperator[] (unsigned index) const
 Returns the element at the given index in the vector.
void setElement (unsigned index, const NLargeInteger &value)
 Sets the element at the given index in the vector to the given value.
bool operator== (const NVector< NLargeInteger > &compare) const
 Determines if this vector is equal to the given vector.
NVector< NLargeInteger > & operator= (const NVector< NLargeInteger > &cloneMe)
 Sets this vector equal to the given vector.
void operator+= (const NVector< NLargeInteger > &other)
 Adds the given vector to this vector.
void operator-= (const NVector< NLargeInteger > &other)
 Subtracts the given vector from this vector.
void operator*= (const NLargeInteger &factor)
 Multiplies this vector by the given scalar.
NLargeInteger operator* (const NVector< NLargeInteger > &other) const
 Calculates the dot product of this vector and the given vector.
NLargeInteger norm () const
 Returns the norm of this vector.
NLargeInteger elementSum () const
 Returns the sum of all elements of this vector.
void addCopies (const NVector< NLargeInteger > &other, const NLargeInteger &multiple)
 Adds the given multiple of the given vector to this vector.
void subtractCopies (const NVector< NLargeInteger > &other, const NLargeInteger &multiple)
 Subtracts the given multiple of the given vector to 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:
lengththe 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:
cloneMethe 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 bool regina::NNormalSurfaceVectorQuad::allowsOriented ( ) const
virtual

Determines if the specific underlying coordinate system allows for transversely oriented normal surfaces.

Returns:
true if and only if transverse orientations are supported.

Implements regina::NNormalSurfaceVector.

virtual bool regina::NNormalSurfaceVectorQuad::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::NNormalSurfaceVectorQuad::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.

NLargeInteger regina::NNormalSurfaceVectorQuad::getOctCoord ( unsigned long  tetIndex,
int  octType,
NTriangulation triang 
) const
inlinevirtual

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

See NNormalSurface::getOctCoord() for further details.

Parameters:
tetIndexthe index in the triangulation of the tetrahedron in which the requested octagons reside; this should be between 0 and NTriangulation::getNumberOfTetrahedra()-1 inclusive.
octTypethe number of the vertex splitting that this octagon type represents; this should be between 0 and 2 inclusive.
triangthe 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
inlinevirtual

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::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:
triangulationthe 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:
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::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:
triangthe 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:
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-2012, 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).