---
name: "mlpack_amf_ValidationRMSETermination"
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_ValidationRMSETermination"
---

# mlpack\_amf\_ValidationRMSETermination(3)

## NAME

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

## SYNOPSIS

### Public Member Functions

**ValidationRMSETermination** (MatType &V, size\_t **num\_test\_points**, double **tolerance**=1e-5, size\_t maxIterations=10000, size\_t reverseStepTolerance=3)\
 const double & **Index** ()\
 void **Initialize** (const MatType &)\
 bool **IsConverged** (arma::mat &**W**, arma::mat &**H**)\
 const size\_t & **Iteration** ()\
 const size\_t & **MaxIterations** ()\

### Private Attributes

double **c\_index**\
 double **c\_indexOld**\
 arma::mat **H**\
 bool **isCopy**\
 size\_t **iteration**\
 size\_t **maxIterations**\
 size\_t **num\_test\_points**\
 size\_t **reverseStepCount**\
 size\_t **reverseStepTolerance**\
 double **rmse**\
 double **rmseOld**\
 arma::Mat\< double \> **test\_points**\
 double **tolerance**\
 arma::mat **W**\

## Detailed Description

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

Definition at line 32 of file validation\_RMSE\_termination.hpp.

## Constructor & Destructor Documentation

### template\<class MatType \> mlpack::amf::ValidationRMSETermination\< MatType \>::ValidationRMSETermination (MatType &V, size\_tnum\_test\_points, doubletolerance = `1e-5`, size\_tmaxIterations = `10000`, size\_treverseStepTolerance = `3`)` [inline]`

Definition at line 35 of file validation\_RMSE\_termination.hpp.

References mlpack::amf::ValidationRMSETermination\< MatType \>::num\_test\_points, and mlpack::amf::ValidationRMSETermination\< MatType \>::test\_points.

## Member Function Documentation

### template\<class MatType \> const double& mlpack::amf::ValidationRMSETermination\< MatType \>::Index ()` [inline]`

Definition at line 142 of file validation\_RMSE\_termination.hpp.

References mlpack::amf::ValidationRMSETermination\< MatType \>::rmse.

### template\<class MatType \> void mlpack::amf::ValidationRMSETermination\< MatType \>::Initialize (const MatType &)` [inline]`

Definition at line 68 of file validation\_RMSE\_termination.hpp.

References mlpack::amf::ValidationRMSETermination\< MatType \>::c\_index, mlpack::amf::ValidationRMSETermination\< MatType \>::c\_indexOld, mlpack::amf::ValidationRMSETermination\< MatType \>::isCopy, mlpack::amf::ValidationRMSETermination\< MatType \>::iteration, mlpack::amf::ValidationRMSETermination\< MatType \>::reverseStepCount, mlpack::amf::ValidationRMSETermination\< MatType \>::rmse, and mlpack::amf::ValidationRMSETermination\< MatType \>::rmseOld.

### template\<class MatType \> bool mlpack::amf::ValidationRMSETermination\< MatType \>::IsConverged (arma::mat &W, arma::mat &H)` [inline]`

Definition at line 82 of file validation\_RMSE\_termination.hpp.

References mlpack::amf::ValidationRMSETermination\< MatType \>::c\_index, mlpack::amf::ValidationRMSETermination\< MatType \>::c\_indexOld, mlpack::amf::ValidationRMSETermination\< MatType \>::H, mlpack::amf::ValidationRMSETermination\< MatType \>::isCopy, mlpack::amf::ValidationRMSETermination\< MatType \>::iteration, mlpack::amf::ValidationRMSETermination\< MatType \>::maxIterations, mlpack::amf::ValidationRMSETermination\< MatType \>::num\_test\_points, mlpack::amf::ValidationRMSETermination\< MatType \>::reverseStepCount, mlpack::amf::ValidationRMSETermination\< MatType \>::reverseStepTolerance, mlpack::amf::ValidationRMSETermination\< MatType \>::rmse, mlpack::amf::ValidationRMSETermination\< MatType \>::rmseOld, mlpack::amf::ValidationRMSETermination\< MatType \>::test\_points, and mlpack::amf::ValidationRMSETermination\< MatType \>::W.

### template\<class MatType \> const size\_t& mlpack::amf::ValidationRMSETermination\< MatType \>::Iteration ()` [inline]`

Definition at line 144 of file validation\_RMSE\_termination.hpp.

References mlpack::amf::ValidationRMSETermination\< MatType \>::iteration.

### template\<class MatType \> const size\_t& mlpack::amf::ValidationRMSETermination\< MatType \>::MaxIterations ()` [inline]`

Definition at line 146 of file validation\_RMSE\_termination.hpp.

References mlpack::amf::ValidationRMSETermination\< MatType \>::maxIterations.

## Member Data Documentation

### template\<class MatType \> double mlpack::amf::ValidationRMSETermination\< MatType \>::c\_index` [private]`

Definition at line 166 of file validation\_RMSE\_termination.hpp.

Referenced by mlpack::amf::ValidationRMSETermination\< MatType \>::Initialize(), and mlpack::amf::ValidationRMSETermination\< MatType \>::IsConverged().

### template\<class MatType \> double mlpack::amf::ValidationRMSETermination\< MatType \>::c\_indexOld` [private]`

Definition at line 165 of file validation\_RMSE\_termination.hpp.

Referenced by mlpack::amf::ValidationRMSETermination\< MatType \>::Initialize(), and mlpack::amf::ValidationRMSETermination\< MatType \>::IsConverged().

### template\<class MatType \> arma::mat mlpack::amf::ValidationRMSETermination\< MatType \>::H` [private]`

Definition at line 164 of file validation\_RMSE\_termination.hpp.

Referenced by mlpack::amf::ValidationRMSETermination\< MatType \>::IsConverged().

### template\<class MatType \> bool mlpack::amf::ValidationRMSETermination\< MatType \>::isCopy` [private]`

Definition at line 162 of file validation\_RMSE\_termination.hpp.

Referenced by mlpack::amf::ValidationRMSETermination\< MatType \>::Initialize(), and mlpack::amf::ValidationRMSETermination\< MatType \>::IsConverged().

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

Definition at line 152 of file validation\_RMSE\_termination.hpp.

Referenced by mlpack::amf::ValidationRMSETermination\< MatType \>::Initialize(), mlpack::amf::ValidationRMSETermination\< MatType \>::IsConverged(), and mlpack::amf::ValidationRMSETermination\< MatType \>::Iteration().

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

Definition at line 150 of file validation\_RMSE\_termination.hpp.

Referenced by mlpack::amf::ValidationRMSETermination\< MatType \>::IsConverged(), and mlpack::amf::ValidationRMSETermination\< MatType \>::MaxIterations().

### template\<class MatType \> size\_t mlpack::amf::ValidationRMSETermination\< MatType \>::num\_test\_points` [private]`

Definition at line 151 of file validation\_RMSE\_termination.hpp.

Referenced by mlpack::amf::ValidationRMSETermination\< MatType \>::IsConverged(), and mlpack::amf::ValidationRMSETermination\< MatType \>::ValidationRMSETermination().

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

Definition at line 160 of file validation\_RMSE\_termination.hpp.

Referenced by mlpack::amf::ValidationRMSETermination\< MatType \>::Initialize(), and mlpack::amf::ValidationRMSETermination\< MatType \>::IsConverged().

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

Definition at line 159 of file validation\_RMSE\_termination.hpp.

Referenced by mlpack::amf::ValidationRMSETermination\< MatType \>::IsConverged().

### template\<class MatType \> double mlpack::amf::ValidationRMSETermination\< MatType \>::rmse` [private]`

Definition at line 157 of file validation\_RMSE\_termination.hpp.

Referenced by mlpack::amf::ValidationRMSETermination\< MatType \>::Index(), mlpack::amf::ValidationRMSETermination\< MatType \>::Initialize(), and mlpack::amf::ValidationRMSETermination\< MatType \>::IsConverged().

### template\<class MatType \> double mlpack::amf::ValidationRMSETermination\< MatType \>::rmseOld` [private]`

Definition at line 156 of file validation\_RMSE\_termination.hpp.

Referenced by mlpack::amf::ValidationRMSETermination\< MatType \>::Initialize(), and mlpack::amf::ValidationRMSETermination\< MatType \>::IsConverged().

### template\<class MatType \> arma::Mat\<double\> mlpack::amf::ValidationRMSETermination\< MatType \>::test\_points` [private]`

Definition at line 154 of file validation\_RMSE\_termination.hpp.

Referenced by mlpack::amf::ValidationRMSETermination\< MatType \>::IsConverged(), and mlpack::amf::ValidationRMSETermination\< MatType \>::ValidationRMSETermination().

### template\<class MatType \> double mlpack::amf::ValidationRMSETermination\< MatType \>::tolerance` [private]`

Definition at line 149 of file validation\_RMSE\_termination.hpp.

### template\<class MatType \> arma::mat mlpack::amf::ValidationRMSETermination\< MatType \>::W` [private]`

Definition at line 163 of file validation\_RMSE\_termination.hpp.

Referenced by mlpack::amf::ValidationRMSETermination\< MatType \>::IsConverged().

## Author

Generated automatically by Doxygen for MLPACK from the source code.