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

#include <ROL_RiskVector.hpp>

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

Public Member Functions

 RiskVector (Teuchos::ParameterList &parlist, const Teuchos::RCP< Vector< Real > > &vec, const Real stat=1.)
 
 RiskVector (const Teuchos::RCP< Vector< Real > > &vec, const bool augmented=false)
 
 RiskVector (const Teuchos::RCP< Vector< Real > > &vec, const std::vector< Real > &stat, const bool augmented=true)
 
void plus (const Vector< Real > &x)
 Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\). More...
 
void scale (const Real alpha)
 Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\). More...
 
void axpy (const Real alpha, const Vector< Real > &x)
 Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\). More...
 
Real dot (const Vector< Real > &x) const
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...
 
Real norm () const
 Returns \( \| y \| \) where \(y = \mathtt{*this}\). More...
 
const Real getStatistic (const int i=0) const
 
Teuchos::RCP< const Vector< Real > > getVector () const
 
Teuchos::RCP< Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
const Vector< Real > & dual (void) const
 Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout. More...
 
void setStatistic (const Real stat)
 
void setStatistic (const std::vector< Real > &stat)
 
void setVector (const Vector< Real > &vec)
 
- Public Member Functions inherited from ROL::Vector< Real >
virtual ~Vector ()
 
virtual void zero ()
 Set to zero vector. More...
 
virtual Teuchos::RCP< Vectorbasis (const int i) const
 Return i-th basis vector. More...
 
virtual int dimension () const
 Return dimension of the vector space. More...
 
virtual void set (const Vector &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...
 
virtual void applyUnary (const Elementwise::UnaryFunction< Real > &f)
 
virtual void applyBinary (const Elementwise::BinaryFunction< Real > &f, const Vector &x)
 
virtual Real reduce (const Elementwise::ReductionOp< Real > &r) const
 
virtual std::vector< Real > checkVector (const Vector< Real > &x, const Vector< Real > &y, const bool printToStream=true, std::ostream &outStream=std::cout) const
 Verify vector-space methods. More...
 

Private Types

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

Private Attributes

std::vector< Real > stat_
 
Teuchos::RCP< Vector< Real > > vec_
 
bool augmented_
 
uint nStat_
 
Teuchos::RCP< Vector< Real > > dual_vec1_
 
Teuchos::RCP< RiskVector< Real > > dual_vec_
 

Detailed Description

template<class Real>
class ROL::RiskVector< Real >

Definition at line 54 of file ROL_RiskVector.hpp.

Member Typedef Documentation

template<class Real>
typedef std::vector<Real>::size_type ROL::RiskVector< Real >::uint
private

Definition at line 55 of file ROL_RiskVector.hpp.

Constructor & Destructor Documentation

template<class Real>
ROL::RiskVector< Real >::RiskVector ( Teuchos::ParameterList &  parlist,
const Teuchos::RCP< Vector< Real > > &  vec,
const Real  stat = 1. 
)
inline

Definition at line 67 of file ROL_RiskVector.hpp.

Referenced by ROL::RiskVector< Real >::clone().

template<class Real>
ROL::RiskVector< Real >::RiskVector ( const Teuchos::RCP< Vector< Real > > &  vec,
const bool  augmented = false 
)
inline

Definition at line 102 of file ROL_RiskVector.hpp.

template<class Real>
ROL::RiskVector< Real >::RiskVector ( const Teuchos::RCP< Vector< Real > > &  vec,
const std::vector< Real > &  stat,
const bool  augmented = true 
)
inline

Definition at line 112 of file ROL_RiskVector.hpp.

Member Function Documentation

template<class Real>
void ROL::RiskVector< Real >::plus ( const Vector< Real > &  x)
inlinevirtual

Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).

Parameters
[in]xis the vector to be added to \(\mathtt{*this}\).

On return \(\mathtt{*this} = \mathtt{*this} + x\).


Implements ROL::Vector< Real >.

Definition at line 119 of file ROL_RiskVector.hpp.

References ROL::RiskVector< Real >::getStatistic(), ROL::RiskVector< Real >::getVector(), and ROL::RiskVector< Real >::nStat_.

template<class Real>
void ROL::RiskVector< Real >::scale ( const Real  alpha)
inlinevirtual

Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).

Parameters
[in]alphais the scaling of \(\mathtt{*this}\).

On return \(\mathtt{*this} = \alpha (\mathtt{*this}) \).


Implements ROL::Vector< Real >.

Definition at line 130 of file ROL_RiskVector.hpp.

References ROL::RiskVector< Real >::nStat_.

template<class Real>
void ROL::RiskVector< Real >::axpy ( const Real  alpha,
const Vector< Real > &  x 
)
inlinevirtual

Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\).

Parameters
[in]alphais the scaling of x.
[in]xis a vector.

On return \(\mathtt{*this} = \mathtt{*this} + \alpha x \). Uses clone, set, scale and plus for the computation. Please overload if a more efficient implementation is needed.


Reimplemented from ROL::Vector< Real >.

Definition at line 139 of file ROL_RiskVector.hpp.

References ROL::RiskVector< Real >::getStatistic(), ROL::RiskVector< Real >::getVector(), and ROL::RiskVector< Real >::nStat_.

template<class Real>
Real ROL::RiskVector< Real >::dot ( const Vector< Real > &  x) const
inlinevirtual

Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).

Parameters
[in]xis the vector that forms the dot product with \(\mathtt{*this}\).
Returns
The number equal to \(\langle \mathtt{*this}, x \rangle\).

Implements ROL::Vector< Real >.

Definition at line 150 of file ROL_RiskVector.hpp.

References ROL::RiskVector< Real >::getStatistic(), ROL::RiskVector< Real >::getVector(), and ROL::RiskVector< Real >::nStat_.

Referenced by ROL::RiskVector< Real >::norm().

template<class Real>
Real ROL::RiskVector< Real >::norm ( ) const
inlinevirtual

Returns \( \| y \| \) where \(y = \mathtt{*this}\).

Returns
A nonnegative number equal to the norm of \(\mathtt{*this}\).

Implements ROL::Vector< Real >.

Definition at line 162 of file ROL_RiskVector.hpp.

References ROL::RiskVector< Real >::dot().

template<class Real>
const Real ROL::RiskVector< Real >::getStatistic ( const int  i = 0) const
inline
template<class Real>
Teuchos::RCP<const Vector<Real> > ROL::RiskVector< Real >::getVector ( ) const
inline
template<class Real>
Teuchos::RCP<Vector<Real> > ROL::RiskVector< Real >::clone ( ) const
inlinevirtual

Clone to make a new (uninitialized) vector.

Returns
A reference-counted pointer to the cloned vector.

Provides the means of allocating temporary memory in ROL.


Implements ROL::Vector< Real >.

Definition at line 176 of file ROL_RiskVector.hpp.

References ROL::RiskVector< Real >::RiskVector().

template<class Real>
const Vector<Real>& ROL::RiskVector< Real >::dual ( void  ) const
inlinevirtual

Return dual representation of \(\mathtt{*this}\), for example, the result of applying a Riesz map, or change of basis, or change of memory layout.

Returns
A const reference to dual representation.

By default, returns the current object. Please overload if you need a dual representation.


Reimplemented from ROL::Vector< Real >.

Definition at line 183 of file ROL_RiskVector.hpp.

References ROL::RiskVector< Real >::dual_vec_.

template<class Real>
void ROL::RiskVector< Real >::setStatistic ( const Real  stat)
inline
template<class Real>
void ROL::RiskVector< Real >::setStatistic ( const std::vector< Real > &  stat)
inline

Definition at line 193 of file ROL_RiskVector.hpp.

template<class Real>
void ROL::RiskVector< Real >::setVector ( const Vector< Real > &  vec)
inline

Member Data Documentation

template<class Real>
std::vector<Real> ROL::RiskVector< Real >::stat_
private

Definition at line 58 of file ROL_RiskVector.hpp.

template<class Real>
Teuchos::RCP<Vector<Real> > ROL::RiskVector< Real >::vec_
private

Definition at line 59 of file ROL_RiskVector.hpp.

Referenced by ROL::RiskVector< Real >::getVector().

template<class Real>
bool ROL::RiskVector< Real >::augmented_
private

Definition at line 60 of file ROL_RiskVector.hpp.

template<class Real>
uint ROL::RiskVector< Real >::nStat_
private
template<class Real>
Teuchos::RCP<Vector<Real> > ROL::RiskVector< Real >::dual_vec1_
mutableprivate

Definition at line 63 of file ROL_RiskVector.hpp.

template<class Real>
Teuchos::RCP<RiskVector<Real> > ROL::RiskVector< Real >::dual_vec_
mutableprivate

Definition at line 64 of file ROL_RiskVector.hpp.

Referenced by ROL::RiskVector< Real >::dual().


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