---
name: "mlpack_amf_SVDBatchLearning"
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_SVDBatchLearning"
---

# mlpack\_amf\_SVDBatchLearning(3)

## NAME

mlpack::amf::SVDBatchLearning -

## SYNOPSIS

### Public Member Functions

**SVDBatchLearning** (double **u**=0.0002, double **kw**=0, double **kh**=0, double **momentum**=0.9, double **min**=-DBL\_MIN, double **max**=DBL\_MAX)\
 template\<typename MatType \> void **HUpdate** (const MatType &V, const arma::mat &W, arma::mat &H)\
 *The update rule for the encoding matrix H.*  template\<typename MatType \> void **Initialize** (const MatType &dataset, const size\_t rank)\
 template\<typename MatType \> void **WUpdate** (const MatType &V, arma::mat &W, const arma::mat &H)\
 *The update rule for the basis matrix W.*

### Private Attributes

double **kh**\
 double **kw**\
 double **max**\
 arma::mat **mH**\
 double **min**\
 double **momentum**\
 arma::mat **mW**\
 double **u**\

## Detailed Description

Definition at line 29 of file svd\_batch\_learning.hpp.

## Constructor & Destructor Documentation

### mlpack::amf::SVDBatchLearning::SVDBatchLearning (doubleu = `0.0002`, doublekw = `0`, doublekh = `0`, doublemomentum = `0.9`, doublemin = `-DBL_MIN`, doublemax = `DBL_MAX`)` [inline]`

Definition at line 32 of file svd\_batch\_learning.hpp.

## Member Function Documentation

### template\<typename MatType \> void mlpack::amf::SVDBatchLearning::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 101 of file svd\_batch\_learning.hpp.

References kh, mH, momentum, and u.

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

Definition at line 42 of file svd\_batch\_learning.hpp.

References mH, and mW.

### template\<typename MatType \> void mlpack::amf::SVDBatchLearning::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.

Definition at line 61 of file svd\_batch\_learning.hpp.

References kw, momentum, mW, and u.

## Member Data Documentation

### double mlpack::amf::SVDBatchLearning::kh` [private]`

Definition at line 134 of file svd\_batch\_learning.hpp.

Referenced by HUpdate().

### double mlpack::amf::SVDBatchLearning::kw` [private]`

Definition at line 133 of file svd\_batch\_learning.hpp.

Referenced by WUpdate().

### double mlpack::amf::SVDBatchLearning::max` [private]`

Definition at line 136 of file svd\_batch\_learning.hpp.

### arma::mat mlpack::amf::SVDBatchLearning::mH` [private]`

Definition at line 140 of file svd\_batch\_learning.hpp.

Referenced by HUpdate(), and Initialize().

### double mlpack::amf::SVDBatchLearning::min` [private]`

Definition at line 135 of file svd\_batch\_learning.hpp.

### double mlpack::amf::SVDBatchLearning::momentum` [private]`

Definition at line 137 of file svd\_batch\_learning.hpp.

Referenced by HUpdate(), and WUpdate().

### arma::mat mlpack::amf::SVDBatchLearning::mW` [private]`

Definition at line 139 of file svd\_batch\_learning.hpp.

Referenced by Initialize(), and WUpdate().

### double mlpack::amf::SVDBatchLearning::u` [private]`

Definition at line 132 of file svd\_batch\_learning.hpp.

Referenced by HUpdate(), and WUpdate().

## Author

Generated automatically by Doxygen for MLPACK from the source code.