mlpack::amf::MaxIterationTermination Class Reference

This termination policy only terminates when the maximum number of iterations has been reached. More...

#include <max_iteration_termination.hpp>

Public Member Functions
	MaxIterationTermination (const size_t maxIterations)
	Construct the termination policy with the given number of iterations allowed (default 1000). More...
template<typename MatType >
void	Initialize (const MatType &)
	Initialize for the given matrix V (there is nothing to do).
bool	IsConverged (const arma::mat &, const arma::mat &)
	Check if convergence has occurred.
size_t	Index ()
	Return something similar to the residue, which in this case is just the number of iterations left, since we don't have access to anything else. More...
size_t	Iteration () const
	Get the current iteration.
size_t &	Iteration ()
	Modify the current iteration.
size_t	MaxIterations () const
	Get the maximum number of iterations.
size_t &	MaxIterations ()
	Modify the maximum number of iterations.

Detailed Description

This termination policy only terminates when the maximum number of iterations has been reached.

Constructor & Destructor Documentation

MaxIterationTermination()

mlpack::amf::MaxIterationTermination::MaxIterationTermination ( const size_t  maxIterations )

inline

Construct the termination policy with the given number of iterations allowed (default 1000).

If maxIterations is 0, then termination will never occur.

Parameters

maxIterations

Maximum number of allowed iterations.

Member Function Documentation

Index()

size_t mlpack::amf::MaxIterationTermination::Index ( )

inline

Return something similar to the residue, which in this case is just the number of iterations left, since we don't have access to anything else.

---

The documentation for this class was generated from the following file:

• src/mlpack/methods/amf/termination_policies/max_iteration_termination.hpp