tCubCell< CoordT > Class Template Reference

An elementary cubical cell with vertices of integer type. More...

#include <cubcell.h>

List of all members.

Public Types
typedef CoordT	CoordType
	The type of coordinates.
Public Member Functions
	tCubCell ()
	The default constructor of an empty cube.
template<class CoordArray >
	tCubCell (int dimension, const CoordArray &coordinates)
	The constructor of a full cube from an array of coordinates.
template<class CoordArray >
	tCubCell (int dimension, const CoordArray &left, const CoordArray &right)
	The constructor of a full cube from two arrays of coordinates.
	tCubCell (const tCubCell< CoordT > &c)
	The copy constructor.
	tCubCell (const tCubCell< CoordT > &c, int n)
	The constructor of the n-th boundary cube.
	tCubCell (const tCubCell< CoordT > &c, int n, int side)
	The constructor of the n-th component of the Alexander-Whitney diagonal, either the left one (if side = 0), or the right one (if side = 1).
tCubCell< CoordT > &	operator= (const tCubCell< CoordT > &s)
	The assignment operator.
	~tCubCell ()
	The destructor.
int	spaceDim () const
	Returns the dimension of the embedding space.
int	dim () const
	Returns the dimension of the elementary cube.
const CoordT	left (int n) const
	Returns the n-th left coordinate of the elementary cube.
const CoordT	right (int n) const
	Returns the n-th right coordinate of the elementary cube.
int	boundaryLength () const
	Returns the length of the boundary of the elementary cube.
int	boundaryCoef (int n) const
	Returns the n-th coefficient in the boundary of the cube.
int	diagonalLength () const
	Returns the number of terms in the Alexander-Whitneney diagonal.
bool	operator== (const tCubCell< CoordT > &s) const
	The equality operator.
void	swap (tCubCell< CoordT > &s)
	Swaps the data between two cubical cells.
Private Attributes
int_t	n1
	The number that defines the left corner of the elementary cube.
int_t	n2
	The number that defines the right corner of the elementary cube.

---

Detailed Description

template<class CoordT>
class tCubCell< CoordT >

An elementary cubical cell with vertices of integer type.

Definition at line 52 of file cubcell.h.

---

Member Typedef Documentation

template<class CoordT>

typedef CoordT tCubCell< CoordT >::CoordType

The type of coordinates.

Definition at line 56 of file cubcell.h.

---

Constructor & Destructor Documentation

template<class CoordT >

tCubCell< CoordT >::tCubCell

(

)

[inline]

The default constructor of an empty cube.

Definition at line 130 of file cubcell.h.

template<class CoordT >

template<class CoordArray >

tCubCell< CoordT >::tCubCell	(	int	dimension,
		const CoordArray &	coordinates
	)		[inline]

The constructor of a full cube from an array of coordinates.

Definition at line 137 of file cubcell.h.

References tCubCell< CoordT >::n1, and tCubCell< CoordT >::n2.

template<class CoordT >

template<class CoordArray >

tCubCell< CoordT >::tCubCell	(	int	dimension,
		const CoordArray &	left,
		const CoordArray &	right
	)		[inline]

The constructor of a full cube from two arrays of coordinates.

Definition at line 163 of file cubcell.h.

References tCubCell< CoordT >::n1, and tCubCell< CoordT >::n2.

template<class CoordT >

tCubCell< CoordT >::tCubCell

(

const tCubCell< CoordT > &

c )

[inline]

The copy constructor.

Definition at line 196 of file cubcell.h.

template<class CoordT >

tCubCell< CoordT >::tCubCell	(	const tCubCell< CoordT > &	c,
		int	n
	)		[inline]

The constructor of the n-th boundary cube.

Definition at line 203 of file cubcell.h.

template<class CoordT >

tCubCell< CoordT >::tCubCell	(	const tCubCell< CoordT > &	c,
		int	n,
		int	side
	)		[inline]

The constructor of the n-th component of the Alexander-Whitney diagonal, either the left one (if side = 0), or the right one (if side = 1).

Definition at line 255 of file cubcell.h.

References diagVersion.

template<class CoordT >

tCubCell< CoordT >::~tCubCell

(

)

[inline]

The destructor.

Definition at line 414 of file cubcell.h.

---

Member Function Documentation

template<class CoordT >

int tCubCell< CoordT >::boundaryCoef

(

int

n )

const [inline]

Returns the n-th coefficient in the boundary of the cube.

Definition at line 459 of file cubcell.h.

template<class CoordT >

int tCubCell< CoordT >::boundaryLength

(

)

const [inline]

Returns the length of the boundary of the elementary cube.

Definition at line 448 of file cubcell.h.

template<class CoordT >

int tCubCell< CoordT >::diagonalLength

(

)

const [inline]

Returns the number of terms in the Alexander-Whitneney diagonal.

Definition at line 468 of file cubcell.h.

template<class CoordT >

int tCubCell< CoordT >::dim

(

)

const [inline]

Returns the dimension of the elementary cube.

Definition at line 426 of file cubcell.h.

template<class CoordT >

const CoordT tCubCell< CoordT >::left

(

int

n )

const [inline]

Returns the n-th left coordinate of the elementary cube.

Definition at line 434 of file cubcell.h.

template<class CoordT >

tCubCell< CoordT > & tCubCell< CoordT >::operator=

(

const tCubCell< CoordT > &

s )

[inline]

The assignment operator.

Definition at line 406 of file cubcell.h.

template<class CoordT >

bool tCubCell< CoordT >::operator==

(

const tCubCell< CoordT > &

s )

const [inline]

The equality operator.

Definition at line 477 of file cubcell.h.

template<class CoordT >

const CoordT tCubCell< CoordT >::right

(

int

n )

const [inline]

Returns the n-th right coordinate of the elementary cube.

Definition at line 441 of file cubcell.h.

template<class CoordT >

int tCubCell< CoordT >::spaceDim

(

)

const [inline]

Returns the dimension of the embedding space.

Definition at line 420 of file cubcell.h.

template<class CoordT >

void tCubCell< CoordT >::swap

(

tCubCell< CoordT > &

s )

[inline]

Swaps the data between two cubical cells.

Definition at line 483 of file cubcell.h.

---

Member Data Documentation

template<class CoordT>

int_t tCubCell< CoordT >::n1 [private]

The number that defines the left corner of the elementary cube.

The dimension of the embedding space is stored in high bits of this number.

Definition at line 118 of file cubcell.h.

Referenced by tCubCell< CoordT >::tCubCell().

template<class CoordT>

int_t tCubCell< CoordT >::n2 [private]

The number that defines the right corner of the elementary cube.

The dimension of the cubical cell is stored in the high bits of this number.

Definition at line 123 of file cubcell.h.

Referenced by tCubCell< CoordT >::tCubCell().

---

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

• chaincon/cubcell.h