ROL
|
#include <ROL_SingletonVector.hpp>
Public Member Functions | |
SingletonVector (Real value=Real(0)) | |
Real | getValue () const |
void | setValue (Real v) |
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... | |
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... | |
ROL::Ptr< V > | clone () const |
Clone to make a new (uninitialized) vector. More... | |
ROL::Ptr< V > | basis (const int i) const |
Return i-th basis vector. More... | |
int | dimension () const |
Return dimension of the vector space. More... | |
void | applyUnary (const Elementwise::UnaryFunction< Real > &f) |
void | applyBinary (const Elementwise::BinaryFunction< Real > &f, const V &x) |
Real | reduce (const Elementwise::ReductionOp< Real > &r) const |
void | setScalar (const Real C) |
Set \(y \leftarrow C\) where \(C\in\mathbb{R}\). More... | |
void | randomize (const Real l=0.0, const Real u=1.0) |
Set vector to be uniform random between [l,u]. More... | |
void | print (std::ostream &os) const |
Public Member Functions inherited from ROL::Vector< Real > | |
virtual | ~Vector () |
virtual void | zero () |
Set to zero vector. More... | |
virtual const Vector & | 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 Real | apply (const Vector< Real > &x) const |
Apply \(\mathtt{*this}\) to a dual vector. This is equivalent to the call \(\mathtt{this->dot(x.dual())}\). More... | |
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 | |
using | V = Vector< Real > |
Private Member Functions | |
Real | getValueX (const V &x) const |
Private Attributes | |
Real | value_ |
Definition at line 25 of file ROL_SingletonVector.hpp.
|
private |
Definition at line 27 of file ROL_SingletonVector.hpp.
|
inline |
Definition at line 39 of file ROL_SingletonVector.hpp.
|
inlineprivate |
Definition at line 33 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::getValue().
Referenced by ROL::SingletonVector< Real >::applyBinary(), ROL::SingletonVector< Real >::axpy(), ROL::SingletonVector< Real >::dot(), ROL::SingletonVector< Real >::plus(), and ROL::SingletonVector< Real >::set().
|
inline |
Definition at line 41 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
Referenced by ROL::ScalarLinearConstraint< Real >::applyAdjointJacobian(), ROL::ScalarController< Real, Key >::get(), ROL::SingletonVector< Real >::getValueX(), and ROL::ScalarLinearConstraint< Real >::solveAugmentedSystem().
|
inline |
Definition at line 42 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
Referenced by ROL::ScalarLinearConstraint< Real >::applyJacobian(), ROL::ScalarLinearConstraint< Real >::solveAugmentedSystem(), and ROL::ScalarLinearConstraint< Real >::value().
|
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 44 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::getValueX(), and ROL::SingletonVector< Real >::value_.
|
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 48 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::getValueX(), and ROL::SingletonVector< Real >::value_.
|
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 52 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::getValueX(), and ROL::SingletonVector< Real >::value_.
|
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 56 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
|
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 60 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::getValueX(), and ROL::SingletonVector< Real >::value_.
|
inlinevirtual |
Returns \( \| y \| \) where \(y = \mathtt{*this}\).
Implements ROL::Vector< Real >.
Definition at line 66 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
|
inlinevirtual |
Clone to make a new (uninitialized) vector.
Provides the means of allocating temporary memory in ROL.
Implements ROL::Vector< Real >.
Definition at line 70 of file ROL_SingletonVector.hpp.
|
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 74 of file ROL_SingletonVector.hpp.
|
inlinevirtual |
Return dimension of the vector space.
Overload if the basis is overloaded.
Reimplemented from ROL::Vector< Real >.
Definition at line 81 of file ROL_SingletonVector.hpp.
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 83 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 87 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::getValueX(), and ROL::SingletonVector< Real >::value_.
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 91 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
|
inlinevirtual |
Set \(y \leftarrow C\) where \(C\in\mathbb{R}\).
[in] | C | is a scalar. |
On return \(\mathtt{*this} = C\). Uses applyUnary methods for the computation. Please overload if a more efficient implementation is needed.
Reimplemented from ROL::Vector< Real >.
Definition at line 95 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
|
inlinevirtual |
Set vector to be uniform random between [l,u].
[in] | l | is a the lower bound. |
[in] | u | is a the upper bound. |
On return the components of \(\mathtt{*this}\) are uniform random numbers on the interval \([l,u]\). The default implementation uses applyUnary methods for the computation. Please overload if a more efficient implementation is needed.
Reimplemented from ROL::Vector< Real >.
Definition at line 99 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 106 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
|
private |
Definition at line 31 of file ROL_SingletonVector.hpp.
Referenced by ROL::SingletonVector< Real >::applyBinary(), ROL::SingletonVector< Real >::applyUnary(), ROL::SingletonVector< Real >::axpy(), ROL::SingletonVector< Real >::dot(), ROL::SingletonVector< Real >::getValue(), ROL::SingletonVector< Real >::norm(), ROL::SingletonVector< Real >::plus(), ROL::SingletonVector< Real >::print(), ROL::SingletonVector< Real >::randomize(), ROL::SingletonVector< Real >::reduce(), ROL::SingletonVector< Real >::scale(), ROL::SingletonVector< Real >::set(), ROL::SingletonVector< Real >::setScalar(), and ROL::SingletonVector< Real >::setValue().