ROL
ROL_RiskLessObjective_Def.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_DEF_HPP
45 #define ROL_RISKLESSOBJECTIVE_DEF_HPP
46 
47 namespace ROL {
48 
49 template<typename Real>
51 
52 template<typename Real>
53 void RiskLessObjective<Real>::update( const Vector<Real> &x, UpdateType type, int iter ) {
54  Ptr<const Vector<Real>> x0
55  = dynamic_cast<const RiskVector<Real>&>(x).getVector();
56  obj_->update(*x0,type,iter);
57 }
58 
59 template<typename Real>
60 void RiskLessObjective<Real>::update( const Vector<Real> &x, bool flag, int iter ) {
61  Ptr<const Vector<Real>> x0
62  = dynamic_cast<const RiskVector<Real>&>(x).getVector();
63  obj_->update(*x0,flag,iter);
64 }
65 
66 template<typename Real>
67 Real RiskLessObjective<Real>::value( const Vector<Real> &x, Real &tol ) {
68  Ptr<const Vector<Real>> x0
69  = dynamic_cast<const RiskVector<Real>&>(x).getVector();
70  return obj_->value(*x0,tol);
71 }
72 
73 template<typename Real>
75  Ptr<Vector<Real>> g0
76  = dynamic_cast<RiskVector<Real>&>(g).getVector();
77  Ptr<const Vector<Real>> x0
78  = dynamic_cast<const RiskVector<Real>&>(x).getVector();
79  obj_->gradient(*g0,*x0,tol);
80 }
81 
82 template<typename Real>
84  const Vector<Real> &x, Real &tol ) {
85  Ptr<Vector<Real>> hv0
86  = dynamic_cast<RiskVector<Real>&>(hv).getVector();
87  Ptr<const Vector<Real>> v0
88  = dynamic_cast<const RiskVector<Real>&>(v).getVector();
89  Ptr<const Vector<Real>> x0
90  = dynamic_cast<const RiskVector<Real>&>(x).getVector();
91  obj_->hessVec(*hv0,*v0,*x0,tol);
92 }
93 
94 template<typename Real>
96  const Vector<Real> &x, Real &tol ) {
97  Ptr<Vector<Real>> Pv0
98  = dynamic_cast<RiskVector<Real>&>(Pv).getVector();
99  Ptr<const Vector<Real>> v0
100  = dynamic_cast<const RiskVector<Real>&>(v).getVector();
101  Ptr<const Vector<Real>> x0
102  = dynamic_cast<const RiskVector<Real>&>(x).getVector();
103  obj_->precond(*Pv0,*v0,*x0,tol);
104 }
105 
106 template<typename Real>
107 void RiskLessObjective<Real>::setParameter(const std::vector<Real> &param) {
109  obj_->setParameter(param);
110 }
111 
112 }
113 
114 #endif
Provides the interface to evaluate objective functions.
void setParameter(const std::vector< Real > &param) override
void precond(Vector< Real > &Pv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
Apply preconditioner to vector.
Defines the linear algebra or vector space interface.
Definition: ROL_Vector.hpp:80
RiskLessObjective(const Ptr< Objective< Real >> &obj)
void hessVec(Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
Apply Hessian approximation to vector.
void update(const Vector< Real > &x, UpdateType type, int iter=-1) override
Update objective function.
Real value(const Vector< Real > &x, Real &tol) override
Compute value.
virtual void setParameter(const std::vector< Real > &param)
const Ptr< Obj > obj_
void gradient(Vector< Real > &g, const Vector< Real > &x, Real &tol) override
Compute gradient.