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

Defines the linear algebra or vector space interface for simulation-based optimization. More...

#include <ROL_Vector_SimOpt.hpp>

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

Public Member Functions

 Vector_SimOpt (const Teuchos::RCP< Vector< Real > > &vec1, const Teuchos::RCP< Vector< Real > > &vec2)
 
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...
 
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...
 
Teuchos::RCP< Vector< Real > > basis (const int i) const
 Return i-th basis vector. More...
 
int dimension () const
 Return dimension of the vector space. More...
 
Teuchos::RCP< const Vector< Real > > get_1 () const
 
Teuchos::RCP< const Vector< Real > > get_2 () const
 
void set_1 (const Vector< Real > &vec)
 
void set_2 (const Vector< Real > &vec)
 
- Public Member Functions inherited from ROL::Vector< Real >
virtual ~Vector ()
 
virtual void zero ()
 Set to zero vector. 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 Attributes

Teuchos::RCP< Vector< Real > > vec1_
 
Teuchos::RCP< Vector< Real > > vec2_
 
Teuchos::RCP< Vector< Real > > dual_vec1_
 
Teuchos::RCP< Vector< Real > > dual_vec2_
 
Teuchos::RCP< Vector_SimOpt< Real > > dual_vec_
 

Detailed Description

template<class Real>
class ROL::Vector_SimOpt< Real >

Defines the linear algebra or vector space interface for simulation-based optimization.

Definition at line 57 of file ROL_Vector_SimOpt.hpp.

Constructor & Destructor Documentation

template<class Real>
ROL::Vector_SimOpt< Real >::Vector_SimOpt ( const Teuchos::RCP< Vector< Real > > &  vec1,
const Teuchos::RCP< Vector< Real > > &  vec2 
)
inline

Member Function Documentation

template<class Real>
void ROL::Vector_SimOpt< 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 72 of file ROL_Vector_SimOpt.hpp.

References ROL::Vector_SimOpt< Real >::get_1(), and ROL::Vector_SimOpt< Real >::get_2().

template<class Real>
void ROL::Vector_SimOpt< 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 79 of file ROL_Vector_SimOpt.hpp.

template<class Real>
void ROL::Vector_SimOpt< 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 84 of file ROL_Vector_SimOpt.hpp.

References ROL::Vector_SimOpt< Real >::get_1(), and ROL::Vector_SimOpt< Real >::get_2().

template<class Real>
Real ROL::Vector_SimOpt< 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 91 of file ROL_Vector_SimOpt.hpp.

References ROL::Vector_SimOpt< Real >::get_1(), and ROL::Vector_SimOpt< Real >::get_2().

template<class Real>
Real ROL::Vector_SimOpt< 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 97 of file ROL_Vector_SimOpt.hpp.

Referenced by main().

template<class Real>
Teuchos::RCP<Vector<Real> > ROL::Vector_SimOpt< 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 103 of file ROL_Vector_SimOpt.hpp.

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

Referenced by ROL::Vector_SimOpt< Real >::basis(), main(), and ROL::Vector_SimOpt< Real >::Vector_SimOpt().

template<class Real>
const Vector<Real>& ROL::Vector_SimOpt< 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 107 of file ROL_Vector_SimOpt.hpp.

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

template<class Real>
Teuchos::RCP<Vector<Real> > ROL::Vector_SimOpt< Real >::basis ( const int  i) const
inlinevirtual

Return i-th basis vector.

Parameters
[in]iis the index of the basis function.
Returns
A reference-counted pointer to the basis vector with index i.

Overloading the basis is only required if the default gradient implementation is used, which computes a finite-difference approximation.


Reimplemented from ROL::Vector< Real >.

Definition at line 114 of file ROL_Vector_SimOpt.hpp.

References ROL::Vector_SimOpt< Real >::clone(), ROL::Vector_SimOpt< Real >::dimension(), ROL::Vector_SimOpt< Real >::vec1_, and ROL::Vector_SimOpt< Real >::vec2_.

template<class Real>
int ROL::Vector_SimOpt< Real >::dimension ( void  ) const
inlinevirtual

Return dimension of the vector space.

Returns
The dimension of the vector space, i.e., the total number of basis vectors.

Overload if the basis is overloaded.


Reimplemented from ROL::Vector< Real >.

Definition at line 130 of file ROL_Vector_SimOpt.hpp.

References ROL::Vector_SimOpt< Real >::vec2_.

Referenced by ROL::Vector_SimOpt< Real >::basis().

template<class Real>
Teuchos::RCP<const Vector<Real> > ROL::Vector_SimOpt< Real >::get_1 ( ) const
inline
template<class Real>
Teuchos::RCP<const Vector<Real> > ROL::Vector_SimOpt< Real >::get_2 ( ) const
inline
template<class Real>
void ROL::Vector_SimOpt< Real >::set_1 ( const Vector< Real > &  vec)
inline
template<class Real>
void ROL::Vector_SimOpt< Real >::set_2 ( const Vector< Real > &  vec)
inline

Member Data Documentation

template<class Real>
Teuchos::RCP<Vector<Real> > ROL::Vector_SimOpt< Real >::vec1_
private
template<class Real>
Teuchos::RCP<Vector<Real> > ROL::Vector_SimOpt< Real >::vec2_
private
template<class Real>
Teuchos::RCP<Vector<Real> > ROL::Vector_SimOpt< Real >::dual_vec1_
mutableprivate

Definition at line 61 of file ROL_Vector_SimOpt.hpp.

template<class Real>
Teuchos::RCP<Vector<Real> > ROL::Vector_SimOpt< Real >::dual_vec2_
mutableprivate

Definition at line 62 of file ROL_Vector_SimOpt.hpp.

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

Definition at line 63 of file ROL_Vector_SimOpt.hpp.

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


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