mlpack
2.0.1
|
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... | |
Private Attributes | |
size_t | iteration |
The number of the current iteration. More... | |
size_t | maxIterations |
The maximum number of allowed iterations. More... | |
This termination policy only terminates when the maximum number of iterations has been reached.
Definition at line 25 of file max_iteration_termination.hpp.
|
inline |
Construct the termination policy with the given number of iterations allowed (default 1000).
If maxIterations is 0, then termination will never occur.
maxIterations | Maximum number of allowed iterations. |
Definition at line 35 of file max_iteration_termination.hpp.
References mlpack::Log::Warn.
|
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 62 of file max_iteration_termination.hpp.
References iteration, and maxIterations.
|
inline |
Initialize for the given matrix V (there is nothing to do).
Definition at line 49 of file max_iteration_termination.hpp.
|
inline |
Check if convergence has occurred.
Definition at line 54 of file max_iteration_termination.hpp.
References iteration, and maxIterations.
|
inline |
Get the current iteration.
Definition at line 68 of file max_iteration_termination.hpp.
References iteration.
|
inline |
Modify the current iteration.
Definition at line 70 of file max_iteration_termination.hpp.
References iteration.
|
inline |
Get the maximum number of iterations.
Definition at line 73 of file max_iteration_termination.hpp.
References maxIterations.
|
inline |
Modify the maximum number of iterations.
Definition at line 75 of file max_iteration_termination.hpp.
References maxIterations.
|
private |
The number of the current iteration.
Definition at line 81 of file max_iteration_termination.hpp.
Referenced by Index(), IsConverged(), and Iteration().
|
private |
The maximum number of allowed iterations.
Definition at line 79 of file max_iteration_termination.hpp.
Referenced by Index(), IsConverged(), and MaxIterations().