ROL
ROL_StdObjective.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_STDOBJECTIVE_H
45#define ROL_STDOBJECTIVE_H
46
47#include "ROL_Objective.hpp"
48#include "ROL_StdVector.hpp"
49
57namespace ROL {
58
59template<typename Real>
60class StdObjective : public virtual Objective<Real> {
61public:
62 virtual void update( const std::vector<Real> &x, bool flag = true, int iter = -1 ) {}
63
64 using Objective<Real>::update;
65 void update( const Vector<Real> &x, bool flag = true, int iter = -1 ) override;
66
67 virtual void update( const std::vector<Real> &x, UpdateType type, int iter = -1 ) {}
68
69 void update( const Vector<Real> &x, UpdateType type, int iter = -1 ) override;
70
71 virtual Real value( const std::vector<Real> &x, Real &tol ) = 0;
72
73 using Objective<Real>::value;
74 Real value( const Vector<Real> &x, Real &tol ) override;
75
76 virtual void gradient( std::vector<Real> &g, const std::vector<Real> &x, Real &tol );
77
78 using Objective<Real>::gradient;
79 void gradient( Vector<Real> &g, const Vector<Real> &x, Real &tol ) override;
80
81 virtual Real dirDeriv( const std::vector<Real> &x, const std::vector<Real> &d, Real &tol );
82
83 using Objective<Real>::dirDeriv;
84 Real dirDeriv( const Vector<Real> &x, const Vector<Real> &d, Real &tol ) override;
85
86 virtual void hessVec( std::vector<Real> &hv, const std::vector<Real> &v, const std::vector<Real> &x, Real &tol );
87
88 using Objective<Real>::hessVec;
89 void hessVec( Vector<Real> &hv, const Vector<Real> &v, const Vector<Real> &x, Real &tol ) override;
90
91 virtual void invHessVec( std::vector<Real> &hv, const std::vector<Real> &v, const std::vector<Real> &x, Real &tol );
92
93 using Objective<Real>::invHessVec;
94 void invHessVec( Vector<Real> &hv, const Vector<Real> &v, const Vector<Real> &x, Real &tol ) override;
95
96 virtual void precond( std::vector<Real> &Pv, const std::vector<Real> &v, const std::vector<Real> &x, Real &tol );
97
98 using Objective<Real>::precond;
99 void precond( Vector<Real> &Pv, const Vector<Real> &v, const Vector<Real> &x, Real &tol ) override;
100
101private:
102 Real sgn(Real x) const;
103
104};
105
106} // namespace ROL
107
109
110#endif
Provides the interface to evaluate objective functions.
Specializes the ROL::Objective interface for objective functions that operate on ROL::StdVector's.
virtual Real dirDeriv(const std::vector< Real > &x, const std::vector< Real > &d, Real &tol)
virtual void update(const std::vector< Real > &x, UpdateType type, int iter=-1)
virtual void invHessVec(std::vector< Real > &hv, const std::vector< Real > &v, const std::vector< Real > &x, Real &tol)
virtual void precond(std::vector< Real > &Pv, const std::vector< Real > &v, const std::vector< Real > &x, Real &tol)
virtual void update(const std::vector< Real > &x, bool flag=true, int iter=-1)
virtual void hessVec(std::vector< Real > &hv, const std::vector< Real > &v, const std::vector< Real > &x, Real &tol)
virtual Real value(const std::vector< Real > &x, Real &tol)=0
virtual void gradient(std::vector< Real > &g, const std::vector< Real > &x, Real &tol)
Defines the linear algebra or vector space interface.