tngmath::CWiseBase< MatrixType, Scalar > Class Template Reference
#include <matharraycwise.hpp>
Inheritance diagram for tngmath::CWiseBase< MatrixType, Scalar >:
Collaboration diagram for tngmath::CWiseBase< MatrixType, Scalar >:
Public Types | |
| typedef MatrixType | Base |
| typedef int | TIndex |
| typedef Scalar | TScalar |
Public Member Functions | |
| Base | __add__ (const Scalar &other) const |
| returns a matrix expression of the coefficient-wise sum of *this and other | |
| Base | __div__ (const MathArrayBase< Scalar > &other) const |
| returns a matrix expression of the coefficient-wise division of *this and other | |
| Base | __eq__ (const TScalar &x) const |
| Base | __eq__ (const MathArrayBase< Scalar > &other) const |
| returns a matrix expression of the coefficient-wise operator == (equal) of *this and other | |
| Base | __le__ (const TScalar &x) const |
| Base | __le__ (const MathArrayBase< Scalar > &other) const |
| returns a matrix expression of the coefficient-wise operator <= of *this and other | |
| Base | __lt__ (const TScalar &x) const |
| Base | __lt__ (const MathArrayBase< Scalar > &other) const |
| returns a matrix expression of the coefficient-wise operator < of *this and other | |
| Base | __mul__ (const MathArrayBase< Scalar > &other) const |
| returns a matrix expression of the coefficient-wise product of *this and other | |
| Base | __pow__ (const Scalar &exponent) const |
| returns a matrix object with coefficient-wise power of *this to the given exponent (operator ^) | |
| Base | __sub__ (const Scalar &other) const |
| returns a matrix expression of the coefficient-wise difference of *this and other | |
| Base | Abs () const |
| returns a matrix object with coefficient-wise absolute value | |
| Base | Abs2 () const |
| returns a matrix object with coefficient-wise squared absolute value | |
| Base | Atan2 (const MathArrayBase< TScalar > &y) const |
| Base | Cos () const |
| returns a matrix object with coefficient-wise cosine | |
| Base | Cos (const TScalar &a) const |
| returns a matrix object with coefficient-wise cosine of (this*a) | |
| Base | Cube () const |
| returns a matrix object with coefficient-wise cubic value (x^3) | |
| CWiseBase () | |
| a default constructor used for SWIG - it should never be called when using this object, else one will cause a segfault! | |
| CWiseBase (MatrixType &_object) | |
| constructor | |
| Base | Exp () const |
| returns a matrix object with coefficient-wise exponential (Euler number power component) | |
| Base | Exp (const TScalar &a) const |
| returns a matrix object with coefficient-wise exponential of (this*a) | |
| Base | Gamma () const |
| returns an array with elementwise value of gamma(this) (gamma function) | |
| Base | Greater (const TScalar &x) const |
| returns a matrix indicating which element of this is >x | |
| Base | Inverse () const |
| returns a matrix object with coefficient-wise inverse | |
| Base | inverse () const |
| returns a matrix object with coefficient-wise inverse | |
| Base | Less (const TScalar &x) const |
| returns a matrix indicating which element of this is smaller than x | |
| Base | Log () const |
| returns a matrix object with coefficient-wise natural logarithm | |
| Base | log () const |
| returns a matrix object with coefficient-wise natural logarithm | |
| Base | Max (const TScalar &z) const |
| returns an array with elementwise maximum of max(this,z) | |
| Base | Max (const MathArrayBase< Scalar > &other) const |
| returns a matrix expression of the coefficient-wise operator max of *this and other | |
| template<typename OtherDerived> | |
| Base | max (const Eigen::MatrixBase< OtherDerived > &other) const |
| returns a matrix expression of the coefficient-wise operator max of *this and other | |
| Base | Min (const TScalar &z) const |
| returns an array with elementwise minimum of min(this,z) | |
| Base | Min (const MathArrayBase< Scalar > &other) const |
| returns a matrix expression of the coefficient-wise operator min of *this and other | |
| template<typename OtherDerived> | |
| Base | min (const Eigen::MatrixBase< OtherDerived > &other) const |
| returns a matrix expression of the coefficient-wise operator min of *this and other | |
| Base & | ModAdd (const Scalar &other) |
| modifies this matrix by the coefficient-wise sum of *this and other | |
| Base & | ModDiv (const MathArrayBase< Scalar > &other) |
| modifies this matrix by the coefficient-wise division of *this and other | |
| Base & | ModMul (const MathArrayBase< Scalar > &other) |
| modifes this matrix by the coefficient-wise product of *this and other | |
| Base & | ModSub (const Scalar &other) |
| modifies this matrix by the coefficient-wise difference of *this and other | |
| Base | NotEqual (const TScalar &x) const |
| Base | NotEqual (const MathArrayBase< Scalar > &other) const |
| returns a matrix expression of the coefficient-wise operator != (inequal) of *this and other | |
| Base & | object () |
| returns the matrix object this class refers to | |
| const Base & | object () const |
| returns the matrix object this class refers to | |
| template<typename OtherDerived> | |
| Base | operator!= (const Eigen::MatrixBase< OtherDerived > &other) const |
| returns a matrix expression of the coefficient-wise operator != (inequal) of *this and other | |
| template<typename OtherDerived> | |
| Base | operator* (const Eigen::MatrixBase< OtherDerived > &other) const |
| returns a matrix expression of the coefficient-wise product of *this and other | |
| template<typename OtherDerived> | |
| Base & | operator*= (const Eigen::MatrixBase< OtherDerived > &other) |
| modifes this matrix by the coefficient-wise product of *this and other | |
| Base | operator+ (const Scalar &other) const |
| returns a matrix expression of the coefficient-wise sum of *this and other | |
| Base & | operator+= (const Scalar &other) |
| modifies this matrix by the coefficient-wise sum of *this and other | |
| Base | operator- (const Scalar &other) const |
| returns a matrix expression of the coefficient-wise difference of *this and other | |
| Base & | operator-= (const Scalar &other) |
| modifies this matrix by the coefficient-wise difference of *this and other | |
| template<typename OtherDerived> | |
| Base | operator/ (const Eigen::MatrixBase< OtherDerived > &other) const |
| returns a matrix expression of the coefficient-wise division of *this and other | |
| template<typename OtherDerived> | |
| Base & | operator/= (const Eigen::MatrixBase< OtherDerived > &other) |
| modifies this matrix by the coefficient-wise division of *this and other | |
| template<typename OtherDerived> | |
| Base | operator< (const Eigen::MatrixBase< OtherDerived > &other) const |
| returns a matrix expression of the coefficient-wise operator < of *this and other | |
| template<typename OtherDerived> | |
| Base | operator<= (const Eigen::MatrixBase< OtherDerived > &other) const |
| returns a matrix expression of the coefficient-wise operator <= of *this and other | |
| template<typename OtherDerived> | |
| Base | operator== (const Eigen::MatrixBase< OtherDerived > &other) const |
| returns a matrix expression of the coefficient-wise operator == (equal) of *this and other | |
| template<typename OtherDerived> | |
| Base | operator> (const Eigen::MatrixBase< OtherDerived > &other) const |
| returns a matrix expression of the coefficient-wise operator > of *this and other | |
| template<typename OtherDerived> | |
| Base | operator>= (const Eigen::MatrixBase< OtherDerived > &other) const |
| returns a matrix expression of the coefficient-wise operator >= of *this and other | |
| Base | Pow (const Scalar &exponent) const |
| returns a matrix object with coefficient-wise power of *this to the given exponent (operator ^) | |
| Base | pow (const Scalar &exponent) const |
| returns a matrix object with coefficient-wise power of *this to the given exponent | |
| Base | Sign () const |
| returns an array with elementwise sign (-1 if <0, 0 if=0, 1 if>0) | |
| Base | Sin () const |
| returns a matrix object with coefficient-wise sinus | |
| Base | Sin (const TScalar &a) const |
| returns a matrix object with coefficient-wise sinus of (this*a) | |
| Base | Sqrt () const |
| returns a matrix object with coefficient-wise square root | |
| Base | sqrt () const |
| returns a matrix object with coefficient-wise square root | |
| Base | Square () const |
| returns a matrix object with coefficient-wise squared value | |
| virtual | ~CWiseBase () |
| destructor | |
Protected Attributes | |
| Base * | m_object |
| the matrix object this class is operating on | |
Detailed Description
template<typename MatrixType, typename Scalar>
class tngmath::CWiseBase< MatrixType, Scalar >
providing componentwise operations to matrices Member Function Documentation
template<typename MatrixType, typename Scalar>
| Base tngmath::CWiseBase< MatrixType, Scalar >::Atan2 | ( | const MathArrayBase< TScalar > & | y | ) | const |
returns the arcus tangens from two parameters: x is this array, y is the given array The output object contains the elementwise atan2 values
The documentation for this class was generated from the following file:
- modules/tngmath/tngmath/matharraycwise.hpp
