The Conley-Morse Graphs Software
Public Member Functions | Private Member Functions | Private Attributes | List of all members
IndexEigenValues Class Reference

Eigenvalues of the Conley index map gathered by levels. More...

#include <eigenval.h>

Public Member Functions

 IndexEigenValues ()
 The constructor of an empty object. More...
 
template<class ConleyIndexType >
 IndexEigenValues (const ConleyIndexType &index)
 The constructor of an object based on the given Conley index. More...
 
std::vector< double > & re (unsigned int level)
 Returns the vector of the real parts of the eigenvalues at the given level for appending. More...
 
const std::vector< double > & re (unsigned int level) const
 Returns the vector of the real parts of the eigenvalues at the given level for reading only. More...
 
std::vector< double > & im (unsigned int level)
 Returns the vector of the imaginary parts of the eigenvalues at the given level for appending. More...
 
const std::vector< double > & im (unsigned int level) const
 Returns the vector of the imaginary parts of the eigenvalues at the given level for reading only. More...
 
int maxLevel () const
 Returns the number of levels + 1. More...
 
bool trivial () const
 Returns "true" if there are no eigenvalues at any level. More...
 
std::ostream & write (std::ostream &out, const char *valueSep=0, const char *lineSep=0) const
 Writes the eigenvalues in a human-readable format to the output stream. More...
 

Private Member Functions

void addVectors (unsigned int level)
 Makes sure that the vectors are large enough for the given level. More...
 

Private Attributes

std::vector< std::vector< double > > reVectors
 The vector of the real part vectors. More...
 
std::vector< std::vector< double > > imVectors
 The vector of the imaginary part vectors. More...
 

Detailed Description

Eigenvalues of the Conley index map gathered by levels.

Definition at line 62 of file eigenval.h.

Constructor & Destructor Documentation

◆ IndexEigenValues() [1/2]

IndexEigenValues::IndexEigenValues ( )
inline

The constructor of an empty object.

Definition at line 123 of file eigenval.h.

◆ IndexEigenValues() [2/2]

template<class ConleyIndexType >
IndexEigenValues::IndexEigenValues ( const ConleyIndexType &  index)
inline

The constructor of an object based on the given Conley index.

Calls the computation of nonzero eigenvalues of the given Conley index and acquires the computed eigenvalues.

Definition at line 129 of file eigenval.h.

References imVectors, and reVectors.

Member Function Documentation

◆ addVectors()

void IndexEigenValues::addVectors ( unsigned int  level)
inlineprivate

Makes sure that the vectors are large enough for the given level.

Definition at line 142 of file eigenval.h.

References imVectors, and reVectors.

Referenced by im(), and re().

◆ im() [1/2]

std::vector< double > & IndexEigenValues::im ( unsigned int  level)
inline

Returns the vector of the imaginary parts of the eigenvalues at the given level for appending.

Definition at line 167 of file eigenval.h.

References addVectors(), and imVectors.

Referenced by write().

◆ im() [2/2]

const std::vector< double > & IndexEigenValues::im ( unsigned int  level) const
inline

Returns the vector of the imaginary parts of the eigenvalues at the given level for reading only.

Definition at line 173 of file eigenval.h.

References imVectors.

◆ maxLevel()

int IndexEigenValues::maxLevel ( ) const
inline

Returns the number of levels + 1.

To be used in a loop "for (int level = 0; level < this -> maxLevel (); ++ level)".

Definition at line 181 of file eigenval.h.

References reVectors.

Referenced by trivial(), and write().

◆ re() [1/2]

std::vector< double > & IndexEigenValues::re ( unsigned int  level)
inline

Returns the vector of the real parts of the eigenvalues at the given level for appending.

Definition at line 153 of file eigenval.h.

References addVectors(), and reVectors.

Referenced by write().

◆ re() [2/2]

const std::vector< double > & IndexEigenValues::re ( unsigned int  level) const
inline

Returns the vector of the real parts of the eigenvalues at the given level for reading only.

Definition at line 159 of file eigenval.h.

References reVectors.

◆ trivial()

bool IndexEigenValues::trivial ( ) const
inline

Returns "true" if there are no eigenvalues at any level.

Otherwise returns "false". Does not verify if the eigenvalues are zero or not.

Definition at line 186 of file eigenval.h.

References maxLevel(), and reVectors.

◆ write()

std::ostream & IndexEigenValues::write ( std::ostream &  out,
const char *  valueSep = 0,
const char *  lineSep = 0 
) const
inline

Writes the eigenvalues in a human-readable format to the output stream.

The separator of eigenvalues and line separator can be provided for customized output. Returns the reference of the provided output stream.

Definition at line 199 of file eigenval.h.

References im(), imVectors, maxLevel(), re(), and reVectors.

Member Data Documentation

◆ imVectors

std::vector<std::vector<double> > IndexEigenValues::imVectors
private

The vector of the imaginary part vectors.

Definition at line 114 of file eigenval.h.

Referenced by addVectors(), im(), IndexEigenValues(), and write().

◆ reVectors

std::vector<std::vector<double> > IndexEigenValues::reVectors
private

The vector of the real part vectors.

Definition at line 111 of file eigenval.h.

Referenced by addVectors(), IndexEigenValues(), maxLevel(), re(), trivial(), and write().


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