This termination policy only terminates when the maximum number of iterations has been reached. More...
Public Member Functions | |
| MaxIterationTermination (const size_t maxIterations) | |
| Construct the termination policy with the given number of iterations allowed (default 1000). More... | |
| 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... | |
template < typename MatType > | |
| void | Initialize (const MatType &) |
| Initialize for the given matrix V (there is nothing to do). More... | |
| bool | IsConverged (const arma::mat &, const arma::mat &) |
| Check if convergence has occurred. More... | |
| size_t | Iteration () const |
| Get the current iteration. More... | |
| size_t & | Iteration () |
| Modify the current iteration. More... | |
| size_t | MaxIterations () const |
| Get the maximum number of iterations. More... | |
| size_t & | MaxIterations () |
| Modify the maximum number of iterations. More... | |
Detailed Description
This termination policy only terminates when the maximum number of iterations has been reached.
Definition at line 23 of file max_iteration_termination.hpp.
Constructor & Destructor Documentation
◆ MaxIterationTermination()
|
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.
Definition at line 33 of file max_iteration_termination.hpp.
References Log::Warn.
Member Function Documentation
◆ 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.
Definition at line 60 of file max_iteration_termination.hpp.
◆ Initialize()
|
inline |
Initialize for the given matrix V (there is nothing to do).
Definition at line 47 of file max_iteration_termination.hpp.
◆ IsConverged()
|
inline |
Check if convergence has occurred.
Definition at line 52 of file max_iteration_termination.hpp.
◆ Iteration() [1/2]
|
inline |
Get the current iteration.
Definition at line 66 of file max_iteration_termination.hpp.
◆ Iteration() [2/2]
|
inline |
Modify the current iteration.
Definition at line 68 of file max_iteration_termination.hpp.
◆ MaxIterations() [1/2]
|
inline |
Get the maximum number of iterations.
Definition at line 71 of file max_iteration_termination.hpp.
◆ MaxIterations() [2/2]
|
inline |
Modify the maximum number of iterations.
Definition at line 73 of file max_iteration_termination.hpp.
The documentation for this class was generated from the following file:
- /home/ryan/src/mlpack.org/_src/mlpack-git/src/mlpack/methods/amf/termination_policies/max_iteration_termination.hpp