A generic class that computes an index pair given the isolating neighborhood and a means to compute the multivalued cubical map. More...

#include <indpair.h>

Public Types
typedef cubetype	CubeType
	The type of a cube. More...

typedef cubsettype	CubSetType
	The type of a set of cubes. More...

Public Member Functions
	IndexPair (const mapcomp &_theCubMap=mapcomp())
	The only allowed constructor. More...

int	add (const cubetype &q)
	Adds a cube to S. More...

int	dim () const
	Returns the dimension of the phase space. More...

int_t	countInv () const
	Returns the number of cubes in the isolating neighborhood. More...

const cubsettype &	getInv () const
	Returns the invariant part as a set of cubes. More...

int_t	countExit () const
	Returns the number of cubes in the exit set. More...

const cubsettype &	getExit () const
	Returns the exit set as a set of cubes. More...

template<class IntType >
int	getcube (int_t n, IntType *coord) const
	Retrieves the coordinates of the n-th cube. More...

int_t	imgcount (int_t n) const
	Returns the number of cubes in the image of the n-th cube (which is either in S, or in the exit set). More...

int_t	getimgcube (int_t n, int_t i) const
	Returns the number of the i-th cube in the image of the n-th cube. More...

int	compute ()
	Computes the map on the entire set S, adds the necessary cubes to the exit set, and also computes the map on the exit set, so that the entire information necessary to compute the index map on this index pair is obatined and stored within this object. More...

int	clear ()
	Clears the sets and the stored map. More...

Private Member Functions
int	addimage (int_t n, const cubsettype &img)
	Adds the image of the map computed on one cube. More...

Private Attributes
cubsettype	S
	The isolating neighborhood whose Conley index is computed. More...

cubsettype	exitSet
	The image of S without S. More...

cubsettype	outside
	Additional images of cubes from the exit set. More...

chomp::homology::mvmap< cubetype, cubetype >	F
	The multivalued cubical map that has been computed so far. More...

const mapcomp &	theCubMap
	The map object. More...

Detailed Description

template<class mapcomp, class cubetype = chomp::homology::cube, class cubsettype = chomp::homology::hashedset<cubetype>>
class IndexPair< mapcomp, cubetype, cubsettype >

A generic class that computes an index pair given the isolating neighborhood and a means to compute the multivalued cubical map.

Definition at line 103 of file indpair.h.

Member Typedef Documentation

◆ CubeType

template<class mapcomp , class cubetype = chomp::homology::cube, class cubsettype = chomp::homology::hashedset<cubetype>>

typedef cubetype IndexPair< mapcomp, cubetype, cubsettype >::CubeType

The type of a cube.

Definition at line 107 of file indpair.h.

◆ CubSetType

template<class mapcomp , class cubetype = chomp::homology::cube, class cubsettype = chomp::homology::hashedset<cubetype>>

typedef cubsettype IndexPair< mapcomp, cubetype, cubsettype >::CubSetType

The type of a set of cubes.

Definition at line 110 of file indpair.h.

Constructor & Destructor Documentation

◆ IndexPair()

template<class mapcomp , class cubetype , class cubsettype >

IndexPair< mapcomp, cubetype, cubsettype >::IndexPair ( const mapcomp & _theCubMap = mapcomp () )

inline

The only allowed constructor.

Definition at line 180 of file indpair.h.

Member Function Documentation

◆ add()

template<class mapcomp , class cubetype , class cubsettype >

int IndexPair< mapcomp, cubetype, cubsettype >::add ( const cubetype & q )

inline

Adds a cube to S.

Definition at line 353 of file indpair.h.

◆ addimage()

template<class mapcomp , class cubetype , class cubsettype >

int IndexPair< mapcomp, cubetype, cubsettype >::addimage	(	int_t	n,
		const cubsettype &	img
	)

inlineprivate

Adds the image of the map computed on one cube.

If the cube is in S, then the part of its image that sticks out of S is added to the exit set.

Definition at line 280 of file indpair.h.

References custom::difference::maxIndexPairSize.

◆ clear()

template<class mapcomp , class cubetype , class cubsettype >

int IndexPair< mapcomp, cubetype, cubsettype >::clear

inline

Clears the sets and the stored map.

Definition at line 363 of file indpair.h.

◆ compute()

template<class mapcomp , class cubetype , class cubsettype >

int IndexPair< mapcomp, cubetype, cubsettype >::compute

inline

Computes the map on the entire set S, adds the necessary cubes to the exit set, and also computes the map on the exit set, so that the entire information necessary to compute the index map on this index pair is obatined and stored within this object.

Definition at line 311 of file indpair.h.

References custom::difference::ignoreIsolationForConleyIndex.

◆ countExit()

template<class mapcomp , class cubetype , class cubsettype >

int_t IndexPair< mapcomp, cubetype, cubsettype >::countExit

inline

Returns the number of cubes in the exit set.

Definition at line 211 of file indpair.h.

◆ countInv()

template<class mapcomp , class cubetype , class cubsettype >

int_t IndexPair< mapcomp, cubetype, cubsettype >::countInv

inline

Returns the number of cubes in the isolating neighborhood.

Definition at line 198 of file indpair.h.

◆ dim()

template<class mapcomp , class cubetype , class cubsettype >

int IndexPair< mapcomp, cubetype, cubsettype >::dim

inline

Returns the dimension of the phase space.

Definition at line 187 of file indpair.h.

◆ getcube()

template<class mapcomp , class cubetype , class cubsettype >

template<class IntType >

int IndexPair< mapcomp, cubetype, cubsettype >::getcube	(	int_t	n,
		IntType *	coord
	)		const

inline

Retrieves the coordinates of the n-th cube.

Definition at line 225 of file indpair.h.

◆ getExit()

template<class mapcomp , class cubetype , class cubsettype >

const cubsettype & IndexPair< mapcomp, cubetype, cubsettype >::getExit

inline

Returns the exit set as a set of cubes.

Definition at line 217 of file indpair.h.

◆ getimgcube()

template<class mapcomp , class cubetype , class cubsettype >

int_t IndexPair< mapcomp, cubetype, cubsettype >::getimgcube	(	int_t	n,
		int_t	i
	)		const

inline

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

Definition at line 255 of file indpair.h.

◆ getInv()

template<class mapcomp , class cubetype , class cubsettype >

const cubsettype & IndexPair< mapcomp, cubetype, cubsettype >::getInv

inline

Returns the invariant part as a set of cubes.

Definition at line 204 of file indpair.h.

◆ imgcount()

template<class mapcomp , class cubetype , class cubsettype >

int_t IndexPair< mapcomp, cubetype, cubsettype >::imgcount ( int_t n ) const

inline

Returns the number of cubes in the image of the n-th cube (which is either in S, or in the exit set).

Definition at line 245 of file indpair.h.

Member Data Documentation

◆ exitSet

template<class mapcomp , class cubetype = chomp::homology::cube, class cubsettype = chomp::homology::hashedset<cubetype>>

cubsettype IndexPair< mapcomp, cubetype, cubsettype >::exitSet

private

The image of S without S.

Definition at line 159 of file indpair.h.

◆ F

template<class mapcomp , class cubetype = chomp::homology::cube, class cubsettype = chomp::homology::hashedset<cubetype>>

chomp::homology::mvmap<cubetype,cubetype> IndexPair< mapcomp, cubetype, cubsettype >::F

private

The multivalued cubical map that has been computed so far.

Definition at line 165 of file indpair.h.

◆ outside

template<class mapcomp , class cubetype = chomp::homology::cube, class cubsettype = chomp::homology::hashedset<cubetype>>

cubsettype IndexPair< mapcomp, cubetype, cubsettype >::outside

private

Additional images of cubes from the exit set.

Definition at line 162 of file indpair.h.

◆ S

template<class mapcomp , class cubetype = chomp::homology::cube, class cubsettype = chomp::homology::hashedset<cubetype>>

cubsettype IndexPair< mapcomp, cubetype, cubsettype >::S

private

The isolating neighborhood whose Conley index is computed.

Definition at line 156 of file indpair.h.

◆ theCubMap

template<class mapcomp , class cubetype = chomp::homology::cube, class cubsettype = chomp::homology::hashedset<cubetype>>

const mapcomp& IndexPair< mapcomp, cubetype, cubsettype >::theCubMap

private

The map object.

Definition at line 168 of file indpair.h.

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

indpair.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ CubeType

◆ CubSetType

Constructor & Destructor Documentation

◆ IndexPair()

Member Function Documentation

◆ add()

◆ addimage()

◆ clear()

◆ compute()

◆ countExit()

◆ countInv()

◆ dim()

◆ getcube()

◆ getExit()

◆ getimgcube()

◆ getInv()

◆ imgcount()

Member Data Documentation

◆ exitSet

◆ F

◆ outside

◆ S

◆ theCubMap