ROL_BoundConstraint.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//               Rapid Optimization Library (ROL) Package
//
// Copyright 2014 NTESS and the ROL contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @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