ROL
|
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>
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< V > | clone () const |
Clone to make a new (uninitialized) vector. More... | |
Teuchos::RCP< const vector > | getVector () const |
Teuchos::RCP< vector > | getVector () |
Teuchos::RCP< V > | basis (const int i) const |
Return i-th basis vector. More... | |
int | dimension () const |
Return dimension of the vector space. More... | |
Teuchos::RCP< V > | 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... | |
![]() | |
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< vector > | std_vec_ |
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.
|
private |
Definition at line 65 of file ROL_CplxStdVector.hpp.
|
private |
Definition at line 66 of file ROL_CplxStdVector.hpp.
|
private |
Definition at line 67 of file ROL_CplxStdVector.hpp.
|
inline |
Definition at line 75 of file ROL_CplxStdVector.hpp.
Referenced by ROL::CplxStdVector< Real, complex >::basis().
|
inlinevirtual |
Set \(y \leftarrow x\) where \(y = \mathtt{*this}\).
[in] | x | is 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().
|
inlinevirtual |
Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\).
[in] | x | is 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().
|
inlinevirtual |
Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\).
[in] | alpha | is the scaling of x. |
[in] | x | is 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().
|
inlinevirtual |
Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\).
[in] | alpha | is 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().
|
inlinevirtual |
Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).
[in] | x | is the vector that forms the dot product with \(\mathtt{*this}\). |
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().
|
inlinevirtual |
Returns \( \| y \| \) where \(y = \mathtt{*this}\).
Implements ROL::Vector< Real >.
Definition at line 119 of file ROL_CplxStdVector.hpp.
References ROL::CplxStdVector< Real, complex >::dot().
|
inlinevirtual |
Clone to make a new (uninitialized) vector.
Provides the means of allocating temporary memory in ROL.
Implements ROL::Vector< Real >.
Definition at line 124 of file ROL_CplxStdVector.hpp.
|
inline |
Definition at line 128 of file ROL_CplxStdVector.hpp.
References ROL::CplxStdVector< Real, complex >::std_vec_.
Referenced by ROL::CplxStdVector< Real, complex >::axpy(), ROL::CplxStdVector< Real, complex >::dot(), ROL::CplxStdVector< Real, complex >::plus(), and ROL::CplxStdVector< Real, complex >::set().
|
inline |
Definition at line 132 of file ROL_CplxStdVector.hpp.
References ROL::CplxStdVector< Real, complex >::std_vec_.
|
inlinevirtual |
Return i-th basis vector.
[in] | i | is the index of the basis function. |
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().
|
inlinevirtual |
Return dimension of the vector space.
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().
|
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.
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().
|
private |
Definition at line 71 of file ROL_CplxStdVector.hpp.
Referenced by ROL::CplxStdVector< Real, complex >::getVector().