chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator Class Reference

The neighborhood of a cube. More...

#include <bincube.h>

Inheritance diagram for chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator:

Public Member Functions
	neighborhood_iterator (bincube< Dim, twoPower > *bcub=0, int n=-1, int inicur=-1)
	The default constructor. More...
neighborhood_iterator &	operator++ ()
	The preincrement operator. More...
neighborhood_iterator &	operator++ (int)
	The postincrement operator. More...
	operator int () const
	Conversion to the number of the neighbor cube (temp!). More...
Public Member Functions inherited from chomp::homology::bincube< Dim, twoPower >::iterator
	iterator (bincube< Dim, twoPower > *bcub=0, int num=-1)
	The default constructor. More...
iterator &	operator++ ()
	The preincrement operator. More...
iterator &	operator++ (int)
	The postincrement operator. More...
	operator int () const
	Conversion of an iterator to int (temporarily). More...
const int *	coord () const
	The coordinates of the cube. More...
template<class intType >
intType *	coord (intType *tab) const
	The coordinates of the cube. More...

Protected Attributes
bincube< Dim, twoPower > *	b
	Conversion to a cube iterator. More...
int	coord [Dim]
	The coordinates of the middle cube in the neighborhood. More...
int	ncoord [Dim]
	The coordinates of the current neighbor. More...
int	curnum
	The number of the current neighbor in the binary cube. More...
int	cur
	The neighbor counter (up to max_neighbors). More...

Additional Inherited Members
Public Types inherited from chomp::homology::bincube< Dim, twoPower >::iterator
typedef int	CoordType
	The type of coordinates. More...
Static Public Member Functions inherited from chomp::homology::bincube< Dim, twoPower >::iterator
static int	dim ()
	The dimension of the cube. More...
Public Attributes inherited from chomp::homology::bincube< Dim, twoPower >::iterator
bincube< Dim, twoPower > *	b
	The binary cube in which the cube is contained. More...
int	n
	The number of the current bit in the set. More...
Static Public Attributes inherited from chomp::homology::bincube< Dim, twoPower >::iterator
static const int	MaxDim = Dim
	The maximal possible dimension of the cube. More...

Detailed Description

template<int Dim, int twoPower>
class chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator

The neighborhood of a cube.

Definition at line 203 of file bincube.h.

Constructor & Destructor Documentation

neighborhood_iterator()

template<int Dim, int twoPower>

chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator::neighborhood_iterator ( bincube< Dim, twoPower > *  bcub = 0, int  n = -1, int  inicur = -1  )

inline

The default constructor.

Definition at line 715 of file bincube.h.

                                                          :
        b (bcub), curnum (-1), cur (inicur)
{
        if (b && (num >= 0))
                b -> num2coord (num, coord);
        else
        {
                // this zeroing operation is to avoid a compilation warning,
                // probably it is not necessary
                for (int i = 0; i < Dim; ++ i)
                        coord [i] = 0;
        }
        if (num == bincube<Dim,twoPower>::max_neighbors)
        {
                for (int i = 0; i < Dim; ++ i)
                        ncoord [i] = 0;
        }
        return;
} /* bincube::neighborhood_iterator::neighborhood_iterator */

References chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator::b, chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator::coord, chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator::ncoord, and chomp::homology::bincube< Dim, twoPower >::num2coord().

Member Function Documentation

operator int()

template<int Dim, int twoPower>

chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator::operator int

inline

Conversion to the number of the neighbor cube (temp!).

Definition at line 778 of file bincube.h.

{
        return curnum;
} /* bincube::neighborhood_iterator::operator int */

operator++() [1/2]

template<int Dim, int twoPower>

bincube< Dim, twoPower >::neighborhood_iterator & chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator::operator++

inline

The preincrement operator.

Searches for the next cube in the neighborhood.

Definition at line 738 of file bincube.h.

{
        if (!b || (cur >= bincube<Dim,twoPower>::max_neighbors))
                return *this;
        while (1)
        {
                ++ cur;
                if (cur >= bincube<Dim,twoPower>::max_neighbors)
                {
                        for (int i = 0; i < Dim; ++ i)
                                ncoord [i] = 0;
                        curnum = -1;
                        return *this;
                }
                bit2neighborAlg (cur, coord, ncoord, Dim);
                try
                {
                        curnum = b -> coord2num (ncoord);
                        if (b -> check (curnum))
                                return *this;
                }
                catch (...)
                {
                }
        }
        return *this;
} /* bincube::iterator::operator ++ */

References chomp::homology::bit2neighborAlg(), chomp::homology::bincube< Dim, twoPower >::check(), and chomp::homology::bincube< Dim, twoPower >::coord2num().

operator++() [2/2]

template<int Dim, int twoPower>

bincube< Dim, twoPower >::neighborhood_iterator & chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator::operator++ ( int  )

inline

The postincrement operator.

Definition at line 768 of file bincube.h.

{
        if (!b || (cur >= bincube<Dim,twoPower>::maxcount))
                return *this;
        neighborhood_iterator prev = *this;
        ++ (*this);
        return prev;
} /* bincube::neighborhood_iterator::operator ++ */

Member Data Documentation

b

template<int Dim, int twoPower>

bincube<Dim,twoPower>* chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator::b

protected

Conversion to a cube iterator.

Operator == to compare two neighborhood iterators. The binary cube in which the neighborhood is contained.

Definition at line 230 of file bincube.h.

Referenced by chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator::neighborhood_iterator().

coord

template<int Dim, int twoPower>

int chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator::coord[Dim]

protected

The coordinates of the middle cube in the neighborhood.

Definition at line 233 of file bincube.h.

Referenced by chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator::neighborhood_iterator().

cur

template<int Dim, int twoPower>

int chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator::cur

protected

The neighbor counter (up to max_neighbors).

Definition at line 242 of file bincube.h.

curnum

template<int Dim, int twoPower>

int chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator::curnum

protected

The number of the current neighbor in the binary cube.

Definition at line 239 of file bincube.h.

ncoord

template<int Dim, int twoPower>

int chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator::ncoord[Dim]

protected

The coordinates of the current neighbor.

Definition at line 236 of file bincube.h.

Referenced by chomp::homology::bincube< Dim, twoPower >::neighborhood_iterator::neighborhood_iterator().

---

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

• chomp/cubes/bincube.h