IndexPair< mapcomp, cubetype, cubsettype > Class Template Reference

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

#include <conindex.h>

List of all members.

Public Member Functions

 IndexPair (const mapcomp &_M=mapcomp())
 The only allowed constructor.
int add (const cubetype &q)
 Adds a cube to S.
int dim () const
 Returns the dimension of the phase space.
int countInv () const
 Returns the number of cubes in the isolating neighborhood.
const cubsettype & getInv () const
 Returns the invariant part as a set of cubes.
int countExit () const
 Returns the number of cubes in the exit set.
const cubsettype & getExit () const
 Returns the exit set as a set of cubes.
int getcube (int n, int *coord) const
 Retrieves the coordinates of the n-th cube.
int imgcount (int 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).
int getimgcube (int n, int i) const
 Returns the number of the i-th cube in the image of the n-th cube.
int compute (int n)
 Computes the map on one cube.
int compute ()
 Computes the map on the entire set S, and also on the exit set, so that the whole information necessary to compute the index map on this index pair is obatined and stored within this object.
int clear ()
 Clears the sets and the stored map.

Private Attributes

cubsettype S
 The isolating neighborhood whose Conley index is computed.
cubsettype exitSet
 The image of S without S.
cubsettype outside
 Additional images of cubes fromthe exit set.
chomp::homology::mvmap
< cubetype, cubetype > 
F
 The multivalued cubical map that has been computed so far.
const mapcomp & M
 The map object.


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 434 of file conindex.h.


Constructor & Destructor Documentation

template<class mapcomp, class cubetype, class cubsettype>
IndexPair< mapcomp, cubetype, cubsettype >::IndexPair ( const mapcomp &  _M = mapcomp ()  )  [inline]

The only allowed constructor.

Definition at line 502 of file conindex.h.


Member Function Documentation

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 650 of file conindex.h.

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

Referenced by IndexPair< mapcomp, cubetype, cubsettype >::compute().

template<class mapcomp, class cubetype, class cubsettype>
int IndexPair< mapcomp, cubetype, cubsettype >::dim (  )  const [inline]

Returns the dimension of the phase space.

Definition at line 508 of file conindex.h.

References IndexPair< mapcomp, cubetype, cubsettype >::exitSet, and IndexPair< mapcomp, cubetype, cubsettype >::S.

template<class mapcomp, class cubetype, class cubsettype>
int IndexPair< mapcomp, cubetype, cubsettype >::countInv (  )  const [inline]

Returns the number of cubes in the isolating neighborhood.

Definition at line 519 of file conindex.h.

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

template<class mapcomp, class cubetype, class cubsettype>
const cubsettype & IndexPair< mapcomp, cubetype, cubsettype >::getInv (  )  const [inline]

Returns the invariant part as a set of cubes.

Definition at line 525 of file conindex.h.

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

template<class mapcomp, class cubetype, class cubsettype>
int IndexPair< mapcomp, cubetype, cubsettype >::countExit (  )  const [inline]

Returns the number of cubes in the exit set.

Definition at line 532 of file conindex.h.

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

Referenced by IndexPair< mapcomp, cubetype, cubsettype >::getcube(), and IndexPair< mapcomp, cubetype, cubsettype >::getimgcube().

template<class mapcomp, class cubetype, class cubsettype>
const cubsettype & IndexPair< mapcomp, cubetype, cubsettype >::getExit (  )  const [inline]

Returns the exit set as a set of cubes.

Definition at line 538 of file conindex.h.

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

template<class mapcomp, class cubetype, class cubsettype>
int IndexPair< mapcomp, cubetype, cubsettype >::getcube ( int  n,
int *  coord 
) const [inline]

Retrieves the coordinates of the n-th cube.

Definition at line 546 of file conindex.h.

References IndexPair< mapcomp, cubetype, cubsettype >::countExit(), IndexPair< mapcomp, cubetype, cubsettype >::exitSet, IndexPair< mapcomp, cubetype, cubsettype >::outside, and IndexPair< mapcomp, cubetype, cubsettype >::S.

template<class mapcomp, class cubetype, class cubsettype>
int IndexPair< mapcomp, cubetype, cubsettype >::imgcount ( int  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 565 of file conindex.h.

References IndexPair< mapcomp, cubetype, cubsettype >::exitSet, IndexPair< mapcomp, cubetype, cubsettype >::F, and IndexPair< mapcomp, cubetype, cubsettype >::S.

template<class mapcomp, class cubetype, class cubsettype>
int IndexPair< mapcomp, cubetype, cubsettype >::getimgcube ( int  n,
int  i 
) const [inline]

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

Definition at line 576 of file conindex.h.

References IndexPair< mapcomp, cubetype, cubsettype >::countExit(), IndexPair< mapcomp, cubetype, cubsettype >::exitSet, IndexPair< mapcomp, cubetype, cubsettype >::F, IndexPair< mapcomp, cubetype, cubsettype >::outside, and IndexPair< mapcomp, cubetype, cubsettype >::S.

template<class mapcomp, class cubetype, class cubsettype>
int IndexPair< mapcomp, cubetype, cubsettype >::compute ( int  n  )  [inline]

Computes the map on one cube.

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

Definition at line 600 of file conindex.h.

References IndexPair< mapcomp, cubetype, cubsettype >::add(), IndexPair< mapcomp, cubetype, cubsettype >::exitSet, IndexPair< mapcomp, cubetype, cubsettype >::F, IndexPair< mapcomp, cubetype, cubsettype >::M, custom::limits2d::maxIndexPairSize, IndexPair< mapcomp, cubetype, cubsettype >::outside, and IndexPair< mapcomp, cubetype, cubsettype >::S.

template<class mapcomp, class cubetype, class cubsettype>
int IndexPair< mapcomp, cubetype, cubsettype >::compute (  )  [inline]

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

Definition at line 633 of file conindex.h.

References IndexPair< mapcomp, cubetype, cubsettype >::exitSet, IndexPair< mapcomp, cubetype, cubsettype >::outside, and IndexPair< mapcomp, cubetype, cubsettype >::S.

template<class mapcomp, class cubetype, class cubsettype>
int IndexPair< mapcomp, cubetype, cubsettype >::clear (  )  [inline]

Clears the sets and the stored map.

Definition at line 660 of file conindex.h.

References IndexPair< mapcomp, cubetype, cubsettype >::exitSet, IndexPair< mapcomp, cubetype, cubsettype >::F, IndexPair< mapcomp, cubetype, cubsettype >::outside, and IndexPair< mapcomp, cubetype, cubsettype >::S.


Member Data Documentation

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 482 of file conindex.h.

Referenced by IndexPair< mapcomp, cubetype, cubsettype >::add(), IndexPair< mapcomp, cubetype, cubsettype >::clear(), IndexPair< mapcomp, cubetype, cubsettype >::compute(), IndexPair< mapcomp, cubetype, cubsettype >::countInv(), IndexPair< mapcomp, cubetype, cubsettype >::dim(), IndexPair< mapcomp, cubetype, cubsettype >::getcube(), IndexPair< mapcomp, cubetype, cubsettype >::getimgcube(), IndexPair< mapcomp, cubetype, cubsettype >::getInv(), and IndexPair< mapcomp, cubetype, cubsettype >::imgcount().

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 485 of file conindex.h.

Referenced by IndexPair< mapcomp, cubetype, cubsettype >::clear(), IndexPair< mapcomp, cubetype, cubsettype >::compute(), IndexPair< mapcomp, cubetype, cubsettype >::countExit(), IndexPair< mapcomp, cubetype, cubsettype >::dim(), IndexPair< mapcomp, cubetype, cubsettype >::getcube(), IndexPair< mapcomp, cubetype, cubsettype >::getExit(), IndexPair< mapcomp, cubetype, cubsettype >::getimgcube(), and IndexPair< mapcomp, cubetype, cubsettype >::imgcount().

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 fromthe exit set.

Definition at line 488 of file conindex.h.

Referenced by IndexPair< mapcomp, cubetype, cubsettype >::clear(), IndexPair< mapcomp, cubetype, cubsettype >::compute(), IndexPair< mapcomp, cubetype, cubsettype >::getcube(), and IndexPair< mapcomp, cubetype, cubsettype >::getimgcube().

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 491 of file conindex.h.

Referenced by IndexPair< mapcomp, cubetype, cubsettype >::clear(), IndexPair< mapcomp, cubetype, cubsettype >::compute(), IndexPair< mapcomp, cubetype, cubsettype >::getimgcube(), and IndexPair< mapcomp, cubetype, cubsettype >::imgcount().

template<class mapcomp, class cubetype = chomp::homology::cube, class cubsettype = chomp::homology::hashedset<cubetype>>
const mapcomp& IndexPair< mapcomp, cubetype, cubsettype >::M [private]

The map object.

Definition at line 494 of file conindex.h.

Referenced by IndexPair< mapcomp, cubetype, cubsettype >::compute().


The documentation for this class was generated from the following file:
Generated on Sun Mar 28 17:47:58 2010 for The Conley-Morse Graphs Software by  doxygen 1.5.3