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

Provides interface for and implements limited-memory secant operators. More...

#include <ROL_Secant.hpp>

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

Public Member Functions

virtual ~Secant ()
 
 Secant (int M=10)
 
Teuchos::RCP< SecantState< Real > > & get_state ()
 
virtual void update (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 Vector< Real > &x)=0
 
virtual void applyH0 (Vector< Real > &Hv, const Vector< Real > &v, const Vector< Real > &x)
 
virtual void applyB (Vector< Real > &Bv, const Vector< Real > &v, const Vector< Real > &x)=0
 
virtual void applyB0 (Vector< Real > &Bv, const Vector< Real > &v, const Vector< Real > &x)
 
void test (const Vector< Real > &x, const Vector< Real > &s)
 

Private Attributes

Teuchos::RCP< SecantState< Real > > state_
 

Detailed Description

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

Provides interface for and implements limited-memory secant operators.

Definition at line 68 of file ROL_Secant.hpp.

Constructor & Destructor Documentation

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

Definition at line 75 of file ROL_Secant.hpp.

template<class Real >
ROL::Secant< Real >::Secant ( int  M = 10)
inline

Definition at line 78 of file ROL_Secant.hpp.

Member Function Documentation

template<class Real >
Teuchos::RCP<SecantState<Real> >& ROL::Secant< Real >::get_state ( )
inline
template<class Real >
virtual void ROL::Secant< Real >::update ( const Vector< Real > &  grad,
const Vector< Real > &  gp,
const Vector< Real > &  s,
const Real  snorm,
const int  iter 
)
inlinevirtual
template<class Real >
virtual void ROL::Secant< Real >::applyH ( Vector< Real > &  Hv,
const Vector< Real > &  v,
const Vector< Real > &  x 
)
pure virtual
template<class Real >
virtual void ROL::Secant< Real >::applyH0 ( Vector< Real > &  Hv,
const Vector< Real > &  v,
const Vector< Real > &  x 
)
inlinevirtual
template<class Real >
virtual void ROL::Secant< Real >::applyB ( Vector< Real > &  Bv,
const Vector< Real > &  v,
const Vector< Real > &  x 
)
pure virtual
template<class Real >
virtual void ROL::Secant< Real >::applyB0 ( Vector< Real > &  Bv,
const Vector< Real > &  v,
const Vector< Real > &  x 
)
inlinevirtual
template<class Real >
void ROL::Secant< Real >::test ( const Vector< Real > &  x,
const Vector< Real > &  s 
)
inline

Definition at line 138 of file ROL_Secant.hpp.

References ROL::Vector< Real >::clone().

Member Data Documentation

template<class Real >
Teuchos::RCP<SecantState<Real> > ROL::Secant< Real >::state_
private

Definition at line 71 of file ROL_Secant.hpp.


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