problem.h

Go to the documentation of this file.

/******************************************************************************
Copyright (c) 2017, Alexander W Winkler. All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
* Redistributions of source code must retain the above copyright notice, this
  list of conditions and the following disclaimer.
 
* Redistributions in binary form must reproduce the above copyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
 
* Neither the name of the copyright holder nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
******************************************************************************/
 
#ifndef IFOPT_INCLUDE_OPT_PROBLEM_H_
#define IFOPT_INCLUDE_OPT_PROBLEM_H_
 
#include "variable_set.h"
#include "constraint_set.h"
#include "cost_term.h"
 
namespace ifopt {
 
 
class Problem {
public:
  using VecBound = Component::VecBound;
  using Jacobian = Component::Jacobian;
  using VectorXd = Component::VectorXd;
 
  Problem ();
  virtual ~Problem () = default;
 
  void AddVariableSet(VariableSet::Ptr variable_set);
 
  void AddConstraintSet(ConstraintSet::Ptr constraint_set);
 
  void AddCostSet(CostTerm::Ptr cost_set);
 
  void SetVariables(const double* x);
 
  int GetNumberOfOptimizationVariables() const;
 
  bool HasCostTerms() const;
 
  VecBound GetBoundsOnOptimizationVariables() const;
 
  VectorXd GetVariableValues() const;
 
  double EvaluateCostFunction(const double* x);
 
  VectorXd EvaluateCostFunctionGradient(const double* x,
                                        bool use_finite_difference_approximation = false,
                                        double epsilon = std::numeric_limits<double>::epsilon());
 
  int GetNumberOfConstraints() const;
 
  VecBound GetBoundsOnConstraints() const;
 
  VectorXd EvaluateConstraints(const double* x);
 
  void EvalNonzerosOfJacobian(const double* x, double* values);
 
  Jacobian GetJacobianOfConstraints() const;
 
  Jacobian GetJacobianOfCosts () const;
 
  void SaveCurrent();
 
  Composite::Ptr GetOptVariables() const;
 
  void SetOptVariables(int iter);
 
  void SetOptVariablesFinal();
 
  int GetIterationCount() const { return x_prev.size(); };
 
  void PrintCurrent() const;
 
  const Composite& GetConstraints() const { return constraints_; };
 
  const Composite& GetCosts() const { return costs_; };
 
  const std::vector<VectorXd> &GetIterations() const { return x_prev; };
 
private:
  Composite::Ptr variables_;
  Composite constraints_;
  Composite costs_;
 
  std::vector<VectorXd> x_prev; 
 
  VectorXd ConvertToEigen(const double* x) const;
};
 
} /* namespace opt */
 
#endif /* IFOPT_INCLUDE_OPT_PROBLEM_H_ */