ROL
|
#include <example_02.hpp>
Public Member Functions | |
ConDualStdVector (const ROL::Ptr< std::vector< Element > > &std_vec) | |
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... | |
ROL::Ptr< ROL::Vector< Real > > | clone () const |
Clone to make a new (uninitialized) vector. More... | |
ROL::Ptr< const std::vector < Element > > | getVector () const |
ROL::Ptr< std::vector< Element > > | getVector () |
ROL::Ptr< 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... | |
Real | apply (const ROL::Vector< Real > &x) const |
Apply \(\mathtt{*this}\) to a dual vector. This is equivalent to the call \(\mathtt{this->dot(x.dual())}\). More... | |
ConDualStdVector (const ROL::Ptr< std::vector< Element > > &std_vec) | |
void | plus (const 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 Vector< Real > &x) const |
Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More... | |
Real | norm () const |
Returns \( \| y \| \) where \(y = \mathtt{*this}\). More... | |
ROL::Ptr< Vector< Real > > | clone () const |
Clone to make a new (uninitialized) vector. More... | |
ROL::Ptr< const std::vector < Element > > | getVector () const |
ROL::Ptr< std::vector< Element > > | getVector () |
ROL::Ptr< Vector< Real > > | basis (const int i) const |
Return i-th basis vector. More... | |
int | dimension () const |
Return dimension of the vector space. More... | |
const 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 | set (const Vector &x) |
Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). 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 void | print (std::ostream &outStream) const |
virtual void | setScalar (const Real C) |
Set \(y \leftarrow C\) where \(C\in\mathbb{R}\). More... | |
virtual void | randomize (const Real l=0.0, const Real u=1.0) |
Set vector to be uniform random between [l,u]. 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 | |
typedef std::vector< Element > | vector |
typedef ROL::Vector< Real > | V |
typedef vector::size_type | uint |
typedef std::vector< Element > | vector |
typedef vector::size_type | uint |
Private Attributes | |
ROL::Ptr< std::vector< Element > > | std_vec_ |
ROL::Ptr< ConStdVector< Real > > | dual_vec_ |
Definition at line 39 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
|
private |
Definition at line 322 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
|
private |
Definition at line 323 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
|
private |
Definition at line 324 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
|
private |
Definition at line 342 of file gross-pitaevskii/example_02.hpp.
|
private |
Definition at line 343 of file gross-pitaevskii/example_02.hpp.
|
inline |
Definition at line 333 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
|
inline |
Definition at line 352 of file gross-pitaevskii/example_02.hpp.
|
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 335 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
References ConDualStdVector< Real, Element >::dimension(), ConDualStdVector< Real, Element >::getVector(), and ConDualStdVector< Real, Element >::std_vec_.
|
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 344 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
References ConDualStdVector< Real, Element >::dimension(), and ConDualStdVector< Real, Element >::std_vec_.
|
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 351 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
References ConDualStdVector< Real, Element >::dimension(), ConDualStdVector< Real, Element >::getVector(), and ConDualStdVector< Real, Element >::std_vec_.
Referenced by ConDualStdVector< Real, Element >::norm().
|
inlinevirtual |
Returns \( \| y \| \) where \(y = \mathtt{*this}\).
Implements ROL::Vector< Real >.
Definition at line 362 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
References ConDualStdVector< Real, Element >::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 368 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
References ConDualStdVector< Real, Element >::std_vec_.
|
inline |
Definition at line 372 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
References ConDualStdVector< Real, Element >::std_vec_.
Referenced by ConDualStdVector< Real, Element >::apply(), ConDualStdVector< Real, Element >::dot(), and ConDualStdVector< Real, Element >::plus().
|
inline |
Definition at line 376 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
References ConDualStdVector< Real, Element >::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 380 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
References ConDualStdVector< Real, Element >::std_vec_.
|
inlinevirtual |
Return dimension of the vector space.
Overload if the basis is overloaded.
Reimplemented from ROL::Vector< Real >.
Definition at line 388 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
References ConDualStdVector< Real, Element >::std_vec_.
Referenced by ConDualStdVector< Real, Element >::apply(), ConDualStdVector< Real, Element >::dot(), ConDualStdVector< Real, Element >::plus(), and ConDualStdVector< Real, Element >::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 390 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
References ConDualStdVector< Real, Element >::dual_vec_.
|
inlinevirtual |
Apply \(\mathtt{*this}\) to a dual vector. This is equivalent to the call \(\mathtt{this->dot(x.dual())}\).
[in] | x | is a vector |
Reimplemented from ROL::Vector< Real >.
Definition at line 395 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
References ConDualStdVector< Real, Element >::dimension(), ConDualStdVector< Real, Element >::getVector(), and ConDualStdVector< Real, Element >::std_vec_.
|
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 354 of file gross-pitaevskii/example_02.hpp.
References ConDualStdVector< Real, Element >::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 363 of file gross-pitaevskii/example_02.hpp.
|
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 370 of file gross-pitaevskii/example_02.hpp.
References ConDualStdVector< Real, Element >::getVector().
|
inlinevirtual |
Returns \( \| y \| \) where \(y = \mathtt{*this}\).
Implements ROL::Vector< Real >.
Definition at line 381 of file gross-pitaevskii/example_02.hpp.
|
inlinevirtual |
Clone to make a new (uninitialized) vector.
Provides the means of allocating temporary memory in ROL.
Implements ROL::Vector< Real >.
Definition at line 387 of file gross-pitaevskii/example_02.hpp.
|
inline |
Definition at line 391 of file gross-pitaevskii/example_02.hpp.
|
inline |
Definition at line 395 of file gross-pitaevskii/example_02.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 399 of file gross-pitaevskii/example_02.hpp.
|
inlinevirtual |
Return dimension of the vector space.
Overload if the basis is overloaded.
Reimplemented from ROL::Vector< Real >.
Definition at line 406 of file gross-pitaevskii/example_02.hpp.
|
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 408 of file gross-pitaevskii/example_02.hpp.
|
private |
Definition at line 328 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
Referenced by ConDualStdVector< Real, Element >::apply(), ConDualStdVector< Real, Element >::basis(), ConDualStdVector< Real, Element >::clone(), ConDualStdVector< Real, Element >::dimension(), ConDualStdVector< Real, Element >::dot(), ConDualStdVector< Real, Element >::getVector(), ConDualStdVector< Real, Element >::plus(), and ConDualStdVector< Real, Element >::scale().
|
mutableprivate |
Definition at line 329 of file dual-spaces/simple-eq-constr-1/example_01.cpp.
Referenced by ConDualStdVector< Real, Element >::dual().