mlpack  2.0.1
Public Member Functions | Private Attributes | List of all members
mlpack::amf::SVDCompleteIncrementalLearning< arma::sp_mat > Class Template Reference

TODO : Merge this template specialized function for sparse matrix using common row_col_iterator. More...

Public Member Functions

 SVDCompleteIncrementalLearning (double u=0.01, double kw=0, double kh=0)
 
 ~SVDCompleteIncrementalLearning ()
 
void HUpdate (const arma::sp_mat &V, const arma::mat &W, arma::mat &H)
 The update rule for the encoding matrix H. More...
 
void Initialize (const arma::sp_mat &dataset, const size_t rank)
 
void WUpdate (const arma::sp_mat &V, arma::mat &W, const arma::mat &H)
 The update rule for the basis matrix W. More...
 

Private Attributes

arma::sp_mat dummy
 
bool isStart
 
arma::sp_mat::const_iterator * it
 
double kh
 
double kw
 
size_t m
 
size_t n
 
double u
 

Detailed Description

template<>
class mlpack::amf::SVDCompleteIncrementalLearning< arma::sp_mat >

TODO : Merge this template specialized function for sparse matrix using common row_col_iterator.

template specialiazed functions for sparse matrices

Definition at line 171 of file svd_complete_incremental_learning.hpp.

Constructor & Destructor Documentation

◆ SVDCompleteIncrementalLearning()

mlpack::amf::SVDCompleteIncrementalLearning< arma::sp_mat >::SVDCompleteIncrementalLearning ( double  u = 0.01,
double  kw = 0,
double  kh = 0 
)
inline

Definition at line 174 of file svd_complete_incremental_learning.hpp.

◆ ~SVDCompleteIncrementalLearning()

Definition at line 180 of file svd_complete_incremental_learning.hpp.

Member Function Documentation

◆ HUpdate()

void mlpack::amf::SVDCompleteIncrementalLearning< arma::sp_mat >::HUpdate ( const arma::sp_mat &  V,
const arma::mat &  W,
arma::mat &  H 
)
inline

The update rule for the encoding matrix H.

The function takes in all the matrices and only changes the value of the H matrix.

Parameters
VInput matrix to be factorized.
WBasis matrix.
HEncoding matrix to be updated.

Definition at line 239 of file svd_complete_incremental_learning.hpp.

References mlpack::amf::SVDCompleteIncrementalLearning< MatType >::currentItemIndex, mlpack::amf::SVDCompleteIncrementalLearning< MatType >::currentUserIndex, mlpack::amf::SVDCompleteIncrementalLearning< MatType >::kh, and mlpack::amf::SVDCompleteIncrementalLearning< MatType >::u.

◆ Initialize()

void mlpack::amf::SVDCompleteIncrementalLearning< arma::sp_mat >::Initialize ( const arma::sp_mat &  dataset,
const size_t  rank 
)
inline

Definition at line 185 of file svd_complete_incremental_learning.hpp.

◆ WUpdate()

void mlpack::amf::SVDCompleteIncrementalLearning< arma::sp_mat >::WUpdate ( const arma::sp_mat &  V,
arma::mat &  W,
const arma::mat &  H 
)
inline

The update rule for the basis matrix W.

The function takes in all the matrices and only changes the value of the W matrix.

Parameters
VInput matrix to be factorized.
WBasis matrix to be updated.
HEncoding matrix.

Definition at line 204 of file svd_complete_incremental_learning.hpp.

References mlpack::amf::SVDCompleteIncrementalLearning< MatType >::currentItemIndex, mlpack::amf::SVDCompleteIncrementalLearning< MatType >::currentUserIndex, mlpack::amf::SVDCompleteIncrementalLearning< MatType >::kw, and mlpack::amf::SVDCompleteIncrementalLearning< MatType >::u.

Member Data Documentation

◆ dummy

arma::sp_mat mlpack::amf::SVDCompleteIncrementalLearning< arma::sp_mat >::dummy
private

Definition at line 266 of file svd_complete_incremental_learning.hpp.

◆ isStart

bool mlpack::amf::SVDCompleteIncrementalLearning< arma::sp_mat >::isStart
private

Definition at line 269 of file svd_complete_incremental_learning.hpp.

◆ it

arma::sp_mat::const_iterator* mlpack::amf::SVDCompleteIncrementalLearning< arma::sp_mat >::it
private

Definition at line 267 of file svd_complete_incremental_learning.hpp.

◆ kh

double mlpack::amf::SVDCompleteIncrementalLearning< arma::sp_mat >::kh
private

Definition at line 261 of file svd_complete_incremental_learning.hpp.

◆ kw

double mlpack::amf::SVDCompleteIncrementalLearning< arma::sp_mat >::kw
private

Definition at line 260 of file svd_complete_incremental_learning.hpp.

◆ m

size_t mlpack::amf::SVDCompleteIncrementalLearning< arma::sp_mat >::m
private

Definition at line 264 of file svd_complete_incremental_learning.hpp.

◆ n

size_t mlpack::amf::SVDCompleteIncrementalLearning< arma::sp_mat >::n
private

Definition at line 263 of file svd_complete_incremental_learning.hpp.

◆ u

double mlpack::amf::SVDCompleteIncrementalLearning< arma::sp_mat >::u
private

Definition at line 259 of file svd_complete_incremental_learning.hpp.


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