mlpack
Public Member Functions | List of all members
RegSVDPolicy Class Reference

Implementation of the Regularized SVD policy to act as a wrapper when accessing Regularized SVD from within CFType. More...

Public Member Functions

 RegSVDPolicy (const size_t maxIterations=10)
 Use regularized SVD method to perform collaborative filtering. More...

 
void Apply (const arma::mat &data, const arma::sp_mat &, const size_t rank, arma::mat &w, arma::mat &h, const size_t maxIterations, const double, const bool)
 Apply Collaborative Filtering to the provided data set using the regularized SVD. More...

 
size_t MaxIterations () const
 Get the number of iterations. More...

 
size_t & MaxIterations ()
 Modify the number of iterations. More...

 

Detailed Description

Implementation of the Regularized SVD policy to act as a wrapper when accessing Regularized SVD from within CFType.

Definition at line 27 of file regularized_svd_method.hpp.

Constructor & Destructor Documentation

◆ RegSVDPolicy()

RegSVDPolicy ( const size_t  maxIterations = 10)
inline

Use regularized SVD method to perform collaborative filtering.

Parameters
maxIterationsNumber of iterations for the power method (Default: 2).

Definition at line 36 of file regularized_svd_method.hpp.

Member Function Documentation

◆ Apply()

void Apply ( const arma::mat &  data,
const arma::sp_mat &  ,
const size_t  rank,
arma::mat &  w,
arma::mat &  h,
const size_t  maxIterations,
const double  ,
const bool   
)
inline

Apply Collaborative Filtering to the provided data set using the regularized SVD.

Parameters
dataData matrix: dense matrix (coordinate lists) or sparse matrix(cleaned).
cleanedDataitem user table in form of sparse matrix.
rankRank parameter for matrix factorization.
wFirst matrix formed after decomposition.
hSecond matrix formed after decomposition.
maxIterationsMaximum number of iterations.
minResidueResidue required to terminate.
mitWhether to terminate only when maxIterations is reached.

Definition at line 56 of file regularized_svd_method.hpp.

References RegularizedSVD< OptimizerType >::Apply().

◆ MaxIterations() [1/2]

size_t MaxIterations ( ) const
inline

Get the number of iterations.

Definition at line 71 of file regularized_svd_method.hpp.

◆ MaxIterations() [2/2]

size_t& MaxIterations ( )
inline

Modify the number of iterations.

Definition at line 73 of file regularized_svd_method.hpp.

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