TSFExtendedOps::OpTimesLC< Scalar, Node > Class Template Reference
Class OpTimesLC holds an operator times something convertible to a vector. More...
Public Member Functions | |
| virtual | ~OpTimesLC () |
| OpTimesLC (const Scalar &alpha, const Node &x) | |
| OpTimesLC (const Scalar &alpha, const TSFExtended::LinearOperator< Scalar > &op, const Node &x) | |
| void | evalInto (TSFExtended::Vector< Scalar > &result) const |
| Evaluate the term into the argument vector, overwriting the previous value of the argument. | |
| void | addInto (TSFExtended::Vector< Scalar > &result, LCSign sign=LCAdd) const |
| Add the term into the argument vector. | |
| virtual TSFExtended::Vector < Scalar > | eval () const |
| Evaluate the term and return its value. | |
| bool | containsVector (const Thyra::VectorBase< Scalar > *vec) const |
| Determine whether this term contains the given vector. | |
| const LinearOperator< Scalar > & | op () const |
| const Scalar & | alpha () const |
| const Node & | node () const |
| Scalar | norm2 () const |
| Scalar | normInf () const |
Static Private Member Functions | |
| static Scalar | one () |
| static Scalar | zero () |
Private Attributes | |
| Scalar | alpha_ |
| TSFExtended::LinearOperator < Scalar > | op_ |
| Node | x_ |
Detailed Description
template<class Scalar, class Node>
class TSFExtendedOps::OpTimesLC< Scalar, Node >
Class OpTimesLC holds an operator times something convertible to a vector.
Definition at line 116 of file TSFLinearCombinationDecl.hpp.
Constructor & Destructor Documentation
| virtual TSFExtendedOps::OpTimesLC< Scalar, Node >::~OpTimesLC | ( | ) | [inline, virtual] |
Definition at line 121 of file TSFLinearCombinationDecl.hpp.
| TSFExtendedOps::OpTimesLC< Scalar, Node >::OpTimesLC | ( | const Scalar & | alpha, | |
| const Node & | x | |||
| ) | [inline] |
Definition at line 54 of file TSFLinearCombinationImpl.hpp.
| TSFExtendedOps::OpTimesLC< Scalar, Node >::OpTimesLC | ( | const Scalar & | alpha, | |
| const TSFExtended::LinearOperator< Scalar > & | op, | |||
| const Node & | x | |||
| ) | [inline] |
Definition at line 61 of file TSFLinearCombinationImpl.hpp.
Member Function Documentation
| void TSFExtendedOps::OpTimesLC< Scalar, Node >::addInto | ( | TSFExtended::Vector< Scalar > & | result, | |
| LCSign | sign = LCAdd | |||
| ) | const [inline] |
Add the term into the argument vector.
Definition at line 83 of file TSFLinearCombinationImpl.hpp.
References TSFExtendedOps::OpTimesLC< Scalar, Node >::alpha_, TSFExtendedOps::OpTimesLC< Scalar, Node >::op_, TSFExtended::Vector< Scalar >::update(), and TSFExtendedOps::OpTimesLC< Scalar, Node >::x_.
| const Scalar& TSFExtendedOps::OpTimesLC< Scalar, Node >::alpha | ( | ) | const [inline] |
Definition at line 150 of file TSFLinearCombinationDecl.hpp.
References TSFExtendedOps::OpTimesLC< Scalar, Node >::alpha_.
Referenced by TSFExtended::operator*().
| bool TSFExtendedOps::OpTimesLC< Scalar, Node >::containsVector | ( | const Thyra::VectorBase< Scalar > * | vec | ) | const [inline] |
Determine whether this term contains the given vector.
Definition at line 117 of file TSFLinearCombinationImpl.hpp.
References TSFExtendedOps::OpTimesLC< Scalar, Node >::x_.
Referenced by TSFExtended::Vector< Scalar >::operator=().
| TSFExtended::Vector< Scalar > TSFExtendedOps::OpTimesLC< Scalar, Node >::eval | ( | ) | const [inline, virtual] |
Evaluate the term and return its value.
Implements TSFExtendedOps::ConvertibleToVector< Scalar >.
Definition at line 99 of file TSFLinearCombinationImpl.hpp.
References TSFExtendedOps::OpTimesLC< Scalar, Node >::alpha_, TSFExtendedOps::OpTimesLC< Scalar, Node >::one(), TSFExtendedOps::OpTimesLC< Scalar, Node >::op_, TSFExtended::Vector< Scalar >::scale(), and TSFExtendedOps::OpTimesLC< Scalar, Node >::x_.
Referenced by TSFExtendedOps::OpTimesLC< Scalar, Node >::norm2(), TSFExtendedOps::OpTimesLC< Scalar, Node >::normInf(), and TSFExtended::Vector< Scalar >::operator=().
| void TSFExtendedOps::OpTimesLC< Scalar, Node >::evalInto | ( | TSFExtended::Vector< Scalar > & | result | ) | const [inline] |
Evaluate the term into the argument vector, overwriting the previous value of the argument.
Definition at line 69 of file TSFLinearCombinationImpl.hpp.
References TSFExtendedOps::OpTimesLC< Scalar, Node >::alpha_, TSFExtendedOps::OpTimesLC< Scalar, Node >::one(), TSFExtendedOps::OpTimesLC< Scalar, Node >::op_, TSFExtended::Vector< Scalar >::scale(), and TSFExtendedOps::OpTimesLC< Scalar, Node >::x_.
Referenced by TSFExtended::Vector< Scalar >::operator=().
| const Node& TSFExtendedOps::OpTimesLC< Scalar, Node >::node | ( | ) | const [inline] |
Definition at line 153 of file TSFLinearCombinationDecl.hpp.
References TSFExtendedOps::OpTimesLC< Scalar, Node >::x_.
Referenced by TSFExtended::operator*().
| Scalar TSFExtendedOps::OpTimesLC< Scalar, Node >::norm2 | ( | ) | const [inline] |
Reimplemented from TSFExtendedOps::ConvertibleToVector< Scalar >.
Definition at line 156 of file TSFLinearCombinationDecl.hpp.
References TSFExtendedOps::OpTimesLC< Scalar, Node >::eval().
| Scalar TSFExtendedOps::OpTimesLC< Scalar, Node >::normInf | ( | ) | const [inline] |
Reimplemented from TSFExtendedOps::ConvertibleToVector< Scalar >.
Definition at line 159 of file TSFLinearCombinationDecl.hpp.
References TSFExtendedOps::OpTimesLC< Scalar, Node >::eval().
| static Scalar TSFExtendedOps::OpTimesLC< Scalar, Node >::one | ( | ) | [inline, static, private] |
Definition at line 169 of file TSFLinearCombinationDecl.hpp.
Referenced by TSFExtendedOps::OpTimesLC< Scalar, Node >::eval(), and TSFExtendedOps::OpTimesLC< Scalar, Node >::evalInto().
| const LinearOperator<Scalar>& TSFExtendedOps::OpTimesLC< Scalar, Node >::op | ( | ) | const [inline] |
Definition at line 147 of file TSFLinearCombinationDecl.hpp.
References TSFExtendedOps::OpTimesLC< Scalar, Node >::op_.
Referenced by TSFExtended::operator*().
| static Scalar TSFExtendedOps::OpTimesLC< Scalar, Node >::zero | ( | ) | [inline, static, private] |
Definition at line 172 of file TSFLinearCombinationDecl.hpp.
Member Data Documentation
Scalar TSFExtendedOps::OpTimesLC< Scalar, Node >::alpha_ [private] |
TSFExtended::LinearOperator<Scalar> TSFExtendedOps::OpTimesLC< Scalar, Node >::op_ [private] |
Node TSFExtendedOps::OpTimesLC< Scalar, Node >::x_ [private] |
Definition at line 166 of file TSFLinearCombinationDecl.hpp.
Referenced by TSFExtendedOps::OpTimesLC< Scalar, Node >::addInto(), TSFExtendedOps::OpTimesLC< Scalar, Node >::containsVector(), TSFExtendedOps::OpTimesLC< Scalar, Node >::eval(), TSFExtendedOps::OpTimesLC< Scalar, Node >::evalInto(), and TSFExtendedOps::OpTimesLC< Scalar, Node >::node().