chomp::homology::tCubeVar< coordtype > Class Template Reference

This class defines a hypercube in R^n with edges parallel to the axes and with size 1 in each direction. More...

#include <cubevar.h>

Public Types
typedef coordtype	CoordType
	The type of coordinates of a cube. More...
typedef tCellVar< coordtype >	CellType
	The type of a cell related to this cube type. More...
typedef tWrapBase< coordtype >	PointBase
	The point base (for wrapping and tabulating coordinates). More...

Public Member Functions
	tCubeVar ()
	The default constructor. More...
	tCubeVar (const coordtype *c, int dim)
	The constructor from a table of coordinates. More...
	tCubeVar (int number, int dim)
	The constructor from a number (invalid in this class). More...
	tCubeVar (const tCubeVar< coordtype > &c)
	The copy constructor. More...
tCubeVar< coordtype > &	operator= (const tCubeVar< coordtype > &c)
	The assignment operator. More...
	~tCubeVar ()
	The destructor. More...
int	dim () const
	Returns the dimension of the cube. More...
coordtype *	coord (coordtype *c) const
	Fills out the coordinate table with the cube's coordinates. More...
int_t	hashkey1 () const
	Returns hashing key no. 1 required by the hashing set template. More...
int_t	hashkey2 () const
	Returns hashing key no. 2 required by the hashing set template. More...

Static Public Member Functions
static const char *	name ()
	Returns the name of the objects represented by this class. More...
static const char *	pluralname ()
	Returns the plural name of the objects represented by this class. More...

Static Public Attributes
static const int	MaxDim = 50
	The maximal dimension of a cube. More...

Private Member Functions
coordtype *	initialize (int dim)
	Initializes the data for a cube of a given dimension > 0. More...

Private Attributes
coordtype *	tab
	The table containing the coordinates of the cube, as well as its dimension (at tab [0]). More...

Friends
class	tCellVar< coordtype >
int	operator== (const tCubeVar< coordtype > &c1, const tCubeVar< coordtype > &c2)
	The operator == for cubes. More...

Detailed Description

template<class coordtype>
class chomp::homology::tCubeVar< coordtype >

This class defines a hypercube in R^n with edges parallel to the axes and with size 1 in each direction.

In this implementation, an array is allocated for the coordinates of the minimal vertex of a cube.

Definition at line 71 of file cubevar.h.

Member Typedef Documentation

CellType

template<class coordtype >

typedef tCellVar<coordtype> chomp::homology::tCubeVar< coordtype >::CellType

The type of a cell related to this cube type.

Definition at line 78 of file cubevar.h.

CoordType

template<class coordtype >

typedef coordtype chomp::homology::tCubeVar< coordtype >::CoordType

The type of coordinates of a cube.

Definition at line 75 of file cubevar.h.

PointBase

template<class coordtype >

typedef tWrapBase<coordtype> chomp::homology::tCubeVar< coordtype >::PointBase

The point base (for wrapping and tabulating coordinates).

Definition at line 84 of file cubevar.h.

Constructor & Destructor Documentation

tCubeVar() [1/4]

template<class coordtype >

chomp::homology::tCubeVar< coordtype >::tCubeVar

inline

The default constructor.

Definition at line 166 of file cubevar.h.

{
        tab = NULL;
        return;
} /* tCubeVar::tCubeVar */

tCubeVar() [2/4]

template<class coordtype >

chomp::homology::tCubeVar< coordtype >::tCubeVar ( const coordtype *  c, int  dim  )

inline

The constructor from a table of coordinates.

Definition at line 173 of file cubevar.h.

{
        if (d < 0)
                throw "Negative dimension of a cube.";
        if (d)
                PointBase::wrapcopy (initialize (d), c, d);
        else
                tab = NULL;
        return;
} /* tCubeVar::tCubeVar */

References chomp::homology::tPointBase< coordtype >::wrapcopy().

tCubeVar() [3/4]

template<class coordtype >

chomp::homology::tCubeVar< coordtype >::tCubeVar ( int  number, int  dim  )

inline

The constructor from a number (invalid in this class).

Definition at line 185 of file cubevar.h.

{
        throw "Unable to construct a cube from a number.";
} /* tCubeVar::tCubeVar */

tCubeVar() [4/4]

template<class coordtype >

chomp::homology::tCubeVar< coordtype >::tCubeVar ( const tCubeVar< coordtype > &  c )

inline

The copy constructor.

Definition at line 191 of file cubevar.h.

{
        if (!c. dim ())
                tab = NULL;
        else
        {
                initialize (c. dim ());
                copycoord (tab + 1, c. tab + 1, c. dim ());
        }
        return;
} /* tCubeVar::tCubeVar */

References chomp::homology::copycoord().

~tCubeVar()

template<class coordtype >

chomp::homology::tCubeVar< coordtype >::~tCubeVar< coordtype >

inline

The destructor.

Definition at line 204 of file cubevar.h.

{
        if (tab)
                delete [] tab;
        return;
} /* tCubeVar::~tCubeVar */

Member Function Documentation

coord()

template<class coordtype >

coordtype * chomp::homology::tCubeVar< coordtype >::coord ( coordtype *  c ) const

inline

Fills out the coordinate table with the cube's coordinates.

Definition at line 250 of file cubevar.h.

{
        if (!tab)
                return 0;
        for (int i = 0; i < *tab; ++ i)
                c [i] = tab [i + 1];
        return c;
} /* tCubeVar::coord */

dim()

template<class coordtype >

int chomp::homology::tCubeVar< coordtype >::dim

inline

Returns the dimension of the cube.

Definition at line 233 of file cubevar.h.

{
        return tab ? *tab : 0;
} /* tCubeVar::dim */

hashkey1()

template<class coordtype >

int_t chomp::homology::tCubeVar< coordtype >::hashkey1

inline

Returns hashing key no. 1 required by the hashing set template.

Definition at line 260 of file cubevar.h.

{
        int d = dim ();
        switch (d)
        {
        case 0:
                return 0;
        case 1:
                return static_cast<int_t> (tab [0]) << 12;
        case 2:
                return ((static_cast<int_t> (tab [0])) << 18) +
                        ((static_cast<int_t> (tab [1])) << 6);
        default:
                return ((static_cast<int_t> (tab [0])) << 18) +
                        ((static_cast<int_t> (tab [1])) << 6) +
                        ((static_cast<int_t> (tab [2])) >> 6);
        }
} /* tCubeVar::hashkey1 */

hashkey2()

template<class coordtype >

int_t chomp::homology::tCubeVar< coordtype >::hashkey2

inline

Returns hashing key no. 2 required by the hashing set template.

Definition at line 286 of file cubevar.h.

{
        int d = dim ();
        switch (d)
        {
        case 0:
                return 1;
        case 1:
                return static_cast<int_t> (tab [0]) << 3;
        case 2:
                return (static_cast<int_t> (tab [0]) >> 1) +
                        (static_cast<int_t> (tab [1]) << 13);
        default:
                return ((static_cast<int_t> (tab [d - 1])) << 20) +
                        ((static_cast<int_t> (tab [d - 2])) << 9) +
                        ((static_cast<int_t> (tab [d - 3])) >> 1);
        }
} /* tCubeVar::hashkey2 */

initialize()

template<class coordtype >

coordtype * chomp::homology::tCubeVar< coordtype >::initialize ( int  dim )

inlineprivate

Initializes the data for a cube of a given dimension > 0.

Returns the pointer to the coordinates table (i.e. tab + 1).

Definition at line 154 of file cubevar.h.

{
        tab = new coordtype [d + 1];
        if (!tab)
                throw "Not enough memory for a cube.";
        *tab = d;
        return (tab + 1);
} /* tCubeVar::initialize */

name()

template<class coordtype >

const char * chomp::homology::tCubeVar< coordtype >::name

inlinestatic

Returns the name of the objects represented by this class.

Definition at line 312 of file cubevar.h.

{
        return "cube";
} /* tCubeVar::name */

operator=()

template<class coordtype >

tCubeVar< coordtype > & chomp::homology::tCubeVar< coordtype >::operator= ( const tCubeVar< coordtype > &  c )

inline

The assignment operator.

Definition at line 204 of file cubevar.h.

{
        if (dim () == c. dim ())
                copycoord (tab + 1, c. tab + 1, dim ());
        else
        {
                if (tab)
                        delete [] tab;
                if (c. dim ())
                {
                        initialize (c. dim ());
                        copycoord (tab + 1, c. tab + 1, c. dim ());
                }
                else
                        tab = NULL;
        }
        return *this;
} /* tCubeVar::operator = */

References chomp::homology::copycoord().

pluralname()

template<class coordtype >

const char * chomp::homology::tCubeVar< coordtype >::pluralname

inlinestatic

Returns the plural name of the objects represented by this class.

Definition at line 318 of file cubevar.h.

{
        return "cubes";
} /* tCubeVar::pluralname */

Friends And Related Function Documentation

operator==

template<class coordtype >

int operator== ( const tCubeVar< coordtype > &  c1, const tCubeVar< coordtype > &  c2  )

friend

The operator == for cubes.

Definition at line 127 of file cubevar.h.

        {
                if (!c1. tab)
                        return c2. tab ? false : true;
                if (!c2. tab)
                        return false;
                return thesame (c1. tab, c2. tab, c1. tab [0] + 1);
        } /* operator == */

tCellVar< coordtype >

template<class coordtype >

friend class tCellVar< coordtype >

friend

Definition at line 127 of file cubevar.h.

Member Data Documentation

MaxDim

template<class coordtype >

const int chomp::homology::tCubeVar< coordtype >::MaxDim = 50

static

The maximal dimension of a cube.

Definition at line 81 of file cubevar.h.

tab

template<class coordtype >

coordtype* chomp::homology::tCubeVar< coordtype >::tab

private

The table containing the coordinates of the cube, as well as its dimension (at tab [0]).

Definition at line 143 of file cubevar.h.

---

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

• chomp/cubes/cubevar.h