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

Variant on ROL::StdVector with complex entries. Perhaps this can be accomplished with partial template specialization of ROL::StdVector instead? More...

#include <ROL_CplxStdVector.hpp>

+ Inheritance diagram for ROL::CplxStdVector< Real, complex >:

Public Member Functions

 CplxStdVector (const Teuchos::RCP< vector > &std_vec)
 
void set (const V &x)
 Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More...
 
void plus (const V &x)
 Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\). More...
 
void axpy (const Real alpha, const V &x)
 Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\). More...
 
void scale (const Real alpha)
 Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\). More...
 
complex< Real > dot (const V &x) const
 Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More...
 
Real norm () const
 Returns \( \| y \| \) where \(y = \mathtt{*this}\). More...
 
Teuchos::RCP< Vclone () const
 Clone to make a new (uninitialized) vector. More...
 
Teuchos::RCP< const vectorgetVector () const
 
Teuchos::RCP< vectorgetVector ()
 
Teuchos::RCP< Vbasis (const int i) const
 Return i-th basis vector. More...
 
int dimension () const
 Return dimension of the vector space. More...
 
Teuchos::RCP< Vdual () 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 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 Types

typedef std::vector< complex< Real > > vector
 
typedef Vector< Real > V
 
typedef vector::size_type uint
 

Private Attributes

Teuchos::RCP< vectorstd_vec_
 

Detailed Description

template<class Real, template< class > class complex>
class ROL::CplxStdVector< Real, complex >

Variant on ROL::StdVector with complex entries. Perhaps this can be accomplished with partial template specialization of ROL::StdVector instead?

Definition at line 63 of file ROL_CplxStdVector.hpp.

Member Typedef Documentation

template<class Real , template< class > class complex>
typedef std::vector<complex<Real> > ROL::CplxStdVector< Real, complex >::vector
private

Definition at line 65 of file ROL_CplxStdVector.hpp.

template<class Real , template< class > class complex>
typedef Vector<Real> ROL::CplxStdVector< Real, complex >::V
private

Definition at line 66 of file ROL_CplxStdVector.hpp.

template<class Real , template< class > class complex>
typedef vector::size_type ROL::CplxStdVector< Real, complex >::uint
private

Definition at line 67 of file ROL_CplxStdVector.hpp.

Constructor & Destructor Documentation

template<class Real , template< class > class complex>
ROL::CplxStdVector< Real, complex >::CplxStdVector ( const Teuchos::RCP< vector > &  std_vec)
inline

Definition at line 75 of file ROL_CplxStdVector.hpp.

Referenced by ROL::CplxStdVector< Real, complex >::basis().

Member Function Documentation

template<class Real , template< class > class complex>
void ROL::CplxStdVector< Real, complex >::set ( const V 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 77 of file ROL_CplxStdVector.hpp.

References ROL::CplxStdVector< Real, complex >::getVector().

template<class Real , template< class > class complex>
void ROL::CplxStdVector< Real, complex >::plus ( const V 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 83 of file ROL_CplxStdVector.hpp.

References ROL::CplxStdVector< Real, complex >::dimension(), and ROL::CplxStdVector< Real, complex >::getVector().

template<class Real , template< class > class complex>
void ROL::CplxStdVector< Real, complex >::axpy ( const Real  alpha,
const V 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 92 of file ROL_CplxStdVector.hpp.

References ROL::CplxStdVector< Real, complex >::dimension(), and ROL::CplxStdVector< Real, complex >::getVector().

template<class Real , template< class > class complex>
void ROL::CplxStdVector< Real, complex >::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 101 of file ROL_CplxStdVector.hpp.

References ROL::CplxStdVector< Real, complex >::dimension().

template<class Real , template< class > class complex>
complex<Real> ROL::CplxStdVector< Real, complex >::dot ( const V 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 108 of file ROL_CplxStdVector.hpp.

References ROL::CplxStdVector< Real, complex >::dimension(), and ROL::CplxStdVector< Real, complex >::getVector().

Referenced by ROL::CplxStdVector< Real, complex >::norm().

template<class Real , template< class > class complex>
Real ROL::CplxStdVector< Real, complex >::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 119 of file ROL_CplxStdVector.hpp.

References ROL::CplxStdVector< Real, complex >::dot().

template<class Real , template< class > class complex>
Teuchos::RCP<V> ROL::CplxStdVector< Real, complex >::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 124 of file ROL_CplxStdVector.hpp.

template<class Real , template< class > class complex>
Teuchos::RCP<const vector> ROL::CplxStdVector< Real, complex >::getVector ( ) const
inline
template<class Real , template< class > class complex>
Teuchos::RCP<vector> ROL::CplxStdVector< Real, complex >::getVector ( )
inline
template<class Real , template< class > class complex>
Teuchos::RCP<V> ROL::CplxStdVector< Real, complex >::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 136 of file ROL_CplxStdVector.hpp.

References ROL::CplxStdVector< Real, complex >::CplxStdVector().

template<class Real , template< class > class complex>
int ROL::CplxStdVector< Real, complex >::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 142 of file ROL_CplxStdVector.hpp.

Referenced by ROL::CplxStdVector< Real, complex >::axpy(), ROL::CplxStdVector< Real, complex >::dot(), ROL::CplxStdVector< Real, complex >::dual(), ROL::CplxStdVector< Real, complex >::plus(), and ROL::CplxStdVector< Real, complex >::scale().

template<class Real , template< class > class complex>
Teuchos::RCP<V> ROL::CplxStdVector< Real, complex >::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 146 of file ROL_CplxStdVector.hpp.

References ROL::CplxStdVector< Real, complex >::dimension().

Member Data Documentation

template<class Real , template< class > class complex>
Teuchos::RCP<vector> ROL::CplxStdVector< Real, complex >::std_vec_
private

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