ROL
Public Member Functions | Protected Attributes | Private Attributes | List of all members
ROL::ROL::Secant< Real > Class Template Referenceabstract

#include <ROL_Constraint_SerialSimOpt.hpp>

Inheritance diagram for ROL::ROL::Secant< Real >:

Public Member Functions

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)
virtual void applyH (Vector< Real > &Hv, const Vector< Real > &v) const =0
virtual void applyH0 (Vector< Real > &Hv, const Vector< Real > &v) const
virtual void applyB (Vector< Real > &Bv, const Vector< Real > &v) const =0
virtual void applyB0 (Vector< Real > &Bv, const Vector< Real > &v) const
void test (std::ostream &stream=std::cout) const
void apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply linear operator.
void applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply inverse of linear operator.
Public Member Functions inherited from ROL::ROL::LinearOperator< Real >
virtual ~LinearOperator ()
virtual void update (const Vector< Real > &x, bool flag=true, int iter=-1)
 Update linear operator.
virtual void applyAdjoint (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply adjoint of linear operator.
virtual void applyAdjointInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply adjoint of the inverse linear operator.

Protected Attributes

const Ptr< SecantState< Real > > state_
Ptr< Vector< Real > > y_
bool useDefaultScaling_
Real Bscaling_

Private Attributes

bool isInitialized_

Detailed Description

template<class Real>
class ROL::ROL::Secant< Real >

Definition at line 45 of file ROL_Constraint_SerialSimOpt.hpp.

Constructor & Destructor Documentation

◆ ~Secant()

template<class Real>
virtual ROL::ROL::Secant< Real >::~Secant ( )
inlinevirtual

Definition at line 59 of file ROL_Constraint_SerialSimOpt.hpp.

◆ Secant()

template<class Real>
ROL::ROL::Secant< Real >::Secant ( int M = 10,
bool useDefaultScaling = true,
Real Bscaling = Real(1),
ESecantMode mode = SECANTMODE_BOTH )
inline

Definition at line 62 of file ROL_Constraint_SerialSimOpt.hpp.

Referenced by ROL::lBFGS< Real >::lBFGS(), ROL::lDFP< Real >::lDFP(), and ROL::lSR1< Real >::lSR1().

Member Function Documentation

◆ get_state() [1/2]

template<class Real>
Ptr< SecantState< Real > > & ROL::ROL::Secant< Real >::get_state ( )
inline

Definition at line 67 of file ROL_Constraint_SerialSimOpt.hpp.

◆ get_state() [2/2]

template<class Real>
const Ptr< SecantState< Real > > & ROL::ROL::Secant< Real >::get_state ( ) const
inline

Definition at line 68 of file ROL_Constraint_SerialSimOpt.hpp.

◆ updateStorage()

template<class Real>
virtual void ROL::ROL::Secant< Real >::updateStorage ( const Vector< Real > & x,
const Vector< Real > & grad,
const Vector< Real > & gp,
const Vector< Real > & s,
const Real snorm,
const int iter )
inlinevirtual

Reimplemented in ROL::ROL::lSR1< Real >.

Definition at line 71 of file ROL_Constraint_SerialSimOpt.hpp.

◆ applyH()

template<class Real>
virtual void ROL::ROL::Secant< Real >::applyH ( Vector< Real > & Hv,
const Vector< Real > & v ) const
pure virtual

Implemented in ROL::ROL::BarzilaiBorwein< Real >, ROL::ROL::lBFGS< Real >, ROL::ROL::lDFP< Real >, and ROL::ROL::lSR1< Real >.

References ui_.

◆ applyH0()

template<class Real>
virtual void ROL::ROL::Secant< Real >::applyH0 ( Vector< Real > & Hv,
const Vector< Real > & v ) const
inlinevirtual

Reimplemented in ROL::ROL::lDFP< Real >, and ROL::ROL::lSR1< Real >.

Definition at line 110 of file ROL_Constraint_SerialSimOpt.hpp.

◆ applyB()

template<class Real>
virtual void ROL::ROL::Secant< Real >::applyB ( Vector< Real > & Bv,
const Vector< Real > & v ) const
pure virtual

Implemented in ROL::ROL::BarzilaiBorwein< Real >, ROL::ROL::lBFGS< Real >, ROL::ROL::lDFP< Real >, and ROL::ROL::lSR1< Real >.

◆ applyB0()

template<class Real>
virtual void ROL::ROL::Secant< Real >::applyB0 ( Vector< Real > & Bv,
const Vector< Real > & v ) const
inlinevirtual

Reimplemented in ROL::ROL::lDFP< Real >, and ROL::ROL::lSR1< Real >.

Definition at line 127 of file ROL_Constraint_SerialSimOpt.hpp.

◆ test()

template<class Real>
void ROL::ROL::Secant< Real >::test ( std::ostream & stream = std::cout) const
inline

Definition at line 141 of file ROL_Constraint_SerialSimOpt.hpp.

◆ apply()

template<class Real>
void ROL::ROL::Secant< Real >::apply ( Vector< Real > & Hv,
const Vector< Real > & v,
Real & tol ) const
inlinevirtual

Apply linear operator.

This function applies the linear operator to a vector.

Parameters
[out]Hvis the output vector.
[in]vis the input vector.
[in]tolis a tolerance for inexact linear operator application.

Implements ROL::ROL::LinearOperator< Real >.

Definition at line 164 of file ROL_Constraint_SerialSimOpt.hpp.

Referenced by ROL::lBFGS< Real >::applyB().

◆ applyInverse()

template<class Real>
void ROL::ROL::Secant< Real >::applyInverse ( Vector< Real > & Hv,
const Vector< Real > & v,
Real & tol ) const
inlinevirtual

Apply inverse of linear operator.

This function applies the inverse of linear operator to a vector.

Parameters
[out]Hvis the output vector.
[in]vis the input vector.
[in]tolis a tolerance for inexact linear operator application.

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

Definition at line 168 of file ROL_Constraint_SerialSimOpt.hpp.

Member Data Documentation

◆ state_

template<class Real>
const Ptr<SecantState<Real> > ROL::ROL::Secant< Real >::state_
protected

Definition at line 48 of file ROL_Constraint_SerialSimOpt.hpp.

Referenced by ROL::lBFGS< Real >::applyB(), ROL::lDFP< Real >::applyB(), ROL::lSR1< Real >::applyB(), ROL::lDFP< Real >::applyB0(), ROL::lSR1< Real >::applyB0(), ROL::lBFGS< Real >::applyH(), ROL::lDFP< Real >::applyH(), ROL::lSR1< Real >::applyH(), ROL::lDFP< Real >::applyH0(), ROL::lSR1< Real >::applyH0(), and ROL::lSR1< Real >::updateStorage().

◆ y_

template<class Real>
Ptr<Vector<Real> > ROL::ROL::Secant< Real >::y_
protected

Definition at line 49 of file ROL_Constraint_SerialSimOpt.hpp.

Referenced by ROL::lSR1< Real >::updateStorage().

◆ useDefaultScaling_

template<class Real>
bool ROL::ROL::Secant< Real >::useDefaultScaling_
protected

Definition at line 50 of file ROL_Constraint_SerialSimOpt.hpp.

Referenced by ROL::lDFP< Real >::applyB0(), ROL::lDFP< Real >::applyH0(), ROL::lSR1< Real >::lSR1(), and ROL::lSR1< Real >::updateStorage().

◆ Bscaling_

template<class Real>
Real ROL::ROL::Secant< Real >::Bscaling_
protected

Definition at line 51 of file ROL_Constraint_SerialSimOpt.hpp.

Referenced by ROL::lDFP< Real >::applyB0(), ROL::lSR1< Real >::applyB0(), ROL::lDFP< Real >::applyH0(), ROL::lSR1< Real >::applyH0(), ROL::lSR1< Real >::lSR1(), and ROL::lSR1< Real >::updateStorage().

◆ isInitialized_

template<class Real>
bool ROL::ROL::Secant< Real >::isInitialized_
private

Definition at line 55 of file ROL_Constraint_SerialSimOpt.hpp.

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