ROL_Problem.hpp

Go to the documentation of this file.

// @HEADER
// ************************************************************************
//
//               Rapid Optimization Library (ROL) Package
//                 Copyright (2014) Sandia Corporation
//
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. 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.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "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 SANDIA CORPORATION OR THE
// 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.
//
// Questions? Contact lead developers:
//              Drew Kouri   (dpkouri@sandia.gov) and
//              Denis Ridzal (dridzal@sandia.gov)
//
// ************************************************************************
// @HEADER
 
#ifndef ROL_PROBLEM_HPP
#define ROL_PROBLEM_HPP
 
#include <utility>
#include <unordered_map>
 
#include "ROL_Ptr.hpp"
#include "ROL_Types.hpp"
#include "ROL_ConstraintAssembler.hpp"
#include "ROL_SlacklessObjective.hpp"
#include "ROL_ReduceLinearConstraint.hpp"
#include "ROL_PolyhedralProjectionFactory.hpp"
 
namespace ROL {
 
template<typename Real>
class Problem {
private:
  bool isFinalized_;
  bool hasBounds_;
  bool hasEquality_;
  bool hasInequality_;
  bool hasLinearEquality_;
  bool hasLinearInequality_;
  unsigned cnt_econ_;
  unsigned cnt_icon_;
  unsigned cnt_linear_econ_;
  unsigned cnt_linear_icon_;
 
  ParameterList ppa_list_;
 
  Ptr<Objective<Real>>            obj_;
  Ptr<Vector<Real>>               xprim_;
  Ptr<Vector<Real>>               xdual_;
  Ptr<BoundConstraint<Real>>      bnd_;
  Ptr<Constraint<Real>>           con_;
  Ptr<Vector<Real>>               mul_;
  Ptr<Vector<Real>>               res_;
  Ptr<PolyhedralProjection<Real>> proj_;
 
  Ptr<Vector<Real>> xfeas_;
  Ptr<ReduceLinearConstraint<Real>> rlc_;
 
  EProblem problemType_;
 
protected:
 
  Ptr<Objective<Real>>                                 INPUT_obj_;
  Ptr<Vector<Real>>                                    INPUT_xprim_;
  Ptr<Vector<Real>>                                    INPUT_xdual_;
  Ptr<BoundConstraint<Real>>                           INPUT_bnd_;
  std::unordered_map<std::string,ConstraintData<Real>> INPUT_con_;
  std::unordered_map<std::string,ConstraintData<Real>> INPUT_linear_con_;
 
public:
  virtual ~Problem() {}
 
  Problem( const Ptr<Objective<Real>> &obj,
           const Ptr<Vector<Real>>    &x,
           const Ptr<Vector<Real>>    &g = nullPtr);
 
  /***************************************************************************/
  /*** Set and remove methods for constraints ********************************/
  /***************************************************************************/
 
  void addBoundConstraint(const Ptr<BoundConstraint<Real>> &bnd);
 
  void removeBoundConstraint();
 
  void addConstraint(std::string                  name,
                     const Ptr<Constraint<Real>> &econ,
                     const Ptr<Vector<Real>>     &emul,
                     const Ptr<Vector<Real>>     &eres = nullPtr,
                     bool                         reset = false);
 
  void addConstraint(std::string                       name,
                     const Ptr<Constraint<Real>>      &icon,
                     const Ptr<Vector<Real>>          &imul,
                     const Ptr<BoundConstraint<Real>> &ibnd,
                     const Ptr<Vector<Real>>          &ires = nullPtr,
                     bool                              reset = false);
 
  void removeConstraint(std::string name);
 
  void addLinearConstraint(std::string                  name,
                           const Ptr<Constraint<Real>> &linear_econ,
                           const Ptr<Vector<Real>>     &linear_emul,
                           const Ptr<Vector<Real>>     &linear_eres = nullPtr,
                           bool                         reset = false);
 
  void addLinearConstraint(std::string                       name,
                           const Ptr<Constraint<Real>>      &linear_icon,
                           const Ptr<Vector<Real>>          &linear_imul,
                           const Ptr<BoundConstraint<Real>> &linear_ibnd,
                           const Ptr<Vector<Real>>          &linear_ires = nullPtr,
                           bool                              reset = false);
 
  void removeLinearConstraint(std::string name);
 
  void setProjectionAlgorithm(ParameterList &parlist);
 
  /***************************************************************************/
  /*** Accessor methods ******************************************************/
  /***************************************************************************/
 
  const Ptr<Objective<Real>>&            getObjective();
 
  const Ptr<Vector<Real>>&               getPrimalOptimizationVector();
 
  const Ptr<Vector<Real>>&               getDualOptimizationVector();
 
  const Ptr<BoundConstraint<Real>>&      getBoundConstraint();
 
  const Ptr<Constraint<Real>>&           getConstraint();
 
  const Ptr<Vector<Real>>&               getMultiplierVector();
 
  const Ptr<Vector<Real>>&               getResidualVector();
 
  const Ptr<PolyhedralProjection<Real>>& getPolyhedralProjection();
 
  EProblem                              getProblemType();
 
  /***************************************************************************/
  /*** Consistency checks ****************************************************/
  /***************************************************************************/
 
  Real checkLinearity(bool printToStream = false, std::ostream &outStream = std::cout) const;
 
  void checkVectors(bool printToStream = false, std::ostream &outStream = std::cout) const;
 
  void checkDerivatives(bool printToStream = false, std::ostream &outStream = std::cout) const;
 
  void check(bool printToStream = false, std::ostream &outStream = std::cout) const;
 
  /***************************************************************************/
  /*** Finalize and edit methods *********************************************/
  /***************************************************************************/
 
  virtual void finalize(bool lumpConstraints = false, bool printToStream = false,
                        std::ostream &outStream = std::cout);
 
  bool isFinalized() const;
 
  virtual void edit();
 
  void finalizeIteration();
 
}; // class Problem
 
}  // namespace ROL
 
#include "ROL_Problem_Def.hpp"
 
#endif // ROL_NEWOPTIMIZATIONPROBLEM_HPP