Solver.h

Go to the documentation of this file.

#ifndef _OCRABASE_SOLVER_H_
#define _OCRABASE_SOLVER_H_

//ocra includes
#include <ocra/util/MathTypes.h>
#include "ocra/optim/Variable.h"
#include "ocra/optim/MergedVariable.h"
#include "ocra/optim/SolverUtilities.h"
#include "ocra/optim/Objective.h"
#include "ocra/optim/Constraint.h"
#include "ocra/optim/NamedInstance.h"
#include "ocra/util/ErrorsHelper.h"

//boost
#include <boost/circular_buffer.hpp>

//std includes
#include <string>
#include <map>
#include <iosfwd>

namespace ocra
{
  class Solver
    : public ObserverSubject
    , virtual public NamedInstance
  {
      DEFINE_CLASS_POINTER_TYPEDEFS(Solver)
  public: // restricted access to automap
    const std::vector<int>& findMapping(Variable& var);

    // ------------------------ constructors ------------------------------------
  private:
    Solver(const Solver&);
    Solver& operator=(const Solver&);
  protected:
    Solver();
  public:
    virtual ~Solver() {}

    // ------------------------ public interface --------------------------------
  public:
    const OptimizationResult& solve();

    const OptimizationResult& getLastResult() const;

    void  printStatus(std::ostream& os);

    virtual const std::string& getMoreInfo() const;

    virtual void printValuesAtSolution() = 0;
    virtual std::string toString() = 0;

    void setMemoryLevel(int level);

    void setAutoDumpFile(const std::string& file);

    void activateAutoDump();

    void deactivateAutoDump();

    void dump(const std::string& file = "") const;

    // ------------------------ protected methods -------------------------------

    int n(){return _problemVariable.getVariable().getSize();}

    Variable& getProblemVariable(){return _problemVariable.getVariable();}

    void setVariableValue(const VectorXd& value) {_problemVariable.setValue(value);}
protected:
    virtual void doPrepare() = 0;
    virtual void doSolve() = 0;
    virtual void doConclude() = 0;

    void internalAddObjective(const GenericObjective& objective);
    void internalAddConstraint(const GenericConstraint& constraint);
    void internalRemoveObjective(const GenericObjective& objective);
    void internalRemoveConstraint(const GenericConstraint& constraint);

    virtual void onConstraintResize(int timestamp);

    virtual void onObjectiveResize(int timestamp);

    // ------------------------ protected members ---------------------------------
  protected:
    OptimizationResult                    _result;  //< structure to store the result of an optimization problem.

    // ------------------------ private members ---------------------------------
  private:
    bool                                  _isVariableUpToDate;
    MergedVariable                        _problemVariable;
    std::vector<const GenericObjective*>  _objectives;
    std::vector<const GenericConstraint*> _constraints;
    boost::circular_buffer<std::string>   _memory;
    std::string                           _autodumpFile;
    bool                                  _autodump;
  };
}

#endif  //_OCRABASE_SOLVER_H_

// cmake:sourcegroup=Solvers