ROL
Public Member Functions | Private Types | Private Attributes | List of all members
ROL::PrimalScaledStdVector Class 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

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

Definition at line 62 of file ROL_ScaledStdVector.hpp.

Member Typedef Documentation

◆ uint

typedef std::vector<Element>::size_type ROL::PrimalScaledStdVector::uint
private

Definition at line 70 of file ROL_ScaledStdVector.hpp.

Constructor & Destructor Documentation

◆ PrimalScaledStdVector()

ROL::PrimalScaledStdVector::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()

Real ROL::PrimalScaledStdVector::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()

Ptr<Vector<Real> > ROL::PrimalScaledStdVector::clone ( ) const
inline

Definition at line 97 of file ROL_ScaledStdVector.hpp.

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

Referenced by main().

◆ dual()

const Vector<Real>& ROL::PrimalScaledStdVector::dual ( ) const
inline

Member Data Documentation

◆ scaling_vec_

Ptr<std::vector<Element> > ROL::PrimalScaledStdVector::scaling_vec_
private

Definition at line 74 of file ROL_ScaledStdVector.hpp.

Referenced by clone(), and dual().

◆ dual_vec_

Ptr<DualScaledStdVector<Real> > ROL::PrimalScaledStdVector::dual_vec_
mutableprivate

Definition at line 75 of file ROL_ScaledStdVector.hpp.

Referenced by dual().

◆ isDualInitialized_

bool ROL::PrimalScaledStdVector::isDualInitialized_
mutableprivate

Definition at line 76 of file ROL_ScaledStdVector.hpp.

Referenced by dual().


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