ROL
Loading...
Searching...
No Matches
ROL_SeparableObjective.hpp
Go to the documentation of this file.
1// @HEADER
2// *****************************************************************************
3// Rapid Optimization Library (ROL) Package
4//
5// Copyright 2014 NTESS and the ROL contributors.
6// SPDX-License-Identifier: BSD-3-Clause
7// *****************************************************************************
8// @HEADER
9
10#ifndef ROL_SEPARABLEOBJECTIVE_H
11#define ROL_SEPARABLEOBJECTIVE_H
12
13#include "ROL_Objective.hpp"
14#include "ROL_Ptr.hpp"
16#include <vector>
17
18namespace ROL {
19
20template<typename Real>
21class SeparableObjective : public Objective<Real> {
22private:
23 const std::vector<Ptr<Objective<Real>>> obj_;
24 size_t size_;
25
26public:
27 SeparableObjective(const std::vector<Ptr<Objective<Real>>> &obj);
28 const Ptr<Objective<Real>> get(unsigned i) const;
29 void update(const Vector<Real> &x, UpdateType type, int iter = -1) override;
30 void update(const Vector<Real> &x, bool flag = true, int iter = -1) override;
31 Real value( const Vector<Real> &x, Real &tol ) override;
32 void gradient( Vector<Real> &g, const Vector<Real> &x, Real &tol ) override;
33 void hessVec( Vector<Real> &hv, const Vector<Real> &v, const Vector<Real> &x, Real &tol ) override;
34 void invHessVec( Vector<Real> &hv, const Vector<Real> &v, const Vector<Real> &x, Real &tol ) override;
35 void precond( Vector<Real> &hv, const Vector<Real> &v, const Vector<Real> &x, Real &tol ) override;
36 void setParameter(const std::vector<Real> &param) override;
37
38}; // class SeparableObjective
39
40} // namespace ROL
41
43
44#endif
Provides the interface to evaluate objective functions.
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.
void gradient(Vector< Real > &g, const Vector< Real > &x, Real &tol) override
Compute gradient.
const std::vector< Ptr< Objective< Real > > > obj_
void precond(Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
Apply preconditioner to vector.
void setParameter(const std::vector< Real > &param) override
void hessVec(Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
Apply Hessian approximation to vector.
void invHessVec(Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
Apply inverse Hessian approximation to vector.
const Ptr< Objective< Real > > get(unsigned i) const
Defines the linear algebra or vector space interface.