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

Provides the std::vector implementation of the ROL::Vector interface that handles scalings in the inner product. Also see ROL::DualScaledStdVector. More...

#include <ROL_ScaledStdVector.hpp>

Public Member Functions

 PrimalScaledStdVector (const Ptr< std::vector< Element > > &std_vec, const Ptr< std::vector< Element > > &scaling_vec)
 
Real dot (const Vector< Real > &x) const
 
Ptr< Vector< Real > > clone () const
 
const Vector< Real > & dual () const
 

Private Types

typedef std::vector< Element >::size_type uint
 

Private Attributes

Ptr< std::vector< Element > > scaling_vec_
 
Ptr< DualScaledStdVector< Real > > dual_vec_
 
bool isDualInitialized_
 

Detailed Description

template<class Real, class Element>
class ROL::PrimalScaledStdVector< Real, Element >

Provides the std::vector implementation of the ROL::Vector interface that handles scalings in the inner product. Also see ROL::DualScaledStdVector.

Definition at line 68 of file ROL_ScaledStdVector.hpp.

Member Typedef Documentation

◆ uint

template<class Real , class Element >
typedef std::vector<Element>::size_type ROL::PrimalScaledStdVector< Real, Element >::uint
private

Definition at line 70 of file ROL_ScaledStdVector.hpp.

Constructor & Destructor Documentation

◆ PrimalScaledStdVector()

template<class Real , class Element >
ROL::PrimalScaledStdVector< Real, Element >::PrimalScaledStdVector ( const Ptr< std::vector< Element > > &  std_vec,
const Ptr< std::vector< Element > > &  scaling_vec 
)
inline

Definition at line 80 of file ROL_ScaledStdVector.hpp.

Member Function Documentation

◆ dot()

template<class Real , class Element >
Real ROL::PrimalScaledStdVector< Real, Element >::dot ( const Vector< Real > &  x) const
inline

Definition at line 85 of file ROL_ScaledStdVector.hpp.

References ROL::StdVector< Real, Element >::getVector().

Referenced by main().

◆ clone()

template<class Real , class Element >
Ptr<Vector<Real> > ROL::PrimalScaledStdVector< Real, Element >::clone ( void  ) const
inline

◆ dual()

template<class Real , class Element >
const Vector<Real>& ROL::PrimalScaledStdVector< Real, Element >::dual ( void  ) const
inline

Member Data Documentation

◆ scaling_vec_

template<class Real , class Element >
Ptr<std::vector<Element> > ROL::PrimalScaledStdVector< Real, Element >::scaling_vec_
private

◆ dual_vec_

template<class Real , class Element >
Ptr<DualScaledStdVector<Real> > ROL::PrimalScaledStdVector< Real, Element >::dual_vec_
mutableprivate

◆ isDualInitialized_

template<class Real , class Element >
bool ROL::PrimalScaledStdVector< Real, Element >::isDualInitialized_
mutableprivate

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