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}\). | |
void | plus (const V &x) |
Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\). | |
void | axpy (const Real alpha, const V &x) |
Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\). | |
void | scale (const Real alpha) |
Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\). | |
Real | dot (const V &x) const |
Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). | |
Real | norm () const |
Returns \( \| y \| \) where \(y = \mathtt{*this}\). | |
ROL::Ptr< V > | clone () const |
Clone to make a new (uninitialized) vector. | |
ROL::Ptr< V > | basis (const int i) const |
Return i-th basis vector. | |
int | dimension () const |
Return dimension of the vector space. | |
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}\). | |
void | randomize (const Real l=0.0, const Real u=1.0) |
Set vector to be uniform random between [l,u]. | |
void | print (std::ostream &os) const |
![]() | |
virtual | ~Vector () |
virtual void | plus (const Vector &x)=0 |
Compute \(y \leftarrow y + x\), where \(y = \mathtt{*this}\). | |
virtual void | scale (const Real alpha)=0 |
Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\). | |
virtual Real | dot (const Vector &x) const =0 |
Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). | |
virtual Real | norm () const =0 |
Returns \( \| y \| \) where \(y = \mathtt{*this}\). | |
virtual ROL::Ptr< Vector > | clone () const =0 |
Clone to make a new (uninitialized) vector. | |
virtual void | axpy (const Real alpha, const Vector &x) |
Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\). | |
virtual void | zero () |
Set to zero vector. | |
virtual ROL::Ptr< Vector > | basis (const int i) const |
Return i-th basis vector. | |
virtual int | dimension () const |
Return dimension of the vector space. | |
virtual void | set (const Vector &x) |
Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). | |
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. | |
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())}\). | |
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 void | print (std::ostream &outStream) const |
virtual void | setScalar (const Real C) |
Set \(y \leftarrow C\) where \(C\in\mathbb{R}\). | |
virtual void | randomize (const Real l=0.0, const Real u=1.0) |
Set vector to be uniform random between [l,u]. | |
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. | |
Private Types | |
using | V = Vector< Real > |
Private Member Functions | |
Real | getValueX (const V &x) const |
Private Attributes | |
Real | value_ |
Definition at line 59 of file ROL_SingletonVector.hpp.
|
private |
Definition at line 61 of file ROL_SingletonVector.hpp.
|
inline |
Definition at line 73 of file ROL_SingletonVector.hpp.
|
inlineprivate |
Definition at line 67 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 75 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 76 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}\).
@param[in] x is a vector. On return \f$\mathtt{*this} = x\f$. 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 78 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}\).
@param[in] x is the vector to be added to \f$\mathtt{*this}\f$. On return \f$\mathtt{*this} = \mathtt{*this} + x\f$. ---
Implements ROL::Vector< Real >.
Definition at line 82 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}\).
@param[in] alpha is the scaling of @b x. @param[in] x is a vector. On return \f$\mathtt{*this} = \mathtt{*this} + \alpha x \f$. 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 86 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}\).
@param[in] alpha is the scaling of \f$\mathtt{*this}\f$. On return \f$\mathtt{*this} = \alpha (\mathtt{*this}) \f$. ---
Implements ROL::Vector< Real >.
Definition at line 90 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
|
inlinevirtual |
Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).
@param[in] x is the vector that forms the dot product with \f$\mathtt{*this}\f$. @return The number equal to \f$\langle \mathtt{*this}, x \rangle\f$. ---
Implements ROL::Vector< Real >.
Definition at line 94 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::getValueX(), and ROL::SingletonVector< Real >::value_.
|
inlinevirtual |
Returns \( \| y \| \) where \(y = \mathtt{*this}\).
@return A nonnegative number equal to the norm of \f$\mathtt{*this}\f$. ---
Implements ROL::Vector< Real >.
Definition at line 100 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
|
inlinevirtual |
Clone to make a new (uninitialized) vector.
@return A reference-counted pointer to the cloned vector. Provides the means of allocating temporary memory in ROL. ---
Implements ROL::Vector< Real >.
Definition at line 104 of file ROL_SingletonVector.hpp.
|
inlinevirtual |
Return i-th basis vector.
@param[in] i is the index of the basis function. @return A reference-counted pointer to the basis vector with index @b 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 108 of file ROL_SingletonVector.hpp.
|
inlinevirtual |
Return dimension of the vector space.
@return 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 115 of file ROL_SingletonVector.hpp.
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 117 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 121 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::getValueX(), and ROL::SingletonVector< Real >::value_.
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 125 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
|
inlinevirtual |
Set \(y \leftarrow C\) where \(C\in\mathbb{R}\).
@param[in] C is a scalar. On return \f$\mathtt{*this} = C\f$. Uses #applyUnary methods for the computation. Please overload if a more efficient implementation is needed. ---
Reimplemented from ROL::Vector< Real >.
Definition at line 129 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
|
inlinevirtual |
Set vector to be uniform random between [l,u].
@param[in] l is a the lower bound. @param[in] u is a the upper bound. On return the components of \f$\mathtt{*this}\f$ are uniform random numbers on the interval \f$[l,u]\f$. 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 133 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 140 of file ROL_SingletonVector.hpp.
References ROL::SingletonVector< Real >::value_.
|
private |
Definition at line 65 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().