ROL
lDFP Class Reference

Provides definitions for limited-memory DFP operators. More...

#include <ROL_lDFP.hpp>

+ Inheritance diagram for lDFP:

Public Member Functions

 lDFP (int M, bool useDefaultScaling=true, Real Bscaling=Real(1))
 
void applyH (Vector< Real > &Hv, const Vector< Real > &v) const
 
virtual void applyH0 (Vector< Real > &Hv, const Vector< Real > &v) const
 
void applyB (Vector< Real > &Bv, const Vector< Real > &v) const
 
virtual void applyB0 (Vector< Real > &Bv, const Vector< Real > &v) const
 
- Public Member Functions inherited from Secant< Real >
virtual ~Secant ()
 
 Secant (int M=10, bool useDefaultScaling=true, Real Bscaling=Real(1), ESecantMode mode=SECANTMODE_BOTH)
 
Ptr< SecantState< Real > > & get_state ()
 
const Ptr< SecantState< Real > > & get_state () const
 
virtual void updateStorage (const Vector< Real > &x, const Vector< Real > &grad, const Vector< Real > &gp, const Vector< Real > &s, const Real snorm, const int iter)
 
void test (std::ostream &stream=std::cout) const
 
void apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 
void applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 

Additional Inherited Members

- Protected Attributes inherited from Secant< Real >
const Ptr< SecantState< Real > > state_
 
Ptr< Vector< Real > > y_
 
bool useDefaultScaling_
 
Real Bscaling_
 

Detailed Description

Provides definitions for limited-memory DFP operators.

Constructor & Destructor Documentation

◆ lDFP()

lDFP::lDFP ( int M,
bool useDefaultScaling = true,
Real Bscaling = Real(1) )
inline

Definition at line 63 of file ROL_lDFP.hpp.

Member Function Documentation

◆ applyH()

void lDFP::applyH ( Vector< Real > & Hv,
const Vector< Real > & v ) const
inlinevirtual

Implements Secant< Real >.

Definition at line 67 of file ROL_lDFP.hpp.

References lDFP::applyH0(), and Secant< Real >::state_.

◆ applyH0()

virtual void lDFP::applyH0 ( Vector< Real > & Hv,
const Vector< Real > & v ) const
inlinevirtual

Reimplemented from Secant< Real >.

Definition at line 105 of file ROL_lDFP.hpp.

References Secant< Real >::Bscaling_, Secant< Real >::state_, and Secant< Real >::useDefaultScaling_.

Referenced by lDFP::applyH().

◆ applyB()

void lDFP::applyB ( Vector< Real > & Bv,
const Vector< Real > & v ) const
inlinevirtual

Implements Secant< Real >.

Definition at line 119 of file ROL_lDFP.hpp.

References lDFP::applyB0(), Secant< Real >::state_, and zero.

◆ applyB0()

virtual void lDFP::applyB0 ( Vector< Real > & Bv,
const Vector< Real > & v ) const
inlinevirtual

Reimplemented from Secant< Real >.

Definition at line 145 of file ROL_lDFP.hpp.

References Secant< Real >::Bscaling_, Secant< Real >::state_, and Secant< Real >::useDefaultScaling_.

Referenced by lDFP::applyB().


The documentation for this class was generated from the following file: