RobWorkProject  24.5.15-
Classes | Public Member Functions | List of all members
EigenDecomposition< T > Class Template Reference

Type representing a set of eigen values and eigen vectors. More...

#include <EigenDecomposition.hpp>

Classes

struct  MapSort
 Sort function for ordering of eigen values and vectors. More...
 

Public Member Functions

 EigenDecomposition (Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic > vectors, Eigen::Matrix< T, Eigen::Dynamic, 1 > values)
 Construct new decomposition. More...
 
const Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic > & getEigenVectors ()
 returns all eigenvectors as columns in a matrix More...
 
Eigen::Matrix< T, Eigen::Dynamic, 1 > getEigenVector (size_t i)
 returns the i'th eigenvector More...
 
const Eigen::Matrix< T, Eigen::Dynamic, 1 > & getEigenValues ()
 return all eigenvalues More...
 
getEigenValue (size_t i)
 returns the i'th eigenvalue More...
 
void sort ()
 sorts the eigen vectors according to their eigen value. The vector with smallest eigen value has index 0
 

Detailed Description

template<class T = double>
class rw::math::EigenDecomposition< T >

Type representing a set of eigen values and eigen vectors.

Constructor & Destructor Documentation

◆ EigenDecomposition()

EigenDecomposition ( Eigen::Matrix< T, Eigen::Dynamic, Eigen::Dynamic >  vectors,
Eigen::Matrix< T, Eigen::Dynamic, 1 >  values 
)
inline

Construct new decomposition.

Parameters
vectors[in] the eigen vectors as columns in a matrix.
values[in] the corresponding eigen values.

Member Function Documentation

◆ getEigenValue()

T getEigenValue ( size_t  i)
inline

returns the i'th eigenvalue

Returns
the eigenvalue.

◆ getEigenValues()

const Eigen::Matrix<T, Eigen::Dynamic, 1>& getEigenValues ( )
inline

return all eigenvalues

Returns
the eigen values.

◆ getEigenVector()

Eigen::Matrix<T, Eigen::Dynamic, 1> getEigenVector ( size_t  i)
inline

returns the i'th eigenvector

Returns
the eigen vector.

◆ getEigenVectors()

const Eigen::Matrix<T, Eigen::Dynamic, Eigen::Dynamic>& getEigenVectors ( )
inline

returns all eigenvectors as columns in a matrix

Returns
reference to the matrix.

The documentation for this class was generated from the following files: