Regina Calculation Engine
Public Types | Public Member Functions | Protected Attributes | List of all members
regina::NDiscSetTetData< T > Class Template Reference

Stores data of type T for every normal disc inside a single tetrahedron. More...

#include <surfaces/ndisc.h>

Inheritance diagram for regina::NDiscSetTetData< T >:
regina::NDiscSetTet

Public Types

typedef T * DataPtr
 A type that is a pointer to the data stored with each disc. More...
 

Public Member Functions

 NDiscSetTetData (const NNormalSurface &surface, unsigned long tetIndex)
 Creates a new disc set corresponding to the discs of the given normal surface that lie within the given tetrahedron. More...
 
 NDiscSetTetData (const NNormalSurface &surface, unsigned long tetIndex, const T &initValue)
 Creates a new disc set corresponding to the discs of the given normal surface that lie within the given tetrahedron. More...
 
 NDiscSetTetData (unsigned long tri0, unsigned long tri1, unsigned long tri2, unsigned long tri3, unsigned long quad0, unsigned long quad1, unsigned long quad2, unsigned long oct0=0, unsigned long oct1=0, unsigned long oct2=0)
 Creates a new disc set where the number of discs of each type is explicitly given. More...
 
virtual ~NDiscSetTetData ()
 Destroys this disc set and deallocates all data arrays. More...
 
T & data (int discType, unsigned long discNumber)
 Retrieves a reference to the data corresponding to the given normal disc. More...
 
unsigned long nDiscs (int type) const
 Determines the number of discs of the given type inside this tetrahedron. More...
 
unsigned long arcFromDisc (int arcFace, int arcVertex, int discType, unsigned long discNumber) const
 Determines which normal arc of a given type on a given face of this tetrahedron corresponds to the given normal disc. More...
 
void discFromArc (int arcFace, int arcVertex, unsigned long arcNumber, int &discType, unsigned long &discNumber) const
 Determines which normal disc in this tetrahedron meets the given normal arc on the given face. More...
 

Protected Attributes

DataPtr internalData [10]
 Stores the data corresponding to each normal disc. More...
 
unsigned long internalNDiscs [10]
 The number of discs of each type. More...
 

Detailed Description

template<class T>
class regina::NDiscSetTetData< T >

Stores data of type T for every normal disc inside a single tetrahedron.

Warning
This class converts the number of normal discs of a given type from NLargeInteger to unsigned long. See the precondition below.
Precondition
The number of normal discs of a particular type in a particular tetrahedron can be represented by a long integer.
This class should only be used with embedded normal surfaces.
Type T has a default constructor and an assignment operator. That is, if a and b are of type T, then a can be declared with no parameters and can then receive the value of b using a=b.
Python:
Not present.

Member Typedef Documentation

template<class T >
typedef T* regina::NDiscSetTetData< T >::DataPtr

A type that is a pointer to the data stored with each disc.

Constructor & Destructor Documentation

template<class T >
regina::NDiscSetTetData< T >::NDiscSetTetData ( const NNormalSurface surface,
unsigned long  tetIndex 
)
inline

Creates a new disc set corresponding to the discs of the given normal surface that lie within the given tetrahedron.

The data for each disc will remain uninitialised.

Parameters
surfacethe normal surface whose discs we shall use.
tetIndexthe index in the triangulation of the tetrahedron that our discs must lie in; this must be between 0 and tri.getNumberOfTetrahedra()-1 inclusive, where tri is the triangulation containing the given normal surface.
template<class T >
regina::NDiscSetTetData< T >::NDiscSetTetData ( const NNormalSurface surface,
unsigned long  tetIndex,
const T &  initValue 
)
inline

Creates a new disc set corresponding to the discs of the given normal surface that lie within the given tetrahedron.

The data for each disc will be initialised to the given value.

Parameters
surfacethe normal surface whose discs we shall use.
tetIndexthe index in the triangulation of the tetrahedron that our discs must lie in; this must be between 0 and tri.getNumberOfTetrahedra()-1 inclusive, where tri is the triangulation containing the given normal surface.
initValuethe value with which to initialise the data corresponding to each disc.
template<class T >
regina::NDiscSetTetData< T >::NDiscSetTetData ( unsigned long  tri0,
unsigned long  tri1,
unsigned long  tri2,
unsigned long  tri3,
unsigned long  quad0,
unsigned long  quad1,
unsigned long  quad2,
unsigned long  oct0 = 0,
unsigned long  oct1 = 0,
unsigned long  oct2 = 0 
)
inline

Creates a new disc set where the number of discs of each type is explicitly given.

The data for each disc will remain uninitialised.

Parameters
tri0the number of triangular discs surrounding vertex 0.
tri1the number of triangular discs surrounding vertex 1.
tri2the number of triangular discs surrounding vertex 2.
tri3the number of triangular discs surrounding vertex 3.
quad0the number of quadrilateral discs of type 0.
quad1the number of quadrilateral discs of type 1.
quad2the number of quadrilateral discs of type 2.
oct0the number of octahedral discs of type 0.
oct1the number of octahedral discs of type 1.
oct2the number of octahedral discs of type 2.
template<class T >
virtual regina::NDiscSetTetData< T >::~NDiscSetTetData ( )
inlinevirtual

Destroys this disc set and deallocates all data arrays.

Note that no assumption is made about type T, so if data elements are pointers to dynamically allocated objects, these will not be destroyed.

Member Function Documentation

unsigned long regina::NDiscSetTet::arcFromDisc ( int  arcFace,
int  arcVertex,
int  discType,
unsigned long  discNumber 
) const
inherited

Determines which normal arc of a given type on a given face of this tetrahedron corresponds to the given normal disc.

Precondition
The given normal disc actually meets a normal arc of the given type on the given face.
Parameters
arcFacethe face of this tetrahedron containing the normal arc (between 0 and 3 inclusive).
arcVertexthe vertex of this tetrahedron about which the normal arc runs (between 0 and 3 inclusive); arcFace and arcVertex should not be the same.
discTypethe disc type of the given normal disc; this should be between 0 and 9 inclusive, as described in the NDiscSpec class notes.
discNumberindicates which normal disc of the given disc type is referred to (between 0 and nDiscs(discType)-1 inclusive).
Returns
the number of the normal arc of the given type that belongs to the given normal disc. Arcs of a given type (where arcFace and arcVertex together define the arc type) are numbered starting at 0 from the tetrahedron vertex outwards.
template<class T >
T& regina::NDiscSetTetData< T >::data ( int  discType,
unsigned long  discNumber 
)
inline

Retrieves a reference to the data corresponding to the given normal disc.

Parameters
discTypethe disc type of the given normal disc; this should be between 0 and 9 inclusive, as described in the NDiscSpec class notes.
discNumberindicates which normal disc of the given disc type is referred to; this should be between 0 and nDiscs(discType)-1 inclusive.
Returns
a reference to the data corresponding to the given normal disc.
void regina::NDiscSetTet::discFromArc ( int  arcFace,
int  arcVertex,
unsigned long  arcNumber,
int &  discType,
unsigned long &  discNumber 
) const
inherited

Determines which normal disc in this tetrahedron meets the given normal arc on the given face.

Precondition
The given normal arc actually exists in the normal surface with which this NDiscSetTet object was created.
Parameters
arcFacethe face of this tetrahedron containing the normal arc (between 0 and 3 inclusive).
arcVertexthe vertex of this tetrahedron about which the normal arc runs (between 0 and 3 inclusive); arcFace and arcVertex should not be the same.
arcNumberindicates which normal arc of the given type is referred to. Arcs of a given type (where arcFace and arcVertex together define the arc type) are numbered starting at 0 from the tetrahedron vertex outwards.
discTypereturns the disc type of the normal disc that meets the given normal arc; this will be between 0 and 9 inclusive, as described in the NDiscSpec class notes. Any value may be initially passed.
discNumberreturns a number that indicates which normal disc of the returned disc type (discType) meets the given normal arc; this will be between 0 and nDiscs(discType)-1 inclusive. Any value may be initially passed.
unsigned long regina::NDiscSetTet::nDiscs ( int  type) const
inlineinherited

Determines the number of discs of the given type inside this tetrahedron.

Parameters
typethe disc type to examine; this should be between 0 and 9 inclusive. Disc types are outlined in the NDiscSpec class notes.
Returns
the number of discs of the given type inside this tetrahedron.

Member Data Documentation

template<class T >
DataPtr regina::NDiscSetTetData< T >::internalData[10]
protected

Stores the data corresponding to each normal disc.

unsigned long regina::NDiscSetTet::internalNDiscs[10]
protectedinherited

The number of discs of each type.


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

Copyright © 1999-2014, 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@debian.org).