Abstract Vector for function space algorithms. More...
#include <abstract_interface.hh>
Detailed Description
Abstract Vector for function space algorithms.
Definition at line 25 of file abstract_interface.hh.
Public Member Functions | |
| AbstractFunctionSpaceElement (AbstractFunctionSpaceElement const &)=delete | |
| virtual | ~AbstractFunctionSpaceElement () |
| AbstractFunctionSpaceElement & | axpy (double alpha, AbstractFunctionSpaceElement const &l, int component) |
| *this += alpha*l More... | |
| AbstractFunctionSpaceElement & | axpy (double alpha, AbstractFunctionSpaceElement const &l, std::string const role) |
| AbstractFunctionSpaceElement & | axpy_role (double alpha, AbstractFunctionSpaceElement const &l, std::string const role) |
| AbstractFunctionSpaceElement & | axpy (double alpha, AbstractFunctionSpaceElement const &l) |
| *this += alpha*l More... | |
| AbstractFunctionSpaceElement & | operator= (AbstractFunctionSpaceElement const &v) |
| Assignment. More... | |
| AbstractFunctionSpaceElement & | operator+= (AbstractFunctionSpaceElement const &v) |
| Basic vector arithmetic. More... | |
| AbstractFunctionSpaceElement & | operator-= (AbstractFunctionSpaceElement const &v) |
| Basic vector arithmetic. More... | |
| AbstractFunctionSpaceElement & | operator*= (double lambda) |
| Basic vector arithmetic. More... | |
| AbstractFunctionSpaceElement & | operator*= (std::vector< double >const &lambda) |
| Scaling each component of the vector separately. More... | |
| double | applyAsDualTo (AbstractFunctionSpaceElement const &v, int component) const |
| Interpret *this as a dual vector, and apply it to v. More... | |
| double | applyAsDualTo (AbstractFunctionSpaceElement const &v) const |
| double | applyAsDualTo (AbstractFunctionSpaceElement const &v, std::string const &role) const |
| double | applyAsDualTo_role (AbstractFunctionSpaceElement const &v, std::string const role) const |
| virtual std::string | getRole (int component) const =0 |
| void | swap (AbstractFunctionSpaceElement &v) |
| Shallow swap. More... | |
| virtual int | nComponents () const =0 |
| virtual void | writeToFile (std::string const &file, bool append, int order=1) const |
| Optional output. More... | |
| virtual void | print (std::string const &message="") const |
| Optional output. More... | |
| virtual std::unique_ptr< AbstractFunctionSpaceElement > | clone () const =0 |
| Construction of a vector of the same type. More... | |
| virtual std::unique_ptr< AbstractFunctionSpaceElement > | initZeroVector () const =0 |
| Construction of a vector of the same type. More... | |
Protected Member Functions | |
| AbstractFunctionSpaceElement () | |
Constructor & Destructor Documentation
◆ AbstractFunctionSpaceElement() [1/2]
|
delete |
◆ ~AbstractFunctionSpaceElement()
|
inlinevirtual |
Definition at line 31 of file abstract_interface.hh.
◆ AbstractFunctionSpaceElement() [2/2]
|
inlineprotected |
Definition at line 160 of file abstract_interface.hh.
Member Function Documentation
◆ applyAsDualTo() [1/3]
|
inline |
Definition at line 108 of file abstract_interface.hh.
◆ applyAsDualTo() [2/3]
|
inline |
Interpret *this as a dual vector, and apply it to v.
Duality is currently not represented by types, hence users have to make sure that the dual pairing <*this,v> is mathematically meaningful. The standard implementation of the dual pairing in Bridge::Vector is the dot-product between the coordinate representations of *this and v. For that *this should be the result of AbstractLinearization::evald
Definition at line 103 of file abstract_interface.hh.
Referenced by applyAsDualTo_role().
◆ applyAsDualTo() [3/3]
|
inline |
Definition at line 113 of file abstract_interface.hh.
◆ applyAsDualTo_role()
|
inline |
Definition at line 118 of file abstract_interface.hh.
Referenced by applyAsDualTo().
◆ axpy() [1/3]
|
inline |
*this += alpha*l
Definition at line 60 of file abstract_interface.hh.
◆ axpy() [2/3]
|
inline |
*this += alpha*l
Definition at line 34 of file abstract_interface.hh.
Referenced by axpy_role(), Kaskade::TangentialStepNewton< Newton >::getTrialIterate(), and Kaskade::NormalStepNewton< Newton >::getTrialIterate().
◆ axpy() [3/3]
|
inline |
Definition at line 45 of file abstract_interface.hh.
◆ axpy_role()
|
inline |
Definition at line 50 of file abstract_interface.hh.
Referenced by Kaskade::PrimalChart::addPerturbation(), and axpy().
◆ clone()
|
pure virtual |
Construction of a vector of the same type.
Implemented in Kaskade::Bridge::Vector< Implementation >.
Referenced by Kaskade::TangentialStepArmijo::setLinearization().
◆ getRole()
|
pure virtual |
Implemented in Kaskade::Bridge::Vector< Implementation >.
Referenced by applyAsDualTo_role(), and axpy_role().
◆ initZeroVector()
|
pure virtual |
Construction of a vector of the same type.
Implemented in Kaskade::Bridge::Vector< Implementation >.
◆ nComponents()
|
pure virtual |
Implemented in Kaskade::Bridge::Vector< Implementation >.
Referenced by applyAsDualTo(), applyAsDualTo_role(), axpy(), axpy_role(), Kaskade::StepPolicyProjectedRHS< UpdatePolicy >::getSearchDirection(), Kaskade::StepPolicyProjectedRHS< UpdatePolicy >::getSimplifiedSearchDirection(), and operator*=().
◆ operator*=() [1/2]
|
inline |
Basic vector arithmetic.
Definition at line 84 of file abstract_interface.hh.
◆ operator*=() [2/2]
|
inline |
Scaling each component of the vector separately.
Definition at line 91 of file abstract_interface.hh.
◆ operator+=()
|
inline |
Basic vector arithmetic.
Definition at line 80 of file abstract_interface.hh.
◆ operator-=()
|
inline |
Basic vector arithmetic.
Definition at line 82 of file abstract_interface.hh.
◆ operator=()
|
inline |
Assignment.
Definition at line 73 of file abstract_interface.hh.
◆ print()
|
inlinevirtual |
Optional output.
Reimplemented in Kaskade::Bridge::Vector< Implementation >.
Definition at line 139 of file abstract_interface.hh.
◆ swap()
|
inline |
Shallow swap.
Definition at line 131 of file abstract_interface.hh.
Referenced by Kaskade::CompositeStep::updateIterate().
◆ writeToFile()
|
inlinevirtual |
Optional output.
Definition at line 136 of file abstract_interface.hh.
The documentation for this class was generated from the following file:
