The Conley-Morse Graphs Software
Public Types | Public Member Functions | List of all members
EmptyIndexPair Class Reference

The empty index pair class simulates an empty index pair. More...

#include <indpair.h>

Public Types

typedef chomp::homology::Cube CubeType
 The type of a cube. More...
 
typedef chomp::homology::SetOfCubes CubSetType
 The type of a set of cubes. More...
 

Public Member Functions

int dim () const
 Returns the dimension of the underlying space. More...
 
int_t countInv () const
 Returns the number of cubes in the isolating neighborhood. More...
 
int_t countExit () const
 Returns the number of cubes in the exit set. More...
 
template<class IntType >
int getcube (int_t n, IntType *coord) const
 Returns the coordinates of the n-th cube (first Inv, then Exit, followed by outside). More...
 
int_t imgcount (int_t n) const
 Returns the number of cubes in the image of the n-th cube. More...
 
int_t getimgcube (int_t n, int_t i) const
 Returns the number of the n-th cube in the image. More...
 

Detailed Description

The empty index pair class simulates an empty index pair.

This is a general template for you to build an appropriate index pair. This might just be an interface to access an array of cubes in which the isolating neighborhood occupies the front of the array, and then cubes that form the exit set follow. Afterwards, all the other cubes that appear in the images of those two groups of cubes are listed.

Definition at line 66 of file indpair.h.

Member Typedef Documentation

◆ CubeType

typedef chomp::homology::Cube EmptyIndexPair::CubeType

The type of a cube.

Definition at line 70 of file indpair.h.

◆ CubSetType

typedef chomp::homology::SetOfCubes EmptyIndexPair::CubSetType

The type of a set of cubes.

Definition at line 73 of file indpair.h.

Member Function Documentation

◆ countExit()

int_t EmptyIndexPair::countExit ( ) const
inline

Returns the number of cubes in the exit set.

Definition at line 82 of file indpair.h.

◆ countInv()

int_t EmptyIndexPair::countInv ( ) const
inline

Returns the number of cubes in the isolating neighborhood.

Definition at line 79 of file indpair.h.

◆ dim()

int EmptyIndexPair::dim ( ) const
inline

Returns the dimension of the underlying space.

Definition at line 76 of file indpair.h.

◆ getcube()

template<class IntType >
int EmptyIndexPair::getcube ( int_t  n,
IntType *  coord 
) const
inline

Returns the coordinates of the n-th cube (first Inv, then Exit, followed by outside).

Definition at line 87 of file indpair.h.

◆ getimgcube()

int_t EmptyIndexPair::getimgcube ( int_t  n,
int_t  i 
) const
inline

Returns the number of the n-th cube in the image.

Definition at line 93 of file indpair.h.

◆ imgcount()

int_t EmptyIndexPair::imgcount ( int_t  n) const
inline

Returns the number of cubes in the image of the n-th cube.

Definition at line 90 of file indpair.h.


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