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

#include <cubefix.h>

Public Types
typedef coordtype	CoordType
	The type of coordinates of a cube. More...

typedef tCellFix< dimfix, 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
	tCubeFix ()
	The default constructor. More...

	tCubeFix (const coordtype *c, int dim=0)
	The constructor of a cube from a table of coordinates. More...

	tCubeFix (int number, int dim)
	The constructor of a cube from a number (invalid in this class). More...

	tCubeFix (const tCubeFix< dimfix, coordtype > &c)
	The copy constructor. More...

tCubeFix< dimfix, coordtype > &	operator= (const tCubeFix< dimfix, coordtype > &c)
	The assignment operator. 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 = 512
	The maximal dimension of a cube (unused). More...

Private Attributes
coordtype	tab [dimfix]
	A table with the coordinates of the minimal vertex of the cube. More...

Friends
class	tCellFix< dimfix, coordtype >

int	operator== (const tCubeFix< dimfix, coordtype > &c1, const tCubeFix< dimfix, coordtype > &c2)
	The operator == for cubes. More...

Detailed Description

template<int dimfix, class coordtype>
class chomp::homology::tCubeFix< dimfix, coordtype >

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

This implementation assumes that the embedding space dimension is known at time of compilation.

Definition at line 71 of file cubefix.h.

Member Typedef Documentation

◆ CellType

template<int dimfix, class coordtype >

typedef tCellFix<dimfix,coordtype> chomp::homology::tCubeFix< dimfix, coordtype >::CellType

The type of a cell related to this cube type.

Definition at line 78 of file cubefix.h.

◆ CoordType

template<int dimfix, class coordtype >

typedef coordtype chomp::homology::tCubeFix< dimfix, coordtype >::CoordType

The type of coordinates of a cube.

Definition at line 75 of file cubefix.h.

◆ PointBase

template<int dimfix, class coordtype >

typedef tWrapBase<coordtype> chomp::homology::tCubeFix< dimfix, coordtype >::PointBase

The point base (for wrapping and tabulating coordinates).

Definition at line 84 of file cubefix.h.

Constructor & Destructor Documentation

◆ tCubeFix() [1/4]

template<int dimfix, class coordtype >

chomp::homology::tCubeFix< dimfix, coordtype >::tCubeFix

inline

The default constructor.

Definition at line 141 of file cubefix.h.

{
        return;
} /* tCubeFix::tCubeFix */

◆ tCubeFix() [2/4]

template<int dimfix, class coordtype >

chomp::homology::tCubeFix< dimfix, coordtype >::tCubeFix	(	const coordtype *	c,
		int	dim = `0`
	)

inline

The constructor of a cube from a table of coordinates.

Definition at line 147 of file cubefix.h.

{
        if (dim && ((dim != dimfix) || (dim < 0)))
                throw "Wrong dimension of a fixed-dim cube.";
        PointBase::wrapcopy (tab, c, dimfix);
        return;
} /* tCubeFix::tCubeFix */

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

◆ tCubeFix() [3/4]

template<int dimfix, class coordtype >

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

inline

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

Definition at line 157 of file cubefix.h.

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

◆ tCubeFix() [4/4]

template<int dimfix, class coordtype >

chomp::homology::tCubeFix< dimfix, coordtype >::tCubeFix ( const tCubeFix< dimfix, coordtype > & c )

inline

The copy constructor.

Definition at line 163 of file cubefix.h.

{
        for (int i = 0; i < dimfix; ++ i)
                tab [i] = c. tab [i];
        return;
} /* tCubeFix::tCubeFix */

Member Function Documentation

◆ coord()

template<int dimfix, class coordtype >

coordtype * chomp::homology::tCubeFix< dimfix, coordtype >::coord ( coordtype * c ) const

inline

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

Definition at line 196 of file cubefix.h.

{
        for (int i = 0; i < dimfix; ++ i)
                c [i] = tab [i];
        return c;
} /* tCubeFix::coord */

◆ dim()

template<int dimfix, class coordtype >

int chomp::homology::tCubeFix< dimfix, coordtype >::dim

inline

Returns the dimension of the cube.

Definition at line 181 of file cubefix.h.

{
        return dimfix;
} /* tCubeFix::dim */

◆ hashkey1()

template<int dimfix, class coordtype >

int_t chomp::homology::tCubeFix< dimfix, coordtype >::hashkey1

inline

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

Definition at line 204 of file cubefix.h.

{
        switch (dimfix)
        {
        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);
        }
} /* tCubeFix::hashkey1 */

◆ hashkey2()

template<int dimfix, class coordtype >

int_t chomp::homology::tCubeFix< dimfix, coordtype >::hashkey2

inline

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

Definition at line 227 of file cubefix.h.

{
        switch (dimfix)
        {
        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 [dimfix - 1])) << 20) +
                        ((static_cast<int_t> (tab [dimfix - 2])) << 9) +
                        ((static_cast<int_t> (tab [dimfix - 3])) >> 1);
        }
} /* tCubeFix::hashkey2 */

◆ name()

template<int dimfix, class coordtype >

const char * chomp::homology::tCubeFix< dimfix, coordtype >::name

static

Returns the name of the objects represented by this class.

Definition at line 250 of file cubefix.h.

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

◆ operator=()

template<int dimfix, class coordtype >

tCubeFix< dimfix, coordtype > & chomp::homology::tCubeFix< dimfix, coordtype >::operator= ( const tCubeFix< dimfix, coordtype > & c )

inline

The assignment operator.

Definition at line 172 of file cubefix.h.

{
        for (int i = 0; i < dimfix; ++ i)
                tab [i] = c. tab [i];
        return *this;
} /* tCubeFix::operator = */

◆ pluralname()

template<int dimfix, class coordtype >

const char * chomp::homology::tCubeFix< dimfix, coordtype >::pluralname

static

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

Definition at line 256 of file cubefix.h.

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

Friends And Related Function Documentation

◆ operator==

template<int dimfix, class coordtype >

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

friend

The operator == for cubes.

Definition at line 123 of file cubefix.h.

        {
                return thesame (c1. tab, c2. tab, dimfix);
        }

◆ tCellFix< dimfix, coordtype >

template<int dimfix, class coordtype >

friend class tCellFix< dimfix, coordtype >

friend

Definition at line 123 of file cubefix.h.

Member Data Documentation

◆ MaxDim

template<int dimfix, class coordtype >

const int chomp::homology::tCubeFix< dimfix, coordtype >::MaxDim = 512

static

The maximal dimension of a cube (unused).

Definition at line 81 of file cubefix.h.

◆ tab

template<int dimfix, class coordtype >

coordtype chomp::homology::tCubeFix< dimfix, coordtype >::tab[dimfix]

private

A table with the coordinates of the minimal vertex of the cube.

Definition at line 134 of file cubefix.h.

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

chomp/cubes/cubefix.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ CellType

◆ CoordType

◆ PointBase

Constructor & Destructor Documentation

◆ tCubeFix() [1/4]

◆ tCubeFix() [2/4]

◆ tCubeFix() [3/4]

◆ tCubeFix() [4/4]

Member Function Documentation

◆ coord()

◆ dim()

◆ hashkey1()

◆ hashkey2()

◆ name()

◆ operator=()

◆ pluralname()

Friends And Related Function Documentation

◆ operator==

◆ tCellFix< dimfix, coordtype >

Member Data Documentation

◆ MaxDim

◆ tab