ROL
Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
ROL::StdTridiagonalOperator< Real > Class Template Reference

Provides the std::vector implementation to apply a linear operator, which encapsulates a tridiagonal matrix. More...

#include <ROL_StdTridiagonalOperator.hpp>

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

Public Member Functions

 StdTridiagonalOperator (const ROL::Ptr< const vector< Real > > &a, const ROL::Ptr< const vector< Real > > &b, const ROL::Ptr< const vector< Real > > &c)
 
 StdTridiagonalOperator (const ROL::Ptr< const vector< Real > > &a, const ROL::Ptr< const vector< Real > > &b)
 
virtual ~StdTridiagonalOperator ()
 
virtual void apply (vector< Real > &Hv, const vector< Real > &v, Real &tol) const
 
virtual void applyAdjoint (vector< Real > &Hv, const vector< Real > &v, Real &tol) const
 
virtual void applyInverse (vector< Real > &Hv, const vector< Real > &v, Real &tol) const
 
virtual void applyAdjointInverse (vector< Real > &Hv, const vector< Real > &v, Real &tol) const
 
- Public Member Functions inherited from ROL::StdLinearOperator< Real >
 StdLinearOperator ()
 
 StdLinearOperator (ROL::Ptr< std::vector< Real > > &A)
 
virtual ~StdLinearOperator ()
 
void update (const Vector< Real > &x, bool flag=true, int iter=-1)
 Update linear operator. More...
 
virtual void update (const std::vector< Real > &x, bool flag=true, int iter=-1)
 
void apply (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply linear operator. More...
 
virtual void apply (std::vector< Real > &Hv, const std::vector< Real > &v, Real &tol) const
 
void applyAdjoint (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply adjoint of linear operator. More...
 
virtual void applyAdjoint (std::vector< Real > &Hv, const std::vector< Real > &v, Real &tol) const
 
void applyInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply inverse of linear operator. More...
 
virtual void applyInverse (std::vector< Real > &Hv, const std::vector< Real > &v, Real &tol) const
 
void applyAdjointInverse (Vector< Real > &Hv, const Vector< Real > &v, Real &tol) const
 Apply adjoint of the inverse linear operator. More...
 
virtual void applyAdjointInverse (std::vector< Real > &Hv, const std::vector< Real > &v, Real &tol) const
 
- Public Member Functions inherited from ROL::LinearOperator< Real >
virtual ~LinearOperator ()
 

Private Types

template<typename T >
using vector = std::vector< T >
 

Private Member Functions

void copy (void) const
 

Private Attributes

const ROL::Ptr< const vector
< Real > > 
a_
 
const ROL::Ptr< const vector
< Real > > 
b_
 
const ROL::Ptr< const vector
< Real > > 
c_
 
vector< Real > dl_
 
vector< Real > d_
 
vector< Real > du_
 
vector< Real > du2_
 
vector< int > ipiv_
 
int N_
 
ROL::LAPACK< int, Real > lapack_
 

Detailed Description

template<class Real>
class ROL::StdTridiagonalOperator< Real >

Provides the std::vector implementation to apply a linear operator, which encapsulates a tridiagonal matrix.

\[ T = \begin{matrix} a_0 & b_0 \\ c_0 & a_1 & b_1 \\ & c_1 & \ddots & \ddots \\ & & \ddots & a_{n-2} & b_{n-2} \\ & & & c_{n-2} & a_{n-1} \end{pmatrix} \]

Definition at line 34 of file ROL_StdTridiagonalOperator.hpp.

Member Typedef Documentation

template<class Real >
template<typename T >
using ROL::StdTridiagonalOperator< Real >::vector = std::vector<T>
private

Definition at line 36 of file ROL_StdTridiagonalOperator.hpp.

Constructor & Destructor Documentation

template<class Real >
ROL::StdTridiagonalOperator< Real >::StdTridiagonalOperator ( const ROL::Ptr< const vector< Real > > &  a,
const ROL::Ptr< const vector< Real > > &  b,
const ROL::Ptr< const vector< Real > > &  c 
)
inline
template<class Real >
ROL::StdTridiagonalOperator< Real >::StdTridiagonalOperator ( const ROL::Ptr< const vector< Real > > &  a,
const ROL::Ptr< const vector< Real > > &  b 
)
inline

Definition at line 81 of file ROL_StdTridiagonalOperator.hpp.

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

Definition at line 87 of file ROL_StdTridiagonalOperator.hpp.

Member Function Documentation

template<class Real >
void ROL::StdTridiagonalOperator< Real >::copy ( void  ) const
inlineprivate
template<class Real >
virtual void ROL::StdTridiagonalOperator< Real >::apply ( vector< Real > &  Hv,
const vector< Real > &  v,
Real &  tol 
) const
inlinevirtual
template<class Real >
virtual void ROL::StdTridiagonalOperator< Real >::applyAdjoint ( vector< Real > &  Hv,
const vector< Real > &  v,
Real &  tol 
) const
inlinevirtual
template<class Real >
virtual void ROL::StdTridiagonalOperator< Real >::applyInverse ( vector< Real > &  Hv,
const vector< Real > &  v,
Real &  tol 
) const
inlinevirtual
template<class Real >
virtual void ROL::StdTridiagonalOperator< Real >::applyAdjointInverse ( vector< Real > &  Hv,
const vector< Real > &  v,
Real &  tol 
) const
inlinevirtual

Member Data Documentation

template<class Real >
const ROL::Ptr<const vector<Real> > ROL::StdTridiagonalOperator< Real >::a_
private
template<class Real >
const ROL::Ptr<const vector<Real> > ROL::StdTridiagonalOperator< Real >::b_
private

Definition at line 41 of file ROL_StdTridiagonalOperator.hpp.

template<class Real >
const ROL::Ptr<const vector<Real> > ROL::StdTridiagonalOperator< Real >::c_
private

Definition at line 42 of file ROL_StdTridiagonalOperator.hpp.

template<class Real >
vector<Real> ROL::StdTridiagonalOperator< Real >::dl_
mutableprivate
template<class Real >
vector<Real> ROL::StdTridiagonalOperator< Real >::d_
mutableprivate
template<class Real >
vector<Real> ROL::StdTridiagonalOperator< Real >::du_
mutableprivate
template<class Real >
vector<Real> ROL::StdTridiagonalOperator< Real >::du2_
mutableprivate
template<class Real >
vector<int> ROL::StdTridiagonalOperator< Real >::ipiv_
mutableprivate
template<class Real >
int ROL::StdTridiagonalOperator< Real >::N_
private
template<class Real >
ROL::LAPACK<int,Real> ROL::StdTridiagonalOperator< Real >::lapack_
private

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