---
name: "mlpack_amf_SimpleResidueTermination"
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_SimpleResidueTermination"
---

# mlpack\_amf\_SimpleResidueTermination(3)

## NAME

mlpack::amf::SimpleResidueTermination -

## SYNOPSIS

### Public Member Functions

**SimpleResidueTermination** (const double **minResidue**=1e-10, const size\_t maxIterations=10000)\
 const double & **Index** ()\
 template\<typename MatType \> void **Initialize** (const MatType &V)\
 bool **IsConverged** (arma::mat &W, arma::mat &H)\
 const size\_t & **Iteration** ()\
 const size\_t & **MaxIterations** ()\

### Public Attributes

size\_t **iteration**\
 size\_t **maxIterations**\
 double **minResidue**\
 size\_t **nm**\
 double **normOld**\
 double **residue**\

## Detailed Description

Definition at line 28 of file simple\_residue\_termination.hpp.

## Constructor & Destructor Documentation

### mlpack::amf::SimpleResidueTermination::SimpleResidueTermination (const doubleminResidue = `1e-10`, const size\_tmaxIterations = `10000`)` [inline]`

Definition at line 31 of file simple\_residue\_termination.hpp.

## Member Function Documentation

### const double& mlpack::amf::SimpleResidueTermination::Index ()` [inline]`

Definition at line 70 of file simple\_residue\_termination.hpp.

References residue.

### template\<typename MatType \> void mlpack::amf::SimpleResidueTermination::Initialize (const MatType &V)` [inline]`

Definition at line 36 of file simple\_residue\_termination.hpp.

References iteration, minResidue, nm, normOld, and residue.

### bool mlpack::amf::SimpleResidueTermination::IsConverged (arma::mat &W, arma::mat &H)` [inline]`

Definition at line 48 of file simple\_residue\_termination.hpp.

References iteration, maxIterations, nm, normOld, and residue.

### const size\_t& mlpack::amf::SimpleResidueTermination::Iteration ()` [inline]`

Definition at line 71 of file simple\_residue\_termination.hpp.

References iteration.

### const size\_t& mlpack::amf::SimpleResidueTermination::MaxIterations ()` [inline]`

Definition at line 72 of file simple\_residue\_termination.hpp.

References maxIterations.

## Member Data Documentation

### size\_t mlpack::amf::SimpleResidueTermination::iteration

Definition at line 79 of file simple\_residue\_termination.hpp.

Referenced by Initialize(), IsConverged(), and Iteration().

### size\_t mlpack::amf::SimpleResidueTermination::maxIterations

Definition at line 76 of file simple\_residue\_termination.hpp.

Referenced by IsConverged(), and MaxIterations().

### double mlpack::amf::SimpleResidueTermination::minResidue

Definition at line 75 of file simple\_residue\_termination.hpp.

Referenced by Initialize().

### size\_t mlpack::amf::SimpleResidueTermination::nm

Definition at line 82 of file simple\_residue\_termination.hpp.

Referenced by Initialize(), and IsConverged().

### double mlpack::amf::SimpleResidueTermination::normOld

Definition at line 80 of file simple\_residue\_termination.hpp.

Referenced by Initialize(), and IsConverged().

### double mlpack::amf::SimpleResidueTermination::residue

Definition at line 78 of file simple\_residue\_termination.hpp.

Referenced by Index(), Initialize(), and IsConverged().

## Author

Generated automatically by Doxygen for MLPACK from the source code.