ROL
ROL_BoundConstraint.hpp
Go to the documentation of this file.
1 // @HEADER
2 // ************************************************************************
3 //
4 // Rapid Optimization Library (ROL) Package
5 // Copyright (2014) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact lead developers:
38 // Drew Kouri (dpkouri@sandia.gov) and
39 // Denis Ridzal (dridzal@sandia.gov)
40 //
41 // ************************************************************************
42 // @HEADER
43 
44 #ifndef ROL_BOUND_CONSTRAINT_H
45 #define ROL_BOUND_CONSTRAINT_H
46 
47 #include "ROL_Vector.hpp"
48 #include "ROL_Ptr.hpp"
49 #include "ROL_Types.hpp"
50 #include <iostream>
51 
70 namespace ROL {
71 
72 template<typename Real>
74 private:
75  bool Lactivated_;
76  bool Uactivated_;
77 
78 protected:
79  Ptr<Vector<Real>> lower_;
80  Ptr<Vector<Real>> upper_;
81 
82 public:
83 
84  virtual ~BoundConstraint() {}
85  BoundConstraint(void);
86  BoundConstraint(const Vector<Real> &x);
87 
88  // REQUIRED FUNCTIONS (VIRTUAL)
89 
98  virtual void project( Vector<Real> &x );
99 
110  virtual void projectInterior( Vector<Real> &x );
111 
123  virtual void pruneUpperActive( Vector<Real> &v, const Vector<Real> &x, Real eps = Real(0) );
124 
139  virtual void pruneUpperActive( Vector<Real> &v, const Vector<Real> &g, const Vector<Real> &x, Real xeps = Real(0), Real geps = Real(0) );
140 
152  virtual void pruneLowerActive( Vector<Real> &v, const Vector<Real> &x, Real eps = Real(0) );
153 
168  virtual void pruneLowerActive( Vector<Real> &v, const Vector<Real> &g, const Vector<Real> &x, Real xeps = Real(0), Real geps = Real(0) );
169 
170 
171  // QUERY FUNCTIONS (VIRTUAL AND NONVIRTUAL)
172 
174  virtual const Ptr<const Vector<Real>> getLowerBound( void ) const;
175 
177  virtual const Ptr<const Vector<Real>> getUpperBound( void ) const;
178 
184  virtual bool isFeasible( const Vector<Real> &v );
185 
190  void activateLower(void);
191 
196  void activateUpper(void);
197 
202  void activate(void);
203 
208  void deactivateLower(void);
209 
214  void deactivateUpper(void);
215 
220  void deactivate(void);
221 
226  bool isLowerActivated(void) const;
227 
232  bool isUpperActivated(void) const;
233 
238  bool isActivated(void) const;
239 
240 
241  // HELPER FUNCTIONS (NONVIRTUAL)
242 
254  void pruneActive( Vector<Real> &v, const Vector<Real> &x, Real eps = Real(0) );
255 
269  void pruneActive( Vector<Real> &v, const Vector<Real> &g, const Vector<Real> &x, Real xeps = Real(0), Real geps = Real(0) );
270 
278  void pruneLowerInactive( Vector<Real> &v, const Vector<Real> &x, Real eps = Real(0) );
279 
287  void pruneUpperInactive( Vector<Real> &v, const Vector<Real> &x, Real eps = Real(0) );
288 
298  void pruneLowerInactive( Vector<Real> &v, const Vector<Real> &g, const Vector<Real> &x, Real xeps = Real(0), Real geps = Real(0) );
299 
309  void pruneUpperInactive( Vector<Real> &v, const Vector<Real> &g, const Vector<Real> &x, Real xeps = Real(0), Real geps = Real(0) );
310 
318  void pruneInactive( Vector<Real> &v, const Vector<Real> &x, Real eps = Real(0) );
319 
329  void pruneInactive( Vector<Real> &v, const Vector<Real> &g, const Vector<Real> &x, Real xeps = Real(0), Real geps = Real(0) );
330 
338 
345  void computeProjectedStep( Vector<Real> &v, const Vector<Real> &x );
346 
347 }; // class BoundConstraint
348 
349 } // namespace ROL
350 
352 
353 #endif
virtual bool isFeasible(const Vector< Real > &v)
Check if the vector, v, is feasible.
bool Uactivated_
Flag that determines whether or not the upper bounds are being used.
Ptr< Vector< Real > > upper_
virtual void projectInterior(Vector< Real > &x)
Project optimization variables into the interior of the feasible set.
void activateLower(void)
Turn on lower bound.
void activate(void)
Turn on bounds.
virtual void pruneUpperActive(Vector< Real > &v, const Vector< Real > &x, Real eps=Real(0))
Set variables to zero if they correspond to the upper -active set.
Contains definitions of custom data types in ROL.
bool isActivated(void) const
Check if bounds are on.
void pruneUpperInactive(Vector< Real > &v, const Vector< Real > &x, Real eps=Real(0))
Set variables to zero if they correspond to the -inactive set.
bool Lactivated_
Flag that determines whether or not the lower bounds are being used.
bool isLowerActivated(void) const
Check if lower bound are on.
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
void activateUpper(void)
Turn on upper bound.
Ptr< Vector< Real > > lower_
void pruneLowerInactive(Vector< Real > &v, const Vector< Real > &x, Real eps=Real(0))
Set variables to zero if they correspond to the -inactive set.
void deactivateUpper(void)
Turn off upper bound.
virtual const Ptr< const Vector< Real > > getUpperBound(void) const
Return the ref count pointer to the upper bound vector.
virtual void pruneLowerActive(Vector< Real > &v, const Vector< Real > &x, Real eps=Real(0))
Set variables to zero if they correspond to the lower -active set.
void computeProjectedStep(Vector< Real > &v, const Vector< Real > &x)
Compute projected step.
void deactivateLower(void)
Turn off lower bound.
virtual void project(Vector< Real > &x)
Project optimization variables onto the bounds.
void pruneInactive(Vector< Real > &v, const Vector< Real > &x, Real eps=Real(0))
Set variables to zero if they correspond to the -inactive set.
void pruneActive(Vector< Real > &v, const Vector< Real > &x, Real eps=Real(0))
Set variables to zero if they correspond to the -active set.
Provides the interface to apply upper and lower bound constraints.
void computeProjectedGradient(Vector< Real > &g, const Vector< Real > &x)
Compute projected gradient.
bool isUpperActivated(void) const
Check if upper bound are on.
void deactivate(void)
Turn off bounds.
virtual const Ptr< const Vector< Real > > getLowerBound(void) const
Return the ref count pointer to the lower bound vector.