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

#include <cubebase.h>

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

typedef tCellBase< coordtype >	CellType
	The type of a cell related to this cube type. More...

typedef tPointBase< coordtype >	PointBase
	The point base (for wrapping and tabulating coordinates). More...

Public Member Functions
	tCubeBase ()
	The default constructor. More...

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

	tCubeBase (int_t number, int dim)
	The constructor of a cube from a number (should be used with caution). More...

	tCubeBase (const tCubeBase< coordtype > &c)
	The copy constructor. More...

tCubeBase< coordtype > &	operator= (const tCubeBase< 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 = MaxBasDim
	The maximal dimension of a cube. More...

Private Member Functions
int_t	num () const
	Returns the actual number of the cube in the point base. More...

Private Attributes
int_t	n
	The number that represents the full cube. More...

Friends
class	tCellBase< coordtype >

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

Detailed Description

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

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

This implementation uses a cube base class for indexing all the possible coordinate combinations that appear in the program.

Definition at line 71 of file cubebase.h.

Member Typedef Documentation

◆ CellType

template<class coordtype >

typedef tCellBase<coordtype> chomp::homology::tCubeBase< coordtype >::CellType

The type of a cell related to this cube type.

Definition at line 78 of file cubebase.h.

◆ CoordType

template<class coordtype >

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

The type of coordinates of a cube.

Definition at line 75 of file cubebase.h.

◆ PointBase

template<class coordtype >

typedef tPointBase<coordtype> chomp::homology::tCubeBase< coordtype >::PointBase

The point base (for wrapping and tabulating coordinates).

Definition at line 84 of file cubebase.h.

Constructor & Destructor Documentation

◆ tCubeBase() [1/4]

template<class coordtype >

chomp::homology::tCubeBase< coordtype >::tCubeBase

inline

The default constructor.

Definition at line 157 of file cubebase.h.

: n (0)
{
        return;
} /* tCubeBase::tCubeBase */

◆ tCubeBase() [2/4]

template<class coordtype >

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

inline

The constructor of a cube from a table of coordinates.

Definition at line 164 of file cubebase.h.

{
        if (dim <= 0)
                throw "Non-positive dimension of a cube.";
        if (dim >= MaxDim)
                throw "Too high space dimension.";
        n = PointBase::number (c, dim);
        if (n < 0)
                throw "Negative number of a cube.";
        n |= (static_cast<int_t> (dim) << NumBits);
        return;
} /* tCubeBase::tCubeBase */

References chomp::homology::tPointBase< coordtype >::number(), and chomp::homology::NumBits.

◆ tCubeBase() [3/4]

template<class coordtype >

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

inline

The constructor of a cube from a number (should be used with caution).

Definition at line 179 of file cubebase.h.

{
        n = number | (static_cast<int_t> (dim) << NumBits);
        return;
} /* tCubeBase::tCubeBase */

References chomp::homology::NumBits.

◆ tCubeBase() [4/4]

template<class coordtype >

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

inline

The copy constructor.

Definition at line 186 of file cubebase.h.

{
        n = c. n;
        return;
} /* tCubeBase::tCubeBase */

Member Function Documentation

◆ coord()

template<class coordtype >

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

inline

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

Definition at line 218 of file cubebase.h.

{
        int d = dim ();
        const coordtype *tab = PointBase::coord (num (), d);
        for (int i = 0; i < d; ++ i)
                c [i] = tab [i];
        return c;
} /* tCubeBase::coord */

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

◆ dim()

template<class coordtype >

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

inline

Returns the dimension of the cube.

Definition at line 201 of file cubebase.h.

{
        return static_cast<int> (n >> NumBits);
} /* tCubeBase::dim */

References chomp::homology::NumBits.

◆ hashkey1()

template<class coordtype >

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

inline

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

Definition at line 228 of file cubebase.h.

{
        return static_cast<int_t>
                (((n ^ 0x55555555u) << 17) ^ ((n ^ 0xAA00AA00u) << 7) ^
                ((n ^ 0x00AA00AAu) >> 7));
} /* tCubeBase::hashkey1 */

◆ hashkey2()

template<class coordtype >

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

inline

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

Definition at line 242 of file cubebase.h.

{
        return static_cast<int_t>
                (((n ^ 0xAAAAAAAAu) << 18) ^ ((n ^ 0x55005500u) >> 8) ^
                ((n ^ 0x00550055u) << 10));
} /* tCubeBase::hashkey2 */

◆ name()

template<class coordtype >

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

inlinestatic

Returns the name of the objects represented by this class.

Definition at line 256 of file cubebase.h.

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

◆ num()

template<class coordtype >

int_t chomp::homology::tCubeBase< coordtype >::num

inlineprivate

Returns the actual number of the cube in the point base.

Definition at line 149 of file cubebase.h.

{
        return (n & NumMask);
} /* tCubeBase::num */

References chomp::homology::NumMask.

◆ operator=()

template<class coordtype >

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

inline

The assignment operator.

Definition at line 193 of file cubebase.h.

{
        n = c. n;
        return *this;
} /* tCubeBase::operator = */

◆ pluralname()

template<class coordtype >

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

inlinestatic

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

Definition at line 262 of file cubebase.h.

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

Referenced by chomp::homology::readelements(), and chomp::homology::saveelements().

Friends And Related Function Documentation

◆ operator==

template<class coordtype >

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

friend

The operator == for cubes.

Definition at line 126 of file cubebase.h.

        {
                return c1. n == c2. n;
        } /* operator == */

◆ tCellBase< coordtype >

template<class coordtype >

friend class tCellBase< coordtype >

friend

Definition at line 126 of file cubebase.h.

Member Data Documentation

◆ MaxDim

template<class coordtype >

const int chomp::homology::tCubeBase< coordtype >::MaxDim = MaxBasDim

static

The maximal dimension of a cube.

Definition at line 81 of file cubebase.h.

Referenced by chomp::homology::ComputeBettiNumbers(), chomp::homengin::PPengine::dimsupported(), and chomp::homology::SetSpaceWrapping().

◆ n

template<class coordtype >

int_t chomp::homology::tCubeBase< coordtype >::n

private

The number that represents the full cube.

High bits keep the space dimension, the remaining bits form the number of the cube in an appropriate pointset.

Definition at line 142 of file cubebase.h.

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

chomp/cubes/cubebase.h

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ CellType

◆ CoordType

◆ PointBase

Constructor & Destructor Documentation

◆ tCubeBase() [1/4]

◆ tCubeBase() [2/4]

◆ tCubeBase() [3/4]

◆ tCubeBase() [4/4]

Member Function Documentation

◆ coord()

◆ dim()

◆ hashkey1()

◆ hashkey2()

◆ name()

◆ num()

◆ operator=()

◆ pluralname()

Friends And Related Function Documentation

◆ operator==

◆ tCellBase< coordtype >

Member Data Documentation

◆ MaxDim

◆ n