tngmath::SVDBase< MatrixType, Scalar > Class Template Reference
#include <matharraysvd.hpp>
Collaboration diagram for tngmath::SVDBase< MatrixType, Scalar >:
Public Types | |
|
typedef Eigen::Matrix< Scalar, Eigen::Dynamic, Eigen::Dynamic, Eigen::ColMajor > | Base |
| typedef int | TIndex |
| typedef Scalar | TScalar |
Public Member Functions | |
| MatrixType | MatrixU () const |
| returns matrix U | |
| MatrixType | MatrixV () const |
| returns matrix V | |
| Base & | object () |
| returns the matrix object this class refers to | |
| const Base & | object () const |
| returns the matrix object this class refers to | |
| MatrixType | SingularValues () const |
| returns singular values as vector | |
| MatrixType | Solve (const MathArrayBase< TScalar > &n) const |
| returns this->inverse*n using a temporary LU decomposition which will be computed in place | |
| Eigen::SVD< Base > & | svd () |
| returns the lu object this class refers to | |
| const Eigen::SVD< Base > & | svd () const |
| returns the lu object this class refers to | |
| SVDBase () | |
| a default constructor used for SWIG - it should never be called when using this object, else one will cause a segfault! | |
| SVDBase (MatrixType &_object) | |
| constructor | |
| virtual | ~SVDBase () |
| destructor | |
Protected Attributes | |
| Base * | m_object |
| the matrix object this class is operating on | |
| Eigen::SVD< Base > | m_svd |
| the LU object | |
Detailed Description
template<typename MatrixType, typename Scalar>
class tngmath::SVDBase< MatrixType, Scalar >
provides a SVD decomposition. It works on a reference to an existing matrix object. This marix object must exist during the lifetime of the solver object! The documentation for this class was generated from the following file:
- modules/tngmath/tngmath/matharraysvd.hpp
