---
name: "mlpack_amf_SVDCompleteIncrementalLearning"
section: "3"
platform: "linux"
package: "mlpack-doc"
version: "1.0.10-1"
release: "Debian 8 (Jessie)"
platforms: ["linux"]
url: "https://new.carta.tech/mlpack_amf_SVDCompleteIncrementalLearning"
---

# mlpack\_amf\_SVDCompleteIncrementalLearning(3)

## NAME

mlpack::amf::SVDCompleteIncrementalLearning\< MatType \> -

## SYNOPSIS

### Public Member Functions

**SVDCompleteIncrementalLearning** (double **u**=0.0001, double **kw**=0, double **kh**=0)\
 void **HUpdate** (const MatType &V, const arma::mat &W, arma::mat &H)\
 *The update rule for the encoding matrix H.*  void **Initialize** (const MatType &dataset, const size\_t rank)\
 void **WUpdate** (const MatType &V, arma::mat &W, const arma::mat &H)\
 *The update rule for the basis matrix W.*

### Private Attributes

size\_t **currentItemIndex**\
 size\_t **currentUserIndex**\
 double **kh**\
 double **kw**\
 size\_t **m**\
 size\_t **n**\
 double **u**\

## Detailed Description

### template\<class MatType\>class mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>

Definition at line 12 of file svd\_complete\_incremental\_learning.hpp.

## Constructor & Destructor Documentation

### template\<class MatType \> mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::SVDCompleteIncrementalLearning (doubleu = `0.0001`, doublekw = `0`, doublekh = `0`)` [inline]`

Definition at line 15 of file svd\_complete\_incremental\_learning.hpp.

## Member Function Documentation

### template\<class MatType \> void mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::HUpdate (const MatType &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:**

*V* Input matrix to be factorized. \
 *W* Basis matrix. \
 *H* Encoding matrix to be updated.

Definition at line 91 of file svd\_complete\_incremental\_learning.hpp.

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

### template\<class MatType \> void mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::Initialize (const MatType &dataset, const size\_trank)` [inline]`

Definition at line 21 of file svd\_complete\_incremental\_learning.hpp.

References mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::currentItemIndex, mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::currentUserIndex, mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::m, and mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::n.

### template\<class MatType \> void mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::WUpdate (const MatType &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:**

*V* Input matrix to be factorized. \
 *W* Basis matrix to be updated. \
 *H* Encoding matrix.

This file is part of MLPACK 1.0.10.

MLPACK is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

MLPACK is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details (LICENSE.txt).

You should have received a copy of the GNU General Public License along with MLPACK. If not, see http://www.gnu.org/licenses/.

Definition at line 55 of file svd\_complete\_incremental\_learning.hpp.

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

## Member Data Documentation

### template\<class MatType \> size\_t mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::currentItemIndex` [private]`

Definition at line 126 of file svd\_complete\_incremental\_learning.hpp.

Referenced by mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::HUpdate(), mlpack::amf::SVDCompleteIncrementalLearning\< arma::sp\_mat \>::HUpdate(), mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::Initialize(), mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::WUpdate(), and mlpack::amf::SVDCompleteIncrementalLearning\< arma::sp\_mat \>::WUpdate().

### template\<class MatType \> size\_t mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::currentUserIndex` [private]`

Definition at line 125 of file svd\_complete\_incremental\_learning.hpp.

Referenced by mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::HUpdate(), mlpack::amf::SVDCompleteIncrementalLearning\< arma::sp\_mat \>::HUpdate(), mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::Initialize(), mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::WUpdate(), and mlpack::amf::SVDCompleteIncrementalLearning\< arma::sp\_mat \>::WUpdate().

### template\<class MatType \> double mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::kh` [private]`

Definition at line 120 of file svd\_complete\_incremental\_learning.hpp.

Referenced by mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::HUpdate(), and mlpack::amf::SVDCompleteIncrementalLearning\< arma::sp\_mat \>::HUpdate().

### template\<class MatType \> double mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::kw` [private]`

Definition at line 119 of file svd\_complete\_incremental\_learning.hpp.

Referenced by mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::WUpdate(), and mlpack::amf::SVDCompleteIncrementalLearning\< arma::sp\_mat \>::WUpdate().

### template\<class MatType \> size\_t mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::m` [private]`

Definition at line 123 of file svd\_complete\_incremental\_learning.hpp.

Referenced by mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::HUpdate(), mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::Initialize(), mlpack::amf::SVDCompleteIncrementalLearning\< arma::sp\_mat \>::Initialize(), and mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::WUpdate().

### template\<class MatType \> size\_t mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::n` [private]`

Definition at line 122 of file svd\_complete\_incremental\_learning.hpp.

Referenced by mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::HUpdate(), mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::Initialize(), mlpack::amf::SVDCompleteIncrementalLearning\< arma::sp\_mat \>::Initialize(), and mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::WUpdate().

### template\<class MatType \> double mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::u` [private]`

Definition at line 118 of file svd\_complete\_incremental\_learning.hpp.

Referenced by mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::HUpdate(), mlpack::amf::SVDCompleteIncrementalLearning\< arma::sp\_mat \>::HUpdate(), mlpack::amf::SVDCompleteIncrementalLearning\< MatType \>::WUpdate(), and mlpack::amf::SVDCompleteIncrementalLearning\< arma::sp\_mat \>::WUpdate().

## Author

Generated automatically by Doxygen for MLPACK from the source code.