ROL_BoundConstraint.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_BOUND_CONSTRAINT_H
#define ROL_BOUND_CONSTRAINT_H
 
#include "ROL_Vector.hpp"
#include "ROL_Ptr.hpp"
#include "ROL_Types.hpp"
#include <iostream>

 
 
namespace ROL {
 
template<typename Real>
class BoundConstraint {
private:
  bool Lactivated_; 
  bool Uactivated_; 
 
protected:
  Ptr<Vector<Real>> lower_;
  Ptr<Vector<Real>> upper_;
 
  Real computeInf(const Vector<Real> &x) const;
 
public:
 
  virtual ~BoundConstraint() {}
  BoundConstraint(void);
  BoundConstraint(const Vector<Real> &x);
 
  // REQUIRED FUNCTIONS (VIRTUAL)

  virtual void project( Vector<Real> &x );

  virtual void projectInterior( Vector<Real> &x );

  virtual void pruneUpperActive( Vector<Real> &v, const Vector<Real> &x, Real eps = Real(0) );

  virtual void pruneUpperActive( Vector<Real> &v, const Vector<Real> &g, const Vector<Real> &x, Real xeps = Real(0), Real geps = Real(0) );

  virtual void pruneLowerActive( Vector<Real> &v, const Vector<Real> &x, Real eps = Real(0) );

  virtual void pruneLowerActive( Vector<Real> &v, const Vector<Real> &g, const Vector<Real> &x, Real xeps = Real(0), Real geps = Real(0) );
 
 
  // QUERY FUNCTIONS (VIRTUAL AND NONVIRTUAL)

  virtual const Ptr<const Vector<Real>> getLowerBound( void ) const;

  virtual const Ptr<const Vector<Real>> getUpperBound( void ) const;

  virtual bool isFeasible( const Vector<Real> &v );

  virtual void applyInverseScalingFunction(Vector<Real> &dv, const Vector<Real> &v, const Vector<Real> &x, const Vector<Real> &g) const;

  virtual void applyScalingFunctionJacobian(Vector<Real> &dv, const Vector<Real> &v, const Vector<Real> &x, const Vector<Real> &g) const;

  void activateLower(void);

  void activateUpper(void);

  void activate(void);

  void deactivateLower(void);

  void deactivateUpper(void);

  void deactivate(void);

  bool isLowerActivated(void) const;

  bool isUpperActivated(void) const;

  bool isActivated(void) const;
 
 
  // HELPER FUNCTIONS (NONVIRTUAL)

  void pruneActive( Vector<Real> &v, const Vector<Real> &x, Real eps = Real(0) );

  void pruneActive( Vector<Real> &v, const Vector<Real> &g, const Vector<Real> &x, Real xeps = Real(0), Real geps = Real(0) );

  void pruneLowerInactive( Vector<Real> &v, const Vector<Real> &x, Real eps = Real(0) );

  void pruneUpperInactive( Vector<Real> &v, const Vector<Real> &x, Real eps = Real(0) );

  void pruneLowerInactive( Vector<Real> &v, const Vector<Real> &g, const Vector<Real> &x, Real xeps = Real(0), Real geps = Real(0) );

  void pruneUpperInactive( Vector<Real> &v, const Vector<Real> &g, const Vector<Real> &x, Real xeps = Real(0), Real geps = Real(0) );

  void pruneInactive( Vector<Real> &v, const Vector<Real> &x, Real eps = Real(0) );

  void pruneInactive( Vector<Real> &v, const Vector<Real> &g, const Vector<Real> &x, Real xeps = Real(0), Real geps = Real(0) );
 
  void computeProjectedGradient( Vector<Real> &g, const Vector<Real> &x );
 
  void computeProjectedStep( Vector<Real> &v, const Vector<Real> &x );
 
}; // class BoundConstraint
 
} // namespace ROL
 
#include "ROL_BoundConstraint_Def.hpp"
 
#endif