ROL
|
Defines the linear algebra or vector space interface for simulation-based optimization. More...
#include <ROL_Vector_SimOpt.hpp>
Public Member Functions | |
Vector_SimOpt (const Teuchos::RCP< Vector< Real > > &vec1, const Teuchos::RCP< Vector< Real > > &vec2) | |
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... | |
void | axpy (const Real alpha, const Vector< Real > &x) |
Compute \(y \leftarrow \alpha x + 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... | |
const Vector< Real > & | dual (void) 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... | |
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... | |
Teuchos::RCP< const Vector< Real > > | get_1 () const |
Teuchos::RCP< const Vector< Real > > | get_2 () const |
void | set_1 (const Vector< Real > &vec) |
void | set_2 (const Vector< Real > &vec) |
![]() | |
virtual | ~Vector () |
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 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< Vector< Real > > | vec1_ |
Teuchos::RCP< Vector< Real > > | vec2_ |
Teuchos::RCP< Vector< Real > > | dual_vec1_ |
Teuchos::RCP< Vector< Real > > | dual_vec2_ |
Teuchos::RCP< Vector_SimOpt< Real > > | dual_vec_ |
Defines the linear algebra or vector space interface for simulation-based optimization.
Definition at line 57 of file ROL_Vector_SimOpt.hpp.
|
inline |
Definition at line 66 of file ROL_Vector_SimOpt.hpp.
References ROL::Vector_SimOpt< Real >::clone().
Referenced by ROL::Vector_SimOpt< Real >::clone().
|
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 72 of file ROL_Vector_SimOpt.hpp.
References ROL::Vector_SimOpt< Real >::get_1(), and ROL::Vector_SimOpt< Real >::get_2().
|
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 79 of file ROL_Vector_SimOpt.hpp.
|
inlinevirtual |
Compute \(y \leftarrow \alpha x + y\) where \(y = \mathtt{*this}\).
[in] | alpha | is the scaling of x. |
[in] | x | is a vector. |
On return \(\mathtt{*this} = \mathtt{*this} + \alpha x \). 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 84 of file ROL_Vector_SimOpt.hpp.
References ROL::Vector_SimOpt< Real >::get_1(), and ROL::Vector_SimOpt< Real >::get_2().
|
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 91 of file ROL_Vector_SimOpt.hpp.
References ROL::Vector_SimOpt< Real >::get_1(), and ROL::Vector_SimOpt< Real >::get_2().
|
inlinevirtual |
Returns \( \| y \| \) where \(y = \mathtt{*this}\).
Implements ROL::Vector< Real >.
Definition at line 97 of file ROL_Vector_SimOpt.hpp.
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 103 of file ROL_Vector_SimOpt.hpp.
References ROL::Vector_SimOpt< Real >::Vector_SimOpt().
Referenced by ROL::Vector_SimOpt< Real >::basis(), main(), and ROL::Vector_SimOpt< Real >::Vector_SimOpt().
|
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 107 of file ROL_Vector_SimOpt.hpp.
References ROL::Vector_SimOpt< Real >::dual_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 114 of file ROL_Vector_SimOpt.hpp.
References ROL::Vector_SimOpt< Real >::clone(), ROL::Vector_SimOpt< Real >::dimension(), ROL::Vector_SimOpt< Real >::vec1_, and ROL::Vector_SimOpt< Real >::vec2_.
|
inlinevirtual |
Return dimension of the vector space.
Overload if the basis is overloaded.
Reimplemented from ROL::Vector< Real >.
Definition at line 130 of file ROL_Vector_SimOpt.hpp.
References ROL::Vector_SimOpt< Real >::vec2_.
Referenced by ROL::Vector_SimOpt< Real >::basis().
|
inline |
Definition at line 134 of file ROL_Vector_SimOpt.hpp.
References ROL::Vector_SimOpt< Real >::vec1_.
Referenced by ROL::EqualityConstraint_SimOpt< Real >::applyAdjointHessian(), ROL::EqualityConstraint_SimOpt< Real >::applyAdjointJacobian(), ROL::EqualityConstraint_SimOpt< Real >::applyJacobian(), ROL::EqualityConstraint_SimOpt< Real >::applyPreconditioner(), ROL::Vector_SimOpt< Real >::axpy(), ROL::BoundConstraint_SimOpt< Real >::checkMultipliers(), ROL::Vector_SimOpt< Real >::dot(), ROL::Objective_SimOpt< Real >::gradient(), ROL::Objective_SimOpt< Real >::hessVec(), ROL::BoundConstraint_SimOpt< Real >::isFeasible(), ROL::Vector_SimOpt< Real >::plus(), ROL::BoundConstraint_SimOpt< Real >::project(), ROL::BoundConstraint_SimOpt< Real >::pruneActive(), ROL::BoundConstraint_SimOpt< Real >::pruneLowerActive(), ROL::BoundConstraint_SimOpt< Real >::pruneUpperActive(), ROL::BoundConstraint_SimOpt< Real >::setVectorToLowerBound(), ROL::BoundConstraint_SimOpt< Real >::setVectorToUpperBound(), ROL::Objective_SimOpt< Real >::update(), ROL::BoundConstraint_SimOpt< Real >::update(), ROL::EqualityConstraint_SimOpt< Real >::update(), ROL::Objective_SimOpt< Real >::value(), and ROL::EqualityConstraint_SimOpt< Real >::value().
|
inline |
Definition at line 138 of file ROL_Vector_SimOpt.hpp.
References ROL::Vector_SimOpt< Real >::vec2_.
Referenced by ROL::EqualityConstraint_SimOpt< Real >::applyAdjointHessian(), ROL::EqualityConstraint_SimOpt< Real >::applyAdjointJacobian(), ROL::EqualityConstraint_SimOpt< Real >::applyJacobian(), ROL::EqualityConstraint_SimOpt< Real >::applyPreconditioner(), ROL::Vector_SimOpt< Real >::axpy(), ROL::BoundConstraint_SimOpt< Real >::checkMultipliers(), ROL::Vector_SimOpt< Real >::dot(), ROL::Objective_SimOpt< Real >::gradient(), ROL::Objective_SimOpt< Real >::hessVec(), ROL::BoundConstraint_SimOpt< Real >::isFeasible(), ROL::Vector_SimOpt< Real >::plus(), ROL::BoundConstraint_SimOpt< Real >::project(), ROL::BoundConstraint_SimOpt< Real >::pruneActive(), ROL::BoundConstraint_SimOpt< Real >::pruneLowerActive(), ROL::BoundConstraint_SimOpt< Real >::pruneUpperActive(), ROL::BoundConstraint_SimOpt< Real >::setVectorToLowerBound(), ROL::BoundConstraint_SimOpt< Real >::setVectorToUpperBound(), ROL::Objective_SimOpt< Real >::update(), ROL::BoundConstraint_SimOpt< Real >::update(), ROL::EqualityConstraint_SimOpt< Real >::update(), ROL::Objective_SimOpt< Real >::value(), and ROL::EqualityConstraint_SimOpt< Real >::value().
|
inline |
Definition at line 142 of file ROL_Vector_SimOpt.hpp.
Referenced by ROL::EqualityConstraint_SimOpt< Real >::applyAdjointHessian(), ROL::EqualityConstraint_SimOpt< Real >::applyAdjointJacobian(), ROL::Objective_SimOpt< Real >::gradient(), ROL::Objective_SimOpt< Real >::hessVec(), ROL::BoundConstraint_SimOpt< Real >::project(), ROL::BoundConstraint_SimOpt< Real >::pruneActive(), ROL::BoundConstraint_SimOpt< Real >::pruneLowerActive(), ROL::BoundConstraint_SimOpt< Real >::pruneUpperActive(), ROL::BoundConstraint_SimOpt< Real >::setVectorToLowerBound(), and ROL::BoundConstraint_SimOpt< Real >::setVectorToUpperBound().
|
inline |
Definition at line 146 of file ROL_Vector_SimOpt.hpp.
Referenced by ROL::EqualityConstraint_SimOpt< Real >::applyAdjointHessian(), ROL::EqualityConstraint_SimOpt< Real >::applyAdjointJacobian(), ROL::Objective_SimOpt< Real >::gradient(), ROL::Objective_SimOpt< Real >::hessVec(), ROL::BoundConstraint_SimOpt< Real >::project(), ROL::BoundConstraint_SimOpt< Real >::pruneActive(), ROL::BoundConstraint_SimOpt< Real >::pruneLowerActive(), ROL::BoundConstraint_SimOpt< Real >::pruneUpperActive(), ROL::BoundConstraint_SimOpt< Real >::setVectorToLowerBound(), and ROL::BoundConstraint_SimOpt< Real >::setVectorToUpperBound().
|
private |
Definition at line 59 of file ROL_Vector_SimOpt.hpp.
Referenced by ROL::Vector_SimOpt< Real >::basis(), and ROL::Vector_SimOpt< Real >::get_1().
|
private |
Definition at line 60 of file ROL_Vector_SimOpt.hpp.
Referenced by ROL::Vector_SimOpt< Real >::basis(), ROL::Vector_SimOpt< Real >::dimension(), and ROL::Vector_SimOpt< Real >::get_2().
|
mutableprivate |
Definition at line 61 of file ROL_Vector_SimOpt.hpp.
|
mutableprivate |
Definition at line 62 of file ROL_Vector_SimOpt.hpp.
|
mutableprivate |
Definition at line 63 of file ROL_Vector_SimOpt.hpp.
Referenced by ROL::Vector_SimOpt< Real >::dual().