---
name: "mlpack_amf_CompleteIncrementalTermination"
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_CompleteIncrementalTermination"
---

# mlpack\_amf\_CompleteIncrementalTermination(3)

## NAME

mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \> -

## SYNOPSIS

### Public Member Functions

**CompleteIncrementalTermination** (TerminationPolicy **t\_policy**=TerminationPolicy())\
 const double & **Index** ()\
 template\<class MatType \> void **Initialize** (const MatType &V)\
 void **Initialize** (const arma::sp\_mat &V)\
 bool **IsConverged** (arma::mat &W, arma::mat &H)\
 const size\_t & **Iteration** ()\
 const size\_t & **MaxIterations** ()\

### Private Attributes

size\_t **incrementalIndex**\
 size\_t **iteration**\
 TerminationPolicy **t\_policy**\

## Detailed Description

### template\<class TerminationPolicy\>class mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>

Definition at line 31 of file complete\_incremental\_termination.hpp.

## Constructor & Destructor Documentation

### template\<class TerminationPolicy \> mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::CompleteIncrementalTermination (TerminationPolicyt\_policy = `TerminationPolicy()`)` [inline]`

Definition at line 34 of file complete\_incremental\_termination.hpp.

## Member Function Documentation

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

Definition at line 62 of file complete\_incremental\_termination.hpp.

References mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::t\_policy.

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

Definition at line 38 of file complete\_incremental\_termination.hpp.

References mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::incrementalIndex, mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::iteration, and mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::t\_policy.

### template\<class TerminationPolicy \> void mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::Initialize (const arma::sp\_mat &V)` [inline]`

Definition at line 46 of file complete\_incremental\_termination.hpp.

References mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::incrementalIndex, mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::iteration, and mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::t\_policy.

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

Definition at line 54 of file complete\_incremental\_termination.hpp.

References mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::incrementalIndex, mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::iteration, and mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::t\_policy.

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

Definition at line 66 of file complete\_incremental\_termination.hpp.

References mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::iteration.

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

Definition at line 71 of file complete\_incremental\_termination.hpp.

References mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::t\_policy.

## Member Data Documentation

### template\<class TerminationPolicy \> size\_t mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::incrementalIndex` [private]`

Definition at line 79 of file complete\_incremental\_termination.hpp.

Referenced by mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::Initialize(), and mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::IsConverged().

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

Definition at line 80 of file complete\_incremental\_termination.hpp.

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

### template\<class TerminationPolicy \> TerminationPolicy mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::t\_policy` [private]`

Definition at line 77 of file complete\_incremental\_termination.hpp.

Referenced by mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::Index(), mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::Initialize(), mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::IsConverged(), and mlpack::amf::CompleteIncrementalTermination\< TerminationPolicy \>::MaxIterations().

## Author

Generated automatically by Doxygen for MLPACK from the source code.