The Original CHomP Software
Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
chomp::homengin::MM_ARengine Class Reference

The MM_AR engine. More...

#include <engines.h>

Inheritance diagram for chomp::homengin::MM_ARengine:
chomp::homengin::MMengine chomp::homengin::engine

Public Member Functions

int speed () const
 The speed of the engine: The higher the number, the better. More...
 
bool dimsupported (int dim) const
 Is this dimension supported by this engine? More...
 
void homology (const cubfile &x, algstruct< chomp::homology::integer > &h) const
 Compute the homology of the given set of cubes. More...
 
const char * name () const
 The name of the engine to be used in the command line. More...
 
std::ostream & describe (std::ostream &out) const
 Describes this particular engine. More...
 
- Public Member Functions inherited from chomp::homengin::MMengine
virtual int speed () const =0
 The speed of the engine: The higher the number, the better. More...
 
bool dimsupported (int dim) const
 Is this dimension supported by this engine? More...
 
int memory (const cubfile &X) const
 Rough memory usage estimate for a single set of cubes. More...
 
bool relative () const
 Does this engine compute relative homology? More...
 
bool elementary () const
 Is this engine capable of processing elementary cubes? More...
 
bool spacewrapping () const
 Does this engine support space wrapping? More...
 
virtual void homology (const cubfile &x, algstruct< chomp::homology::integer > &h) const =0
 Compute the homology of the given set of cubes. More...
 
void homology (const cubfile &x, const cubfile &y, algstruct< chomp::homology::integer > &h) const
 Compute the relative homology of the given pair of sets of cubes. More...
 
virtual const char * name () const =0
 The name of the engine to be used in the command line. More...
 
virtual std::ostream & describe (std::ostream &out) const =0
 Describes this particular engine. More...
 
virtual int speed () const
 The speed of the engine: The higher the number, the better. More...
 
virtual bool dimsupported (int dim) const
 Is this dimension supported by this engine? More...
 
virtual int memory (const cubfile &X) const
 Rough memory usage estimate for a single set of cubes. More...
 
virtual bool relative () const
 Does this engine compute relative homology? More...
 
virtual bool elementary () const
 Is this engine capable of processing elementary cubes? More...
 
virtual bool spacewrapping () const
 Does this engine support space wrapping? More...
 
virtual void homology (const cubfile &x, algstruct< chomp::homology::integer > &h) const
 Compute the homology of the given set of cubes. More...
 
virtual void homology (const cubfile &x, const cubfile &y, algstruct< chomp::homology::integer > &h) const
 Compute the relative homology of the given pair of sets of cubes. More...
 
virtual const char * name () const
 The name of the engine to be used in the command line. More...
 
virtual std::ostream & describe (std::ostream &out) const
 Describes this particular engine. More...
 

Static Public Attributes

static MM_ARengine eng
 One instance of this engine. More...
 
- Static Public Attributes inherited from chomp::homengin::engine
static enginelist engines
 A list of all the engines that have been defined so far. More...
 

Protected Member Functions

 MM_ARengine ()
 The default constructor. More...
 
 ~MM_ARengine ()
 The destructor. More...
 
- Protected Member Functions inherited from chomp::homengin::MMengine
 MMengine ()
 The default constructor. More...
 
 ~MMengine ()
 The destructor. More...
 
- Protected Member Functions inherited from chomp::homengin::engine
 engine ()
 The default constructor: Add the engine to the list. More...
 
virtual ~engine ()
 The destructor: Remove the engine from the list. More...
 

Additional Inherited Members

- Public Types inherited from chomp::homengin::engine
typedef std::vector< const engine * > enginelist
 The type of a list of engines. More...
 
- Static Public Member Functions inherited from chomp::homengin::engine
static std::ostream & showlist (std::ostream &out, const engine::enginelist &elist=engine::engines)
 Shows a list of available homology engines with descriptions. More...
 
static const enginefind (const cubfile *X, const cubfile *Y, const engine::enginelist &elist=engine::engines)
 Finds the most appropriate homology engine. More...
 
static const enginefind (const cubfile *X, const engine::enginelist &elist=engine::engines)
 Finds the most appropriate homology engine for just one set. More...
 
static const enginefind (const char *name, const engine::enginelist &elist=engine::engines)
 Finds a homology engine with the given name. More...
 

Detailed Description

The MM_AR engine.

Definition at line 533 of file engines.h.

Constructor & Destructor Documentation

◆ MM_ARengine()

chomp::homengin::MM_ARengine::MM_ARengine ( )
inlineprotected

The default constructor.

Definition at line 537 of file engines.h.

538 {
539 return;
540 }

◆ ~MM_ARengine()

chomp::homengin::MM_ARengine::~MM_ARengine ( )
inlineprotected

The destructor.

Definition at line 543 of file engines.h.

544 {
545 return;
546 }

Member Function Documentation

◆ describe()

std::ostream & chomp::homengin::MM_ARengine::describe ( std::ostream &  out) const
virtual

Describes this particular engine.

Implements chomp::homengin::MMengine.

◆ dimsupported()

bool chomp::homengin::MM_ARengine::dimsupported ( int  dim) const
inlinevirtual

Is this dimension supported by this engine?

Reimplemented from chomp::homengin::MMengine.

Definition at line 556 of file engines.h.

557 {
558 return ((dim == embeddingDim) || ((dim >= 2) && (dim <= 4)));
559 }

◆ homology()

void chomp::homengin::MM_ARengine::homology ( const cubfile x,
algstruct< chomp::homology::integer > &  h 
) const
virtual

Compute the homology of the given set of cubes.

Implements chomp::homengin::MMengine.

◆ name()

const char * chomp::homengin::MM_ARengine::name ( ) const
inlinevirtual

The name of the engine to be used in the command line.

Implements chomp::homengin::MMengine.

Definition at line 566 of file engines.h.

567 {
568 return "MM_AR";
569 }

◆ speed()

int chomp::homengin::MM_ARengine::speed ( ) const
inlinevirtual

The speed of the engine: The higher the number, the better.

Implements chomp::homengin::MMengine.

Definition at line 550 of file engines.h.

551 {
552 return 70;
553 }

Member Data Documentation

◆ eng

MM_ARengine chomp::homengin::MM_ARengine::eng
static

One instance of this engine.

Definition at line 575 of file engines.h.


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