Dip  0.92.4
List of all members
AlpsDecompModel Class Reference

Derivation of AlpsModel for DECOMP. More...

#include <AlpsDecompModel.h>

+ Inheritance diagram for AlpsDecompModel:

Public Member Functions

Constructors and destructor.
 AlpsDecompModel ()
 Default constructors. More...
 
 AlpsDecompModel (UtilParameters &utilParam, DecompAlgo *decompAlgo)
 
virtual ~AlpsDecompModel ()
 Destructor. More...
 
Virtual functions from AlpsModel.
virtual AlpsTreeNode * createRoot ()
 Create the root node of the search tree. More...
 
virtual bool fathomAllNodes ()
 Return true, if all nodes can be fathomed. More...
 
Helper functions.
AlpsExitStatus solve ()
 Solve with ALPS and DECOMP. More...
 
void setAlpsSettings ()
 Set the ALPS parameters. More...
 
void setDecompAlgo (DecompAlgo *decompAlgo)
 Solve with ALPS and DECOMP. More...
 
Set/get methods.
DecompAlgogetDecompAlgo ()
 Get a ptr to the decomp algorithm vector. More...
 
AlpsDecompParamgetParam ()
 
const int getNumCoreRows () const
 Get number of rows in core decomp model. More...
 
const int getNumCoreCols () const
 Get number of cols in core decomp model. More...
 
const std::vector< std::string > & getColNames () const
 Get the column names in core decomp model. More...
 
const std::vector< std::string > & getRowNames () const
 Get the row names in core decomp model. More...
 
const DecompSolutiongetBestSolution () const
 Get the best solution found. More...
 
const double getGlobalLB () const
 
const double getGlobalUB () const
 
const int getSolStatus () const
 
const int getNumNodesProcessed () const
 

Detailed Description

Derivation of AlpsModel for DECOMP.

An object derived from AlpsModel. It interfaces with DECOMP methods through a pointer to the active DecompAlgo.

Virtual methods that should be derived here:

See also
AlpsModel
DecompAlgo
Todo:

Clone a monkey.

Arm wrestle Ted.

Allow use of Alps writeParameters.

Use message handler.

Use differencing scheme.

Setup for parallel.

Definition at line 64 of file AlpsDecompModel.h.

Constructor & Destructor Documentation

◆ AlpsDecompModel() [1/2]

AlpsDecompModel::AlpsDecompModel ( )
inline

Default constructors.

Definition at line 112 of file AlpsDecompModel.h.

◆ AlpsDecompModel() [2/2]

AlpsDecompModel::AlpsDecompModel ( UtilParameters utilParam,
DecompAlgo decompAlgo 
)
inline

Definition at line 119 of file AlpsDecompModel.h.

◆ ~AlpsDecompModel()

virtual AlpsDecompModel::~AlpsDecompModel ( )
inlinevirtual

Destructor.

Definition at line 135 of file AlpsDecompModel.h.

Member Function Documentation

◆ createRoot()

virtual AlpsTreeNode* AlpsDecompModel::createRoot ( )
virtual

Create the root node of the search tree.

◆ fathomAllNodes()

virtual bool AlpsDecompModel::fathomAllNodes ( )
virtual

Return true, if all nodes can be fathomed.

◆ solve()

AlpsExitStatus AlpsDecompModel::solve ( )

Solve with ALPS and DECOMP.

◆ setAlpsSettings()

void AlpsDecompModel::setAlpsSettings ( )

Set the ALPS parameters.

◆ setDecompAlgo()

void AlpsDecompModel::setDecompAlgo ( DecompAlgo decompAlgo)
inline

Solve with ALPS and DECOMP.

Definition at line 177 of file AlpsDecompModel.h.

◆ getDecompAlgo()

DecompAlgo* AlpsDecompModel::getDecompAlgo ( )
inline

Get a ptr to the decomp algorithm vector.

Definition at line 194 of file AlpsDecompModel.h.

◆ getParam()

AlpsDecompParam& AlpsDecompModel::getParam ( )
inline

Definition at line 198 of file AlpsDecompModel.h.

◆ getNumCoreRows()

const int AlpsDecompModel::getNumCoreRows ( ) const
inline

Get number of rows in core decomp model.

Definition at line 206 of file AlpsDecompModel.h.

◆ getNumCoreCols()

const int AlpsDecompModel::getNumCoreCols ( ) const
inline

Get number of cols in core decomp model.

Definition at line 213 of file AlpsDecompModel.h.

◆ getColNames()

const std::vector<std::string>& AlpsDecompModel::getColNames ( ) const
inline

Get the column names in core decomp model.

Definition at line 220 of file AlpsDecompModel.h.

◆ getRowNames()

const std::vector<std::string>& AlpsDecompModel::getRowNames ( ) const
inline

Get the row names in core decomp model.

Definition at line 227 of file AlpsDecompModel.h.

◆ getBestSolution()

const DecompSolution* AlpsDecompModel::getBestSolution ( ) const
inline

Get the best solution found.

Definition at line 234 of file AlpsDecompModel.h.

◆ getGlobalLB()

const double AlpsDecompModel::getGlobalLB ( ) const
inline

Definition at line 238 of file AlpsDecompModel.h.

◆ getGlobalUB()

const double AlpsDecompModel::getGlobalUB ( ) const
inline

Definition at line 241 of file AlpsDecompModel.h.

◆ getSolStatus()

const int AlpsDecompModel::getSolStatus ( ) const
inline

Definition at line 244 of file AlpsDecompModel.h.

◆ getNumNodesProcessed()

const int AlpsDecompModel::getNumNodesProcessed ( ) const
inline

Definition at line 247 of file AlpsDecompModel.h.


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