ROL
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
ROL::SeparableObjective< Real > Class Template Reference

#include <ROL_SeparableObjective.hpp>

Inheritance diagram for ROL::SeparableObjective< Real >:

Public Member Functions

 SeparableObjective (const std::vector< Ptr< Objective< Real > > > &obj)
const Ptr< Objective< Real > > get (unsigned i) const
void update (const Vector< Real > &x, UpdateType type, int iter=-1) override
void update (const Vector< Real > &x, bool flag=true, int iter=-1) override
Real value (const Vector< Real > &x, Real &tol) override
void gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol) override
void hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
void invHessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
void precond (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol) override
void setParameter (const std::vector< Real > &param) override
Public Member Functions inherited from ROL::ROL::Objective< Real >
virtual ~Objective ()
 Objective ()
virtual void update (const Vector< Real > &x, UpdateType type, int iter=-1)
 Update objective function.
virtual void update (const Vector< Real > &x, bool flag=true, int iter=-1)
 Update objective function.
virtual Real value (const Vector< Real > &x, Real &tol)=0
 Compute value.
virtual void gradient (Vector< Real > &g, const Vector< Real > &x, Real &tol)
 Compute gradient.
virtual Real dirDeriv (const Vector< Real > &x, const Vector< Real > &d, Real &tol)
 Compute directional derivative.
virtual void hessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply Hessian approximation to vector.
virtual void invHessVec (Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply inverse Hessian approximation to vector.
virtual void precond (Vector< Real > &Pv, const Vector< Real > &v, const Vector< Real > &x, Real &tol)
 Apply preconditioner to vector.
virtual void prox (Vector< Real > &Pv, const Vector< Real > &v, Real t, Real &tol)
 Compute the proximity operator.
virtual void proxJacVec (Vector< Real > &Jv, const Vector< Real > &v, const Vector< Real > &x, Real t, Real &tol)
 Apply the Jacobian of the proximity operator.
virtual std::vector< std::vector< Real > > checkGradient (const Vector< Real > &x, const Vector< Real > &d, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 Finite-difference gradient check.
virtual std::vector< std::vector< Real > > checkGradient (const Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &d, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 Finite-difference gradient check.
virtual std::vector< std::vector< Real > > checkGradient (const Vector< Real > &x, const Vector< Real > &d, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
 Finite-difference gradient check with specified step sizes.
virtual std::vector< std::vector< Real > > checkGradient (const Vector< Real > &x, const Vector< Real > &g, const Vector< Real > &d, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
 Finite-difference gradient check with specified step sizes.
virtual std::vector< std::vector< Real > > checkHessVec (const Vector< Real > &x, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 Finite-difference Hessian-applied-to-vector check.
virtual std::vector< std::vector< Real > > checkHessVec (const Vector< Real > &x, const Vector< Real > &hv, const Vector< Real > &v, const bool printToStream=true, std::ostream &outStream=std::cout, const int numSteps=ROL_NUM_CHECKDERIV_STEPS, const int order=1)
 Finite-difference Hessian-applied-to-vector check.
virtual std::vector< std::vector< Real > > checkHessVec (const Vector< Real > &x, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
 Finite-difference Hessian-applied-to-vector check with specified step sizes.
virtual std::vector< std::vector< Real > > checkHessVec (const Vector< Real > &x, const Vector< Real > &hv, const Vector< Real > &v, const std::vector< Real > &steps, const bool printToStream=true, std::ostream &outStream=std::cout, const int order=1)
 Finite-difference Hessian-applied-to-vector check with specified step sizes.
virtual std::vector< Real > checkHessSym (const Vector< Real > &x, const Vector< Real > &v, const Vector< Real > &w, const bool printToStream=true, std::ostream &outStream=std::cout)
 Hessian symmetry check.
virtual std::vector< Real > checkHessSym (const Vector< Real > &x, const Vector< Real > &hv, const Vector< Real > &v, const Vector< Real > &w, const bool printToStream=true, std::ostream &outStream=std::cout)
 Hessian symmetry check.
virtual std::vector< std::vector< Real > > checkProxJacVec (const Vector< Real > &x, const Vector< Real > &v, Real t=Real(1), bool printToStream=true, std::ostream &outStream=std::cout, int numSteps=ROL_NUM_CHECKDERIV_STEPS)
 Finite-difference proximity operator Jacobian-applied-to-vector check.

Private Attributes

const std::vector< Ptr< Objective< Real > > > obj_
size_t size_

Additional Inherited Members

Protected Member Functions inherited from ROL::ROL::Objective< Real >
const std::vector< Real > getParameter (void) const

Detailed Description

template<typename Real>
class ROL::SeparableObjective< Real >

Definition at line 21 of file ROL_SeparableObjective.hpp.

Constructor & Destructor Documentation

◆ SeparableObjective()

template<typename Real>
ROL::SeparableObjective< Real >::SeparableObjective ( const std::vector< Ptr< Objective< Real > > > & obj)

Definition at line 16 of file ROL_SeparableObjective_Def.hpp.

References obj_, ROL::ROL::Objective< Real >::Objective(), and size_.

Member Function Documentation

◆ get()

template<typename Real>
const Ptr< Objective< Real > > ROL::SeparableObjective< Real >::get ( unsigned i) const

Definition at line 20 of file ROL_SeparableObjective_Def.hpp.

References obj_, and size_.

◆ update() [1/2]

template<typename Real>
void ROL::SeparableObjective< Real >::update ( const Vector< Real > & x,
UpdateType type,
int iter = -1 )
override

Definition at line 28 of file ROL_SeparableObjective_Def.hpp.

References ROL::PartitionedVector< Real >::get(), ROL::PartitionedVector< Real >::numVectors(), obj_, size_, and update().

◆ update() [2/2]

template<typename Real>
void ROL::SeparableObjective< Real >::update ( const Vector< Real > & x,
bool flag = true,
int iter = -1 )
override

Definition at line 37 of file ROL_SeparableObjective_Def.hpp.

References ROL::PartitionedVector< Real >::get(), ROL::PartitionedVector< Real >::numVectors(), obj_, size_, and update().

◆ value()

template<typename Real>
Real ROL::SeparableObjective< Real >::value ( const Vector< Real > & x,
Real & tol )
override

Definition at line 46 of file ROL_SeparableObjective_Def.hpp.

References ROL::PartitionedVector< Real >::get(), ROL::PartitionedVector< Real >::numVectors(), obj_, size_, and ROL::value().

◆ gradient()

template<typename Real>
void ROL::SeparableObjective< Real >::gradient ( Vector< Real > & g,
const Vector< Real > & x,
Real & tol )
override

Definition at line 57 of file ROL_SeparableObjective_Def.hpp.

References ROL::PartitionedVector< Real >::get(), gradient(), ROL::PartitionedVector< Real >::numVectors(), obj_, and size_.

Referenced by gradient().

◆ hessVec()

template<typename Real>
void ROL::SeparableObjective< Real >::hessVec ( Vector< Real > & hv,
const Vector< Real > & v,
const Vector< Real > & x,
Real & tol )
override

Definition at line 70 of file ROL_SeparableObjective_Def.hpp.

References ROL::PartitionedVector< Real >::get(), hessVec(), ROL::PartitionedVector< Real >::numVectors(), obj_, and size_.

Referenced by hessVec().

◆ invHessVec()

template<typename Real>
void ROL::SeparableObjective< Real >::invHessVec ( Vector< Real > & hv,
const Vector< Real > & v,
const Vector< Real > & x,
Real & tol )
override

Definition at line 87 of file ROL_SeparableObjective_Def.hpp.

References ROL::PartitionedVector< Real >::get(), invHessVec(), ROL::PartitionedVector< Real >::numVectors(), obj_, and size_.

Referenced by invHessVec().

◆ precond()

template<typename Real>
void ROL::SeparableObjective< Real >::precond ( Vector< Real > & hv,
const Vector< Real > & v,
const Vector< Real > & x,
Real & tol )
override

Definition at line 104 of file ROL_SeparableObjective_Def.hpp.

References ROL::PartitionedVector< Real >::get(), ROL::PartitionedVector< Real >::numVectors(), obj_, precond(), and size_.

Referenced by precond().

◆ setParameter()

template<typename Real>
void ROL::SeparableObjective< Real >::setParameter ( const std::vector< Real > & param)
overridevirtual

Reimplemented from ROL::ROL::Objective< Real >.

Definition at line 121 of file ROL_SeparableObjective_Def.hpp.

References obj_, ROL::Objective< Real >::setParameter(), ROL::setParameter(), and size_.

Member Data Documentation

◆ obj_

template<typename Real>
const std::vector<Ptr<Objective<Real> > > ROL::SeparableObjective< Real >::obj_
private

Definition at line 23 of file ROL_SeparableObjective.hpp.

Referenced by get(), gradient(), hessVec(), invHessVec(), precond(), SeparableObjective(), setParameter(), update(), update(), and value().

◆ size_

template<typename Real>
size_t ROL::SeparableObjective< Real >::size_
private

Definition at line 24 of file ROL_SeparableObjective.hpp.

Referenced by get(), gradient(), hessVec(), invHessVec(), precond(), SeparableObjective(), setParameter(), update(), update(), and value().

The documentation for this class was generated from the following files:
Generated by doxygen 1.15.0