SCIRun  5.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | List of all members
SolveLinearSystemAlgorithm Class Reference

#include <SolveLinearSystemWithEigen.h>

Inheritance diagram for SolveLinearSystemAlgorithm:
AlgorithmBase AlgorithmParameterList AlgorithmLogger AlgorithmStatusReporter AlgorithmInterface LegacyLoggerInterface ProgressReporter HasId< IdType, IdGenerator >

Public Types

typedef boost::tuple
< SCIRun::Core::Datatypes::MatrixHandle,
SCIRun::Core::Datatypes::DenseColumnMatrixHandle
Inputs
 
typedef boost::tuple< double, int > Parameters
 
typedef boost::tuple
< SCIRun::Core::Datatypes::DenseColumnMatrixHandle,
double, int > 
Outputs
 
- Public Types inherited from HasId< IdType, IdGenerator >
typedef IdType id_type
 
- Public Types inherited from AlgorithmStatusReporter
typedef boost::function< void(double)> UpdaterFunc
 

Public Member Functions

Outputs run (const Inputs &input, const Parameters &params) const
 
AlgorithmOutput run_generic (const AlgorithmInput &input) const
 
- Public Member Functions inherited from AlgorithmBase
virtual ~AlgorithmBase ()
 
- Public Member Functions inherited from AlgorithmParameterList
 AlgorithmParameterList ()
 
bool set (const AlgorithmParameterName &key, const AlgorithmParameter::Value &value)
 
const AlgorithmParameterget (const AlgorithmParameterName &key) const
 
bool set_option (const AlgorithmParameterName &key, const std::string &value)
 
bool get_option (const AlgorithmParameterName &key, std::string &value) const
 
std::string get_option (const AlgorithmParameterName &key) const
 
bool check_option (const AlgorithmParameterName &key, const std::string &value) const
 
virtual bool keyNotFoundPolicy (const AlgorithmParameterName &key)
 
- Public Member Functions inherited from AlgorithmInterface
virtual ~AlgorithmInterface ()
 
- Public Member Functions inherited from HasId< IdType, IdGenerator >
 HasId ()
 
IdType id () const
 
- Public Member Functions inherited from AlgorithmLogger
 AlgorithmLogger ()
 
 ~AlgorithmLogger ()
 
void setLogger (Core::Logging::LoggerHandle logger)
 
virtual void error (const std::string &error) const
 functions for the algorithm, so it can forward errors if needed More...
 
virtual void warning (const std::string &warning) const
 
virtual void remark (const std::string &remark) const
 
virtual void status (const std::string &status) const
 
- Public Member Functions inherited from LegacyLoggerInterface
virtual ~LegacyLoggerInterface ()
 
- Public Member Functions inherited from AlgorithmStatusReporter
 AlgorithmStatusReporter ()
 
 ~AlgorithmStatusReporter ()
 
virtual void report_start (const std::string &tag) const
 
virtual void report_end () const
 
virtual void update_progress (double percent) const
 
void setUpdaterFunc (UpdaterFunc func)
 
UpdaterFunc getUpdaterFunc () const
 
- Public Member Functions inherited from ProgressReporter
virtual ~ProgressReporter ()
 
template<typename T1 , typename T2 >
void update_progress_max (T1 current, T2 max) const
 

Additional Inherited Members

- Protected Member Functions inherited from AlgorithmParameterList
void dumpAlgoState () const
 
void addParameter (const AlgorithmParameterName &key, const AlgorithmParameter::Value &defaultValue)
 
void add_option (const AlgorithmParameterName &key, const std::string &defval, const std::string &options)
 

Detailed Description

Todo:
: this will be the base class of all the solvers. for now it will just contain the Eigen CG impl.

Member Typedef Documentation

typedef boost::tuple<SCIRun::Core::Datatypes::DenseColumnMatrixHandle, double, int> Outputs
typedef boost::tuple<double, int> Parameters

Member Function Documentation

SolveLinearSystemAlgorithm::Outputs run ( const Inputs input,
const Parameters params 
) const
Todo:
: move ctor
AlgorithmOutput run_generic ( const AlgorithmInput input) const
virtual

Implements AlgorithmInterface.


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