ROL
|
Provides the std::vector implementation of the ROL::Vector interface. More...
#include <ROL_StdVector.hpp>
Public Member Functions | |
StdVector (const Teuchos::RCP< std::vector< Element > > &std_vec) | |
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 | 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... | |
Teuchos::RCP< Vector< Real > > | clone () const |
Clone to make a new (uninitialized) vector. More... | |
Teuchos::RCP< const std::vector< Element > > | getVector () const |
Teuchos::RCP< std::vector < Element > > | getVector () |
Teuchos::RCP< Vector< Real > > | basis (const int i) const |
Return i-th basis vector. More... | |
int | dimension () const |
Return dimension of the vector space. More... | |
![]() | |
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 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... | |
Private Attributes | |
Teuchos::RCP< std::vector < Element > > | std_vec_ |
Provides the std::vector implementation of the ROL::Vector interface.
Definition at line 60 of file ROL_StdVector.hpp.
|
inline |
Definition at line 68 of file ROL_StdVector.hpp.
Referenced by ROL::StdVector< Real, Element >::basis(), and ROL::StdVector< Real, Element >::clone().
|
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 70 of file ROL_StdVector.hpp.
References ROL::StdVector< Real, Element >::getVector(), and ROL::StdVector< Real, Element >::std_vec_.
Referenced by main().
|
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 76 of file ROL_StdVector.hpp.
References ROL::StdVector< Real, Element >::dimension(), ROL::StdVector< Real, Element >::getVector(), and ROL::StdVector< 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 85 of file ROL_StdVector.hpp.
References ROL::StdVector< Real, Element >::dimension(), and ROL::StdVector< Real, Element >::std_vec_.
Referenced by main().
|
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 92 of file ROL_StdVector.hpp.
References ROL::StdVector< Real, Element >::dimension(), ROL::StdVector< Real, Element >::getVector(), and ROL::StdVector< Real, Element >::std_vec_.
Referenced by ROL::StdVector< Real, Element >::norm(), and ROL::ZOO::Objective_PoissonInversion< Real >::value().
|
inlinevirtual |
Returns \( \| y \| \) where \(y = \mathtt{*this}\).
Implements ROL::Vector< Real >.
Definition at line 103 of file ROL_StdVector.hpp.
References ROL::StdVector< Real, Element >::dot().
Referenced by main().
|
inlinevirtual |
Clone to make a new (uninitialized) vector.
Provides the means of allocating temporary memory in ROL.
Implements ROL::Vector< Real >.
Definition at line 109 of file ROL_StdVector.hpp.
References ROL::StdVector< Real, Element >::std_vec_, and ROL::StdVector< Real, Element >::StdVector().
Referenced by main().
|
inline |
Definition at line 113 of file ROL_StdVector.hpp.
References ROL::StdVector< Real, Element >::std_vec_.
Referenced by ROL::StdVector< Real, Element >::dot(), ROL::StdVector< Real, Element >::plus(), ROL::StdVector< Real, Element >::set(), ROL::ZOO::Objective_LeastSquares< Real >::value(), ROL::ZOO::Objective_SumOfSquares< Real >::value(), ROL::ZOO::Objective_FreudensteinRoth< Real >::value(), and ROL::ZOO::Objective_Powell< Real >::value().
|
inline |
Definition at line 117 of file ROL_StdVector.hpp.
References ROL::StdVector< 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 121 of file ROL_StdVector.hpp.
References ROL::StdVector< Real, Element >::std_vec_, and ROL::StdVector< Real, Element >::StdVector().
Referenced by main().
|
inlinevirtual |
Return dimension of the vector space.
Overload if the basis is overloaded.
Reimplemented from ROL::Vector< Real >.
Definition at line 127 of file ROL_StdVector.hpp.
References ROL::StdVector< Real, Element >::std_vec_.
Referenced by ROL::StdVector< Real, Element >::dot(), main(), ROL::StdVector< Real, Element >::plus(), and ROL::StdVector< Real, Element >::scale().
|
private |
Definition at line 64 of file ROL_StdVector.hpp.
Referenced by ROL::StdVector< Real, Element >::basis(), ROL::StdVector< Real, Element >::clone(), ROL::StdVector< Real, Element >::dimension(), ROL::StdVector< Real, Element >::dot(), ROL::StdVector< Real, Element >::getVector(), ROL::StdVector< Real, Element >::plus(), ROL::StdVector< Real, Element >::scale(), and ROL::StdVector< Real, Element >::set().