#include <ROL_RieszVector.hpp>
Inheritance diagram for ROL::RieszPrimalVector< Real >:
Public Member Functions | |
| RieszPrimalVector (const RCP< V > &v, const RCP< OP > &op, Real tol=std::sqrt(ROL_EPSILON< Real >())) | |
| virtual | ~RieszPrimalVector () |
| virtual Real | dot (const V &x) const |
| Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More... | |
| virtual RCP< V > | clone () const |
| Clone to make a new (uninitialized) vector. More... | |
| virtual const 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... | |
| 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 |
| RCP< V > | getVector (void) |
| RCP< const V > | getVector (void) const |
| Public Member Functions inherited from ROL::ElementwiseVector< Real > | |
| virtual | ~ElementwiseVector () |
| 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... | |
| virtual Real | norm () const |
| Returns \( \| y \| \) where \(y = \mathtt{*this}\). More... | |
| void | axpy (const Real alpha, const Vector< Real > &x) |
| Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\). More... | |
| void | zero () |
| Set to zero vector. More... | |
| void | set (const Vector< Real > &x) |
| Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More... | |
| Public Member Functions inherited from ROL::Vector< Real > | |
| virtual | ~Vector () |
| virtual Teuchos::RCP< Vector > | basis (const int i) const |
| Return i-th basis vector. More... | |
| virtual int | dimension () const |
| Return dimension of the vector space. More... | |
| virtual void | print (std::ostream &outStream) 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 | |
| template<typename T > | |
| using | RCP = Teuchos::RCP< T > |
| using | V = Vector< Real > |
| using | DualVector = RieszDualVector< Real > |
| using | OP = LinearOperator< Real > |
Private Member Functions | |
| void | initialize_dual (void) const |
Private Attributes | |
| const RCP< V > | v_ |
| RCP< DualVector > | dual_ |
| const RCP< OP > | op_ |
| Real | tol_ |
| bool | isDualInitialized_ |
Detailed Description
template<class Real>
class ROL::RieszPrimalVector< Real >
Definition at line 70 of file ROL_RieszVector.hpp.
Member Typedef Documentation
◆ RCP
|
private |
Definition at line 79 of file ROL_RieszVector.hpp.
◆ V
|
private |
Definition at line 81 of file ROL_RieszVector.hpp.
◆ DualVector
|
private |
Definition at line 82 of file ROL_RieszVector.hpp.
◆ OP
|
private |
Definition at line 83 of file ROL_RieszVector.hpp.
Constructor & Destructor Documentation
◆ RieszPrimalVector()
|
inline |
Definition at line 103 of file ROL_RieszVector.hpp.
Referenced by ROL::RieszPrimalVector< Real >::clone().
◆ ~RieszPrimalVector()
|
inlinevirtual |
Definition at line 109 of file ROL_RieszVector.hpp.
Member Function Documentation
◆ initialize_dual()
|
inlineprivate |
Definition at line 94 of file ROL_RieszVector.hpp.
References ROL::RieszPrimalVector< Real >::op_, and ROL::RieszPrimalVector< Real >::tol_.
Referenced by ROL::RieszPrimalVector< Real >::dot(), and ROL::RieszPrimalVector< Real >::dual().
◆ dot()
|
inlinevirtual |
Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\).
- Parameters
-
[in] x is the vector that forms the dot product with \(\mathtt{*this}\).
- Returns
- The number equal to \(\langle \mathtt{*this}, x \rangle\).
Reimplemented from ROL::ElementwiseVector< Real >.
Definition at line 111 of file ROL_RieszVector.hpp.
References ROL::RieszPrimalVector< Real >::getVector(), and ROL::RieszPrimalVector< Real >::initialize_dual().
◆ clone()
|
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 120 of file ROL_RieszVector.hpp.
References ROL::RieszPrimalVector< Real >::op_, ROL::RieszPrimalVector< Real >::RieszPrimalVector(), and ROL::RieszPrimalVector< Real >::tol_.
◆ dual()
|
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 124 of file ROL_RieszVector.hpp.
References ROL::RieszPrimalVector< Real >::dual_, and ROL::RieszPrimalVector< Real >::initialize_dual().
◆ applyUnary()
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 131 of file ROL_RieszVector.hpp.
◆ applyBinary()
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 135 of file ROL_RieszVector.hpp.
References ROL::RieszPrimalVector< Real >::applyBinary(), and ROL::RieszPrimalVector< Real >::getVector().
Referenced by ROL::RieszPrimalVector< Real >::applyBinary().
◆ reduce()
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 140 of file ROL_RieszVector.hpp.
◆ getVector() [1/2]
|
inline |
Definition at line 145 of file ROL_RieszVector.hpp.
References ROL::RieszPrimalVector< Real >::v_.
Referenced by ROL::RieszPrimalVector< Real >::applyBinary(), and ROL::RieszPrimalVector< Real >::dot().
◆ getVector() [2/2]
|
inline |
Definition at line 149 of file ROL_RieszVector.hpp.
References ROL::RieszPrimalVector< Real >::v_.
Member Data Documentation
◆ v_
|
private |
Definition at line 87 of file ROL_RieszVector.hpp.
Referenced by ROL::RieszPrimalVector< Real >::getVector(), and ROL::RieszDualVector< Real >::getVector().
◆ dual_
|
mutableprivate |
Definition at line 88 of file ROL_RieszVector.hpp.
Referenced by ROL::RieszPrimalVector< Real >::dual().
◆ op_
|
private |
Definition at line 89 of file ROL_RieszVector.hpp.
Referenced by ROL::RieszPrimalVector< Real >::clone(), ROL::RieszDualVector< Real >::clone(), ROL::RieszPrimalVector< Real >::initialize_dual(), and ROL::RieszDualVector< Real >::initialize_primal().
◆ tol_
|
mutableprivate |
Definition at line 90 of file ROL_RieszVector.hpp.
Referenced by ROL::RieszPrimalVector< Real >::clone(), ROL::RieszDualVector< Real >::clone(), ROL::RieszPrimalVector< Real >::initialize_dual(), and ROL::RieszDualVector< Real >::initialize_primal().
◆ isDualInitialized_
|
mutableprivate |
Definition at line 92 of file ROL_RieszVector.hpp.
The documentation for this class was generated from the following file:
