Stores data of type T
for every normal disc within a particular normal surface.
More...
#include <surfaces/ndisc.h>
template<class T>
class regina::NDiscSetSurfaceData< T >
Stores data of type T
for every normal disc within a particular normal surface.
This data is stored using an array of NDiscSetTetData<T> objects, one for each tetrahedron (thus the inherited member function tetDiscs() will return an object of class NDiscSetTetData<T>).
- 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.
Creates a new disc set corresponding to the discs of the given normal surface.
The data for each disc will remain uninitialised.
- Parameters
-
surface | the normal surface whose discs we shall use. |
Creates a new disc set corresponding to the discs of the given normal surface.
The data for each disc will be initialised to the given value.
- Parameters
-
surface | the normal surface whose discs we shall use. |
initValue | the value with which to initialise the data corresponding to each disc. |
Determines which normal disc is adjacent to the given normal disc along the given directed normal arc in the surface described by this disc set.
A directed normal arc will be specified by a permutation p, where the arc runs around vertex p[0]
parallel to the directed edge from vertex p[1]
to p[2]
.
- Parameters
-
disc | the given normal disc; this must be a disc in this disc set. |
arc | the given normal arc; this must actually be an arc on the boundary of the given normal disc (although it may run in either direction). |
adjArc | returns the same directed normal arc that was passed, but expressed in terms of the vertices of the adjacent tetrahedron. Any value may be initially passed. If there is no adjacent disc/tetrahedron, this permutation will remain unchanged. |
- Returns
- the normal disc adjacent to the given disc along the given arc, or 0 if there is no adjacent disc. This disc specifier will be newly created, and it is up to the caller of this routine to dispose of it.
Retrieves a reference to the data corresponding to the given normal disc.
- Parameters
-
disc | the disc whose data we require; this must refer to a disc within this disc set. |
- Returns
- a reference to the data corresponding to the given normal disc.
unsigned long regina::NDiscSetSurface::nDiscs |
( |
unsigned long |
tetIndex, |
|
|
int |
type |
|
) |
| const |
|
inlineinherited |
Determines the number of discs of the given type inside the given tetrahedron.
- Parameters
-
tetIndex | the index in the triangulation of the tetrahedron to examine. |
type | the 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 the given tetrahedron.
unsigned long regina::NDiscSetSurface::nTets |
( |
| ) |
const |
|
inlineinherited |
Returns the number of tetrahedra in the underlying triangulation.
- Returns
- the number of tetrahedra.
NDiscSetTet & regina::NDiscSetSurface::tetDiscs |
( |
unsigned long |
tetIndex | ) |
const |
|
inlineinherited |
Returns the specific set of discs living inside the given tetrahedron.
- Parameters
-
tetIndex | the index in the triangulation of the given tetrahedron. |
- Returns
- the set of discs inside the given tetrahedron.
The disc sets corresponding to each tetrahedron.
The triangulation in which the normal surface lives.
The documentation for this class was generated from the following file: