mlpack
Public Member Functions | List of all members
mlpack::pca::RandomizedSVDPolicy Class Reference

Implementation of the randomized SVD policy. More...

#include <randomized_svd_method.hpp>

Public Member Functions

 RandomizedSVDPolicy (const size_t iteratedPower=0, const size_t maxIterations=2)
 Use randomized SVD method to perform the principal components analysis (PCA). More...
 
void Apply (const arma::mat &data, const arma::mat &centeredData, arma::mat &transformedData, arma::vec &eigVal, arma::mat &eigvec, const size_t rank)
 Apply Principal Component Analysis to the provided data set using the randomized SVD. More...
 
size_t IteratedPower () const
 Get the size of the normalized power iterations.
 
size_t & IteratedPower ()
 Modify the size of the normalized power iterations.
 
size_t MaxIterations () const
 Get the number of iterations for the power method.
 
size_t & MaxIterations ()
 Modify the number of iterations for the power method.
 

Detailed Description

Implementation of the randomized SVD policy.

Constructor & Destructor Documentation

◆ RandomizedSVDPolicy()

mlpack::pca::RandomizedSVDPolicy::RandomizedSVDPolicy ( const size_t  iteratedPower = 0,
const size_t  maxIterations = 2 
)
inline

Use randomized SVD method to perform the principal components analysis (PCA).

Parameters
iteratedPowerSize of the normalized power iterations (Default: rank + 2).
maxIterationsNumber of iterations for the power method (Default: 2).

Member Function Documentation

◆ Apply()

void mlpack::pca::RandomizedSVDPolicy::Apply ( const arma::mat &  data,
const arma::mat &  centeredData,
arma::mat &  transformedData,
arma::vec &  eigVal,
arma::mat &  eigvec,
const size_t  rank 
)
inline

Apply Principal Component Analysis to the provided data set using the randomized SVD.

Parameters
dataData matrix.
centeredDataCentered data matrix.
transformedDataMatrix to put results of PCA into.
eigValVector to put eigenvalues into.
eigvecMatrix to put eigenvectors (loadings) into.
rankRank of the decomposition.

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