yat  0.18pre
Public Member Functions | List of all members
theplu::yat::utility::PCA Class Reference

Principal Component Analysis. More...

#include <yat/utility/PCA.h>

Public Member Functions

 PCA (const Matrix &)
 
 PCA (Matrix &&M)
 
const Vectoreigenvalues (void) const
 Returns eigenvalues. More...
 
const Matrixeigenvectors (void) const
 Get all eigenvectors in a Matrix. More...
 
Matrix projection (const Matrix &) const
 

Detailed Description

Principal Component Analysis.

Class performing PCA using SVD. This class assumes that the columns corresponds to the dimenension of the problem. That means if data has dimension NxM (M=columns) the number of principal-axes will equal M-1. When projecting data into this space, all Nx1 vectors will have dimension Mx1. Hence the projection will have dimension MxM where each column is a point in the new space.

Note
Currently number of rows, N, must be larger (or equal) than number of columns, M.

Constructor & Destructor Documentation

theplu::yat::utility::PCA::PCA ( const Matrix )
explicit

Constructor taking the data-matrix as input. No row-centering should have been performed and no products.

theplu::yat::utility::PCA::PCA ( Matrix &&  M)
explicit

Same as PCA(const Matrix&) but moves M rather than copy.

Since
new in yat 0.16

Member Function Documentation

const Vector& theplu::yat::utility::PCA::eigenvalues ( void  ) const

Returns eigenvalues.

Returns
A const reference to the internal vector containing all eigenvalues.
const Matrix& theplu::yat::utility::PCA::eigenvectors ( void  ) const

Get all eigenvectors in a Matrix.

Returns
A const reference to the internal matrix containing all eigenvectors.
Matrix theplu::yat::utility::PCA::projection ( const Matrix ) const

This function will project data onto the new coordinate-system where the axes are the calculated eigenvectors. This means that PCA must have been run before this function can be used! Output is presented as coordinates in the N-dimensional room spanned by the eigenvectors.


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

Generated on Sun Sep 27 2020 02:26:14 for yat by  doxygen 1.8.11