Provides the std::vector implementation of the ROL::Vector interface. More...
#include <ROL_BatchStdVector.hpp>
Inheritance diagram for ROL::BatchStdVector< Real >:
Public Member Functions | |
| BatchStdVector (const ROL::Ptr< std::vector< Real > > &vec, const ROL::Ptr< BatchManager< Real > > &bman) | |
| virtual Real | dot (const Vector< Real > &x) const |
| Compute \( \langle y,x \rangle \) where \(y = \mathtt{*this}\). More... | |
| virtual ROL::Ptr< Vector< Real > > | clone (void) const |
| Clone to make a new (uninitialized) vector. More... | |
| int | dimension (void) const |
| Return dimension of the vector space. More... | |
| Real | reduce (const Elementwise::ReductionOp< Real > &r) const |
| Public Member Functions inherited from ROL::StdVector< Real > | |
| StdVector (const Ptr< std::vector< Real > > &std_vec) | |
| StdVector (const int dim, const Realval=0.0) | |
| void | set (const Vector< Real > &x) |
| Set \(y \leftarrow x\) where \(y = \mathtt{*this}\). More... | |
| void | plus (const Vector< Real > &x) |
| Compute \(y \leftarrow y + x\), 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 | scale (const Real alpha) |
| Compute \(y \leftarrow \alpha y\) where \(y = \mathtt{*this}\). More... | |
| Real | norm () const |
| Returns \( \| y \| \) where \(y = \mathtt{*this}\). More... | |
| Ptr< const std::vector< Real > > | getVector () const |
| Ptr< std::vector< Real > > | getVector () |
| Ptr< Vector< Real > > | 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 Vector< Real > &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... | |
| virtual void | print (std::ostream &outStream) 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 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... | |
Protected Member Functions | |
| const ROL::Ptr< BatchManager < Real > > | getBatchManager (void) const |
Private Types | |
| typedef std::vector< Real > ::size_type | uint |
Private Attributes | |
| const ROL::Ptr< BatchManager < Real > > | bman_ |
Detailed Description
template<class Real>
class ROL::BatchStdVector< Real >
Provides the std::vector implementation of the ROL::Vector interface.
Definition at line 58 of file ROL_BatchStdVector.hpp.
Member Typedef Documentation
|
private |
Definition at line 59 of file ROL_BatchStdVector.hpp.
Constructor & Destructor Documentation
|
inline |
Definition at line 69 of file ROL_BatchStdVector.hpp.
Member Function Documentation
|
inlineprotected |
Definition at line 64 of file ROL_BatchStdVector.hpp.
References ROL::BatchStdVector< Real >::bman_.
Referenced by ROL::PrimalProbabilityVector< Real >::dot(), ROL::PrimalAtomVector< Real >::dot(), ROL::DualProbabilityVector< Real >::dot(), and ROL::DualAtomVector< Real >::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::StdVector< Real >.
Reimplemented in ROL::DualAtomVector< Real >, ROL::DualProbabilityVector< Real >, ROL::PrimalAtomVector< Real >, and ROL::PrimalProbabilityVector< Real >.
Definition at line 73 of file ROL_BatchStdVector.hpp.
References ROL::BatchStdVector< Real >::bman_, ROL::StdVector< Real >::getVector(), and ROL::StdVector< Real, Element >::getVector().
|
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.
Reimplemented from ROL::StdVector< Real >.
Reimplemented in ROL::DualAtomVector< Real >, ROL::DualProbabilityVector< Real >, ROL::PrimalAtomVector< Real >, and ROL::PrimalProbabilityVector< Real >.
Definition at line 88 of file ROL_BatchStdVector.hpp.
References ROL::BatchStdVector< Real >::bman_, and ROL::StdVector< Real, Element >::getVector().
|
inlinevirtual |
Return dimension of the vector space.
- Returns
- 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 95 of file ROL_BatchStdVector.hpp.
References ROL::BatchStdVector< Real >::bman_.
Referenced by ROL::PrimalAtomVector< Real >::clone(), ROL::DualAtomVector< Real >::clone(), ROL::PrimalAtomVector< Real >::dot(), ROL::DualAtomVector< Real >::dot(), ROL::PrimalAtomVector< Real >::dual(), and ROL::DualAtomVector< Real >::dual().
|
inlinevirtual |
Reimplemented from ROL::Vector< Real >.
Definition at line 102 of file ROL_BatchStdVector.hpp.
References ROL::BatchStdVector< Real >::bman_, and ROL::StdVector< Real, Element >::getVector().
Member Data Documentation
|
private |
Definition at line 61 of file ROL_BatchStdVector.hpp.
Referenced by ROL::BatchStdVector< Real >::clone(), ROL::BatchStdVector< Real >::dimension(), ROL::BatchStdVector< Real >::dot(), ROL::BatchStdVector< Real >::getBatchManager(), and ROL::BatchStdVector< Real >::reduce().
The documentation for this class was generated from the following file:
