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

This class can be used for iterating point's neighbors. More...

#include <pointset.h>

Public Member Functions
	tNeighbors (const coordtype *_source=NULL, int _dim=0, const coordtype *_wrap=NULL)
	The only possible constructor for new objects. More...
	tNeighbors (const tNeighbors< coordtype > &r)
	The copy constructor. More...
tNeighbors &	operator= (const tNeighbors< coordtype > &r)
	The assignment operator. More...
	~tNeighbors ()
	The destructor. More...
coordtype *	get ()
	Returns the next neighbor. More...
void	reset ()
	Resets the neighbors to the first one. More...
void	set (coordtype *_source)
	Redefines the source (and doesn't change other variables). More...

Private Member Functions
void	initialize (const coordtype *_source=NULL, int _dim=0, const coordtype *_wrap=NULL)
	Initializes the internal data of an object of this class. More...
void	deallocate ()
	Deallocates any memory previously allocated for this object. More...

Private Attributes
int	dim
	The dimension of the space. More...
const coordtype *	source
	A pointer to the source point (not allocated!). More...
coordtype *	neighbor
	The coordinates of a created neighbor. More...
signed char *	counters
	The current counters. More...
const coordtype *	wrap
	The space wrapping (if needed). More...

Detailed Description

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

This class can be used for iterating point's neighbors.

The source point must exist all the time you use this structure for this point.

Definition at line 1449 of file pointset.h.

Constructor & Destructor Documentation

tNeighbors() [1/2]

template<class coordtype >

chomp::homology::tNeighbors< coordtype >::tNeighbors	(	const coordtype *	_source = NULL,
		int	_dim = 0,
		const coordtype *	_wrap = NULL
	)

The only possible constructor for new objects.

Definition at line 1525 of file pointset.h.

{
        initialize (_source, _dim, _wrap);
        return;
} /* tNeighbors::tNeighbors */

tNeighbors() [2/2]

template<class coordtype >

chomp::homology::tNeighbors< coordtype >::tNeighbors

(

const tNeighbors< coordtype > &

r

)

The copy constructor.

Definition at line 1533 of file pointset.h.

{
        initialize (n. source, n. dim, n. wrap);
        return;
} /* tNeighbors::tNeighbors */

~tNeighbors()

template<class coordtype >

chomp::homology::tNeighbors< coordtype >::~tNeighbors< coordtype >

The destructor.

Definition at line 1549 of file pointset.h.

{
        deallocate ();
        return;
} /* tNeighbors::~tNeighbors */

Member Function Documentation

deallocate()

template<class coordtype >

void chomp::homology::tNeighbors< coordtype >::deallocate

private

Deallocates any memory previously allocated for this object.

Definition at line 1549 of file pointset.h.

{
        if (neighbor)
                delete [] neighbor;
        if (counters)
                delete [] counters;
        return;
} /* tNeighbors::deallocate */

get()

template<class coordtype >

coordtype * chomp::homology::tNeighbors< coordtype >::get

Returns the next neighbor.

If no more neighbors are available then returns 0 and rewinds to the first neighbor.

Definition at line 1584 of file pointset.h.

{
        // if the initialization was incorrect, return NULL
        if (!dim || !counters || !neighbor || !source)
                return NULL;
 
        // compute the next set of counters
        // and return NULL if this is the end
        int cur = 0;
        while ((cur < dim) && (counters [cur] == -1))
                counters [cur ++] = 0;
        if (cur >= dim)
                return NULL;
        counters [cur] = counters [cur] ?
                (signed char) -1 : (signed char) 1;
 
        // compute the neighbor corresponding to these counters
        for (int i = 0; i < dim; ++ i)
                neighbor [i] = (coordtype) (source [i] + counters [i]);
 
        // wrap the neighbor's coordinates if required
        if (wrap)
                wrapcoord (neighbor, neighbor, wrap, dim);
 
        // return the neighbor's coordinates
        return neighbor;
 
} /* tNeighbors::get */

References chomp::homology::wrapcoord().

initialize()

template<class coordtype >

void chomp::homology::tNeighbors< coordtype >::initialize ( const coordtype *  _source = NULL, int  _dim = 0, const coordtype *  _wrap = NULL  )

private

Initializes the internal data of an object of this class.

Definition at line 1503 of file pointset.h.

{
        source = _source;
        wrap = _wrap;
        dim = _dim;
        if (dim <= 0)
        {
                dim = 0;
                neighbor = NULL;
                counters = NULL;
                return;
        }
        neighbor = new coordtype [dim];
        counters = new signed char [dim];
        if (!neighbor || !counters)
                throw "Can't allocate memory for neighbors.";
        reset ();
        return;
} /* tNeighbors::initialize */

operator=()

template<class coordtype >

tNeighbors< coordtype > & chomp::homology::tNeighbors< coordtype >::operator=

(

const tNeighbors< coordtype > &

r

)

The assignment operator.

Definition at line 1540 of file pointset.h.

{
        deallocate ();
        initialize (n. source, n. dim, n. wrap);
        return *this;
} /* tNeighbors::operator = */

reset()

template<class coordtype >

void chomp::homology::tNeighbors< coordtype >::reset

(

void

)

Resets the neighbors to the first one.

Definition at line 1566 of file pointset.h.

{
        if (counters)
        {
                for (int i = 0; i < dim; ++ i)
                        counters [i] = 0;
        }
        return;
} /* tNeighbors::reset */

set()

template<class coordtype >

void chomp::homology::tNeighbors< coordtype >::set

(

coordtype *

_source

)

Redefines the source (and doesn't change other variables).

Definition at line 1577 of file pointset.h.

{
        source = _source;
        return;
} /* tNeighbors::set */

Member Data Documentation

counters

template<class coordtype >

signed char* chomp::homology::tNeighbors< coordtype >::counters

private

The current counters.

Definition at line 1486 of file pointset.h.

dim

template<class coordtype >

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

private

The dimension of the space.

Definition at line 1477 of file pointset.h.

neighbor

template<class coordtype >

coordtype* chomp::homology::tNeighbors< coordtype >::neighbor

private

The coordinates of a created neighbor.

Definition at line 1483 of file pointset.h.

source

template<class coordtype >

const coordtype* chomp::homology::tNeighbors< coordtype >::source

private

A pointer to the source point (not allocated!).

Definition at line 1480 of file pointset.h.

wrap

template<class coordtype >

const coordtype* chomp::homology::tNeighbors< coordtype >::wrap

private

The space wrapping (if needed).

Definition at line 1489 of file pointset.h.

---

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

• chomp/cubes/pointset.h