ROL
ROL_RiskLessObjective.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_RISKLESSOBJECTIVE_HPP
45 #define ROL_RISKLESSOBJECTIVE_HPP
46 
47 #include "ROL_RiskVector.hpp"
48 #include "ROL_Objective.hpp"
49 
50 namespace ROL {
51 
52 template<class Real>
53 class RiskLessObjective : public Objective<Real> {
54 private:
55  const ROL::Ptr<Objective<Real> > obj_;
56 
57 public:
58  RiskLessObjective(const ROL::Ptr<Objective<Real> > &obj) : obj_(obj) {}
59 
60  void update( const Vector<Real> &x, bool flag = true, int iter = -1 ) {
61  ROL::Ptr<const Vector<Real> > x0
62  = dynamic_cast<const RiskVector<Real>&>(x).getVector();
63  obj_->update(*x0,flag,iter);
64  }
65 
66  Real value( const Vector<Real> &x, Real &tol ) {
67  ROL::Ptr<const Vector<Real> > x0
68  = dynamic_cast<const RiskVector<Real>&>(x).getVector();
69  return obj_->value(*x0,tol);
70  }
71 
72  void gradient( Vector<Real> &g, const Vector<Real> &x, Real &tol ) {
73  ROL::Ptr<Vector<Real> > g0
74  = dynamic_cast<RiskVector<Real>&>(g).getVector();
75  ROL::Ptr<const Vector<Real> > x0
76  = dynamic_cast<const RiskVector<Real>&>(x).getVector();
77  obj_->gradient(*g0,*x0,tol);
78  }
79 
80  void hessVec( Vector<Real> &hv, const Vector<Real> &v,
81  const Vector<Real> &x, Real &tol ) {
82  ROL::Ptr<Vector<Real> > hv0
83  = dynamic_cast<RiskVector<Real>&>(hv).getVector();
84  ROL::Ptr<const Vector<Real> > v0
85  = dynamic_cast<const RiskVector<Real>&>(v).getVector();
86  ROL::Ptr<const Vector<Real> > x0
87  = dynamic_cast<const RiskVector<Real>&>(x).getVector();
88  obj_->hessVec(*hv0,*v0,*x0,tol);
89  }
90 
91  void precond( Vector<Real> &Pv, const Vector<Real> &v,
92  const Vector<Real> &x, Real &tol ) {
93  ROL::Ptr<Vector<Real> > Pv0
94  = dynamic_cast<RiskVector<Real>&>(Pv).getVector();
95  ROL::Ptr<const Vector<Real> > v0
96  = dynamic_cast<const RiskVector<Real>&>(v).getVector();
97  ROL::Ptr<const Vector<Real> > x0
98  = dynamic_cast<const RiskVector<Real>&>(x).getVector();
99  obj_->precond(*Pv0,*v0,*x0,tol);
100  }
101 };
102 
103 }
104 
105 #endif
Provides the interface to evaluate objective functions.
RiskLessObjective(const ROL::Ptr< Objective< Real > > &obj)
const ROL::Ptr< Objective< Real > > obj_
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
void gradient(Vector< Real > &g, const Vector< Real > &x, Real &tol)
Compute gradient.
void update(const Vector< Real > &x, bool flag=true, int iter=-1)
Update objective function.
void hessVec(Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
Apply Hessian approximation to vector.
void precond(Vector< Real > &Pv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
Apply preconditioner to vector.
Real value(const Vector< Real > &x, Real &tol)
Compute value.