ROL_PolyhedralProjection.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_POLYHEDRALPROJECTION_H
#define ROL_POLYHEDRALPROJECTION_H

#include "ROL_BoundConstraint.hpp"
#include "ROL_Constraint.hpp"
#include <iostream>

namespace ROL {

template<typename Real>
class PolyhedralProjection {
protected:
  const Ptr<BoundConstraint<Real>> bnd_;
  const Ptr<Constraint<Real>>      con_;
  Ptr<Vector<Real>> xprim_, xdual_, mul_, res_;

public:
  virtual ~PolyhedralProjection() {}

  PolyhedralProjection(const Ptr<BoundConstraint<Real>> &bnd);

  PolyhedralProjection(const Vector<Real>               &xprim,
                       const Vector<Real>               &xdual,
                       const Ptr<BoundConstraint<Real>> &bnd,
                       const Ptr<Constraint<Real>>      &con,
                       const Vector<Real>               &mul,
                       const Vector<Real>               &res);

  virtual void project(Vector<Real> &x, std::ostream &stream = std::cout);

  const Ptr<Constraint<Real>> getLinearConstraint(void) const;

  const Ptr<BoundConstraint<Real>> getBoundConstraint(void) const;

  const Ptr<Vector<Real>> getMultiplier(void) const;

  const Ptr<Vector<Real>> getResidual(void) const;

}; // class PolyhedralProjection

} // namespace ROL

#include "ROL_PolyhedralProjection_Def.hpp"

#endif