Objective.h

Go to the documentation of this file.

// 
//     Minotaur -- It's only 1/2 bull
// 
//     (C)opyright 2009 - 2025 The Minotaur Team.
// 
 
#ifndef OBJECTIVE_H
#define OBJECTIVE_H
 
#include <string>
 
#include "Types.h"
 
namespace Minotaur {
 
  typedef std::set<std::pair<VariablePtr, FunctionType> >::const_iterator 
    VariableFunIterator;
  class Objective
  {
    public:
      friend class Problem;
 
      Objective();
 
      Objective(double cb = 0.0, ObjectiveType otyp = Minimize);
 
      /*
       * Create an objective with a specific function, id, constant term and
       * sense. A default name is created.
       */
      Objective(FunctionPtr fPtr, double cb = 0.0, 
                ObjectiveType otyp = Minimize);
 
      Objective(FunctionPtr fPtr, double cb, ObjectiveType otyp, 
                std::string name);
 
      virtual ~Objective();
 
 
      // Functions that query or get information.
 
      double getConstant() const { return cb_; }
 
      ObjectiveType getObjectiveType() const;
 
      FunctionType getFunctionType() const;
 
      ObjState getState() const { return state_; }
 
      /*
       * Return the name of this objective. If the user did not create a name
       * for the objective, it is generated automatically
       */
      virtual const std::string getName() const;
 
      FunctionPtr getFunction() const {
        return f_;
      }
 
      LinearFunctionPtr getLinearFunction() const;
 
      QuadraticFunctionPtr getQuadraticFunction() const;
 
      NonlinearFunctionPtr getNonlinearFunction() const;
 
      void write(std::ostream &out) const; 
 
      double eval(const double *x, int *err) const;
 
      void evalGradient(const double *x, double *grad_f, int *error);
 
      void evalGradient(VariableGroup &point, double *grad_f);
 
      // Functions that modify or change the objective.
      
    private:
      double cb_;
 
      ObjectiveType otyp_;
 
      ObjState state_;
 
      FunctionPtr f_;
 
      std::string name_;
 
      void delFixedVar_(VariablePtr v, double val);
 
      void setState_(ObjState state) { state_ = state; return; }
 
      void add_(ConstLinearFunctionPtr lPtr);
 
      void add_(double cb);
 
      QuadraticFunctionPtr removeQuadratic_();
 
      NonlinearFunctionPtr removeNonlinear_();
 
      void subst_(VariablePtr out, VariablePtr in, double rat=1.0);
 
      void negate_();
  };
}
#endif