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

Implementation of the QUIC-SVD policy. More...

#include <quic_svd_method.hpp>

Public Member Functions

 QUICSVDPolicy (const double epsilon=0.03, const double delta=0.1)
 Use QUIC-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)
 Apply Principal Component Analysis to the provided data set using the QUIC-SVD method. More...
 
double Epsilon () const
 Get the error tolerance fraction for calculated subspace.
 
double & Epsilon ()
 Modify the error tolerance fraction for calculated subspace.
 
double Delta () const
 Get the cumulative probability for Monte Carlo error lower bound.
 
double & Delta ()
 Modify the cumulative probability for Monte Carlo error lower bound.
 

Detailed Description

Implementation of the QUIC-SVD policy.

Constructor & Destructor Documentation

◆ QUICSVDPolicy()

mlpack::pca::QUICSVDPolicy::QUICSVDPolicy ( const double  epsilon = 0.03,
const double  delta = 0.1 
)
inline

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

Parameters
epsilonError tolerance fraction for calculated subspace.
deltaCumulative probability for Monte Carlo error lower bound.

Member Function Documentation

◆ Apply()

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

Apply Principal Component Analysis to the provided data set using the QUIC-SVD method.

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

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