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

#include <test_04.hpp>

+ Inheritance diagram for L2VectorDual< Real >:

Public Member Functions

 L2VectorDual (const Teuchos::RCP< std::vector< Real > > &vec, const Teuchos::RCP< BurgersFEM< Real > > &fem)
 
void set (const ROL::Vector< Real > &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...
 
void plus (const ROL::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...
 
Real dot (const ROL::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< ROL::Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
Teuchos::RCP< const std::vector< Real > > getVector () const
 
Teuchos::RCP< std::vector< Real > > getVector ()
 
Teuchos::RCP< ROL::Vector< Real > > basis (const int i) const
 Return i-th basis vector. More...
 
int dimension () const
 Return dimension of the vector space. More...
 
const ROL::Vector< Real > & dual () 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...
 
 L2VectorDual (const Teuchos::RCP< std::vector< Real > > &vec, const Teuchos::RCP< BurgersFEM< Real > > &fem)
 
void set (const ROL::Vector< Real > &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...
 
void plus (const ROL::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...
 
Real dot (const ROL::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< ROL::Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
Teuchos::RCP< const std::vector< Real > > getVector () const
 
Teuchos::RCP< std::vector< Real > > getVector ()
 
Teuchos::RCP< ROL::Vector< Real > > basis (const int i) const
 Return i-th basis vector. More...
 
int dimension () const
 Return dimension of the vector space. More...
 
const ROL::Vector< Real > & dual () 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...
 
 L2VectorDual (const Teuchos::RCP< std::vector< Real > > &vec, const Teuchos::RCP< BurgersFEM< Real > > &fem)
 
void set (const ROL::Vector< Real > &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...
 
void plus (const ROL::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...
 
Real dot (const ROL::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< ROL::Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
Teuchos::RCP< const std::vector< Real > > getVector () const
 
Teuchos::RCP< std::vector< Real > > getVector ()
 
Teuchos::RCP< ROL::Vector< Real > > basis (const int i) const
 Return i-th basis vector. More...
 
int dimension () const
 Return dimension of the vector space. More...
 
const ROL::Vector< Real > & dual () 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...
 
 L2VectorDual (const Teuchos::RCP< std::vector< Real > > &vec, const Teuchos::RCP< BurgersFEM< Real > > &fem)
 
void set (const ROL::Vector< Real > &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...
 
void plus (const ROL::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...
 
Real dot (const ROL::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< ROL::Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
Teuchos::RCP< const std::vector< Real > > getVector () const
 
Teuchos::RCP< std::vector< Real > > getVector ()
 
Teuchos::RCP< ROL::Vector< Real > > basis (const int i) const
 Return i-th basis vector. More...
 
int dimension () const
 Return dimension of the vector space. More...
 
const ROL::Vector< Real > & dual () 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...
 
 L2VectorDual (const Teuchos::RCP< std::vector< Real > > &vec, const Teuchos::RCP< BurgersFEM< Real > > &fem)
 
void set (const ROL::Vector< Real > &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...
 
void plus (const ROL::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...
 
Real dot (const ROL::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< ROL::Vector< Real > > clone () const
 Clone to make a new (uninitialized) vector. More...
 
Teuchos::RCP< const std::vector< Real > > getVector () const
 
Teuchos::RCP< std::vector< Real > > getVector ()
 
Teuchos::RCP< ROL::Vector< Real > > basis (const int i) const
 Return i-th basis vector. More...
 
int dimension () const
 Return dimension of the vector space. More...
 
const ROL::Vector< Real > & dual () 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...
 
- Public Member Functions inherited from ROL::Vector< Real >
virtual ~Vector ()
 
virtual void axpy (const Real alpha, const Vector &x)
 Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\). More...
 
virtual void zero ()
 Set to zero vector. 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< std::vector< Real > > vec_
 
Teuchos::RCP< BurgersFEM< Real > > fem_
 
Teuchos::RCP< L2VectorPrimal< Real > > dual_vec_
 

Detailed Description

template<class Real>
class L2VectorDual< Real >

Definition at line 61 of file test_04.hpp.

Constructor & Destructor Documentation

template<class Real >
L2VectorDual< Real >::L2VectorDual ( const Teuchos::RCP< std::vector< Real > > &  vec,
const Teuchos::RCP< BurgersFEM< Real > > &  fem 
)
inline

Definition at line 623 of file test_04.hpp.

template<class Real >
L2VectorDual< Real >::L2VectorDual ( const Teuchos::RCP< std::vector< Real > > &  vec,
const Teuchos::RCP< BurgersFEM< Real > > &  fem 
)
inline

Definition at line 615 of file example_04.hpp.

template<class Real >
L2VectorDual< Real >::L2VectorDual ( const Teuchos::RCP< std::vector< Real > > &  vec,
const Teuchos::RCP< BurgersFEM< Real > > &  fem 
)
inline

Definition at line 619 of file example_06.hpp.

template<class Real >
L2VectorDual< Real >::L2VectorDual ( const Teuchos::RCP< std::vector< Real > > &  vec,
const Teuchos::RCP< BurgersFEM< Real > > &  fem 
)
inline

Definition at line 623 of file example_07.hpp.

template<class Real >
L2VectorDual< Real >::L2VectorDual ( const Teuchos::RCP< std::vector< Real > > &  vec,
const Teuchos::RCP< BurgersFEM< Real > > &  fem 
)
inline

Definition at line 619 of file example_08.hpp.

Member Function Documentation

template<class Real >
void L2VectorDual< Real >::set ( const ROL::Vector< Real > &  x)
inlinevirtual

Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).

Parameters
[in]xis a vector.

On return \(\mathtt{*this} = x\). Uses zero and plus methods for the computation. Please overload if a more efficient implementation is needed.


Reimplemented from ROL::Vector< Real >.

Definition at line 627 of file test_04.hpp.

References L2VectorDual< Real >::getVector().

template<class Real >
void L2VectorDual< Real >::plus ( const ROL::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 633 of file test_04.hpp.

References L2VectorDual< Real >::getVector().

template<class Real >
void L2VectorDual< 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 642 of file test_04.hpp.

template<class Real >
Real L2VectorDual< Real >::dot ( const ROL::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 649 of file test_04.hpp.

References L2VectorDual< Real >::getVector().

template<class Real >
Real L2VectorDual< 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 662 of file test_04.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > L2VectorDual< 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 668 of file test_04.hpp.

template<class Real >
Teuchos::RCP<const std::vector<Real> > L2VectorDual< Real >::getVector ( ) const
inline
template<class Real >
Teuchos::RCP<std::vector<Real> > L2VectorDual< Real >::getVector ( )
inline

Definition at line 676 of file test_04.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > L2VectorDual< 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 680 of file test_04.hpp.

template<class Real >
int L2VectorDual< 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 687 of file test_04.hpp.

template<class Real >
const ROL::Vector<Real>& L2VectorDual< 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 691 of file test_04.hpp.

template<class Real >
void L2VectorDual< Real >::set ( const ROL::Vector< Real > &  x)
inlinevirtual

Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).

Parameters
[in]xis a vector.

On return \(\mathtt{*this} = x\). Uses zero and plus methods for the computation. Please overload if a more efficient implementation is needed.


Reimplemented from ROL::Vector< Real >.

Definition at line 619 of file example_04.hpp.

References L2VectorDual< Real >::getVector().

template<class Real >
void L2VectorDual< Real >::plus ( const ROL::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 625 of file example_04.hpp.

References L2VectorDual< Real >::getVector().

template<class Real >
void L2VectorDual< 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 634 of file example_04.hpp.

template<class Real >
Real L2VectorDual< Real >::dot ( const ROL::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 641 of file example_04.hpp.

References L2VectorDual< Real >::getVector().

template<class Real >
Real L2VectorDual< 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 654 of file example_04.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > L2VectorDual< 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 660 of file example_04.hpp.

template<class Real >
Teuchos::RCP<const std::vector<Real> > L2VectorDual< Real >::getVector ( ) const
inline

Definition at line 664 of file example_04.hpp.

template<class Real >
Teuchos::RCP<std::vector<Real> > L2VectorDual< Real >::getVector ( )
inline

Definition at line 668 of file example_04.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > L2VectorDual< 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 672 of file example_04.hpp.

template<class Real >
int L2VectorDual< 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 679 of file example_04.hpp.

template<class Real >
const ROL::Vector<Real>& L2VectorDual< 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 683 of file example_04.hpp.

template<class Real >
void L2VectorDual< Real >::set ( const ROL::Vector< Real > &  x)
inlinevirtual

Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).

Parameters
[in]xis a vector.

On return \(\mathtt{*this} = x\). Uses zero and plus methods for the computation. Please overload if a more efficient implementation is needed.


Reimplemented from ROL::Vector< Real >.

Definition at line 623 of file example_06.hpp.

References L2VectorDual< Real >::getVector().

template<class Real >
void L2VectorDual< Real >::plus ( const ROL::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 629 of file example_06.hpp.

References L2VectorDual< Real >::getVector().

template<class Real >
void L2VectorDual< 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 638 of file example_06.hpp.

template<class Real >
Real L2VectorDual< Real >::dot ( const ROL::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 645 of file example_06.hpp.

References L2VectorDual< Real >::getVector().

template<class Real >
Real L2VectorDual< 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 658 of file example_06.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > L2VectorDual< 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 664 of file example_06.hpp.

template<class Real >
Teuchos::RCP<const std::vector<Real> > L2VectorDual< Real >::getVector ( ) const
inline

Definition at line 668 of file example_06.hpp.

template<class Real >
Teuchos::RCP<std::vector<Real> > L2VectorDual< Real >::getVector ( )
inline

Definition at line 672 of file example_06.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > L2VectorDual< 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 676 of file example_06.hpp.

template<class Real >
int L2VectorDual< 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 683 of file example_06.hpp.

template<class Real >
const ROL::Vector<Real>& L2VectorDual< 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 687 of file example_06.hpp.

template<class Real >
void L2VectorDual< Real >::set ( const ROL::Vector< Real > &  x)
inlinevirtual

Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).

Parameters
[in]xis a vector.

On return \(\mathtt{*this} = x\). Uses zero and plus methods for the computation. Please overload if a more efficient implementation is needed.


Reimplemented from ROL::Vector< Real >.

Definition at line 627 of file example_07.hpp.

References L2VectorDual< Real >::getVector().

template<class Real >
void L2VectorDual< Real >::plus ( const ROL::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 633 of file example_07.hpp.

References L2VectorDual< Real >::getVector().

template<class Real >
void L2VectorDual< 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 642 of file example_07.hpp.

template<class Real >
Real L2VectorDual< Real >::dot ( const ROL::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 649 of file example_07.hpp.

References L2VectorDual< Real >::getVector().

template<class Real >
Real L2VectorDual< 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 662 of file example_07.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > L2VectorDual< 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 668 of file example_07.hpp.

template<class Real >
Teuchos::RCP<const std::vector<Real> > L2VectorDual< Real >::getVector ( ) const
inline

Definition at line 672 of file example_07.hpp.

template<class Real >
Teuchos::RCP<std::vector<Real> > L2VectorDual< Real >::getVector ( )
inline

Definition at line 676 of file example_07.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > L2VectorDual< 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 680 of file example_07.hpp.

template<class Real >
int L2VectorDual< 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 687 of file example_07.hpp.

template<class Real >
const ROL::Vector<Real>& L2VectorDual< 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 691 of file example_07.hpp.

template<class Real >
void L2VectorDual< Real >::set ( const ROL::Vector< Real > &  x)
inlinevirtual

Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).

Parameters
[in]xis a vector.

On return \(\mathtt{*this} = x\). Uses zero and plus methods for the computation. Please overload if a more efficient implementation is needed.


Reimplemented from ROL::Vector< Real >.

Definition at line 623 of file example_08.hpp.

References L2VectorDual< Real >::getVector().

template<class Real >
void L2VectorDual< Real >::plus ( const ROL::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 629 of file example_08.hpp.

References L2VectorDual< Real >::getVector().

template<class Real >
void L2VectorDual< 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 638 of file example_08.hpp.

template<class Real >
Real L2VectorDual< Real >::dot ( const ROL::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 645 of file example_08.hpp.

References L2VectorDual< Real >::getVector().

template<class Real >
Real L2VectorDual< 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 658 of file example_08.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > L2VectorDual< 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 664 of file example_08.hpp.

template<class Real >
Teuchos::RCP<const std::vector<Real> > L2VectorDual< Real >::getVector ( ) const
inline

Definition at line 668 of file example_08.hpp.

template<class Real >
Teuchos::RCP<std::vector<Real> > L2VectorDual< Real >::getVector ( )
inline

Definition at line 672 of file example_08.hpp.

template<class Real >
Teuchos::RCP<ROL::Vector<Real> > L2VectorDual< 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 676 of file example_08.hpp.

template<class Real >
int L2VectorDual< 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 683 of file example_08.hpp.

template<class Real >
const ROL::Vector<Real>& L2VectorDual< 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 687 of file example_08.hpp.

Member Data Documentation

template<class Real >
Teuchos::RCP< std::vector< Real > > L2VectorDual< Real >::vec_
private

Definition at line 617 of file test_04.hpp.

template<class Real >
Teuchos::RCP< BurgersFEM< Real > > L2VectorDual< Real >::fem_
private

Definition at line 618 of file test_04.hpp.

template<class Real >
Teuchos::RCP< L2VectorPrimal< Real > > L2VectorDual< Real >::dual_vec_
mutableprivate

Definition at line 620 of file test_04.hpp.


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