regina::NDiscSetSurfaceData< T > Class Template Reference
[Normal Surfaces]

Stores data of type T for every normal disc within a particular normal surface. More...

#include <ndisc.h>

Inheritance diagram for regina::NDiscSetSurfaceData< T >:

List of all members.

Public Member Functions
	NDiscSetSurfaceData (const NNormalSurface &surface)
	Creates a new disc set corresponding to the discs of the given normal surface.
	NDiscSetSurfaceData (const NNormalSurface &surface, const T &initValue)
	Creates a new disc set corresponding to the discs of the given normal surface.
T &	data (const NDiscSpec &disc)
	Retrieves a reference to the data corresponding to the given normal disc.

---

Detailed Description

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.

---

Constructor & Destructor Documentation

template<class T>

regina::NDiscSetSurfaceData< T >::NDiscSetSurfaceData

(

const NNormalSurface &

surface

)

[inline]

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.

template<class T>

regina::NDiscSetSurfaceData< T >::NDiscSetSurfaceData	(	const NNormalSurface &	surface,
		const T &	initValue
	)			[inline]

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.

---

Member Function Documentation

template<class T>

T& regina::NDiscSetSurfaceData< T >::data

(

const NDiscSpec &

disc

)

[inline]

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.

---

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

• ndisc.h