This stopping criterion stops after a fixed number of iterations. More...
#include <shark/Algorithms/StoppingCriteria/MaxIterations.h>
Inheritance diagram for shark::MaxIterations< ResultSet >:
Public Member Functions | |
| MaxIterations (unsigned int maxIterations) | |
| void | setMaxIterations (unsigned int newIterations) |
| bool | stop (const ResultSet &set) |
| returns true if training should stop More... | |
| void | reset () |
| reset iteration counter More... | |
Protected Attributes | |
| unsigned int | m_iteration |
| current number of iterations More... | |
| unsigned int | m_maxIterations |
| maximum number of iteration allowed More... | |
Additional Inherited Members | |
| Public Types inherited from shark::AbstractStoppingCriterion< ResultSet > | |
| typedef ResultSet | ResultSet |
Detailed Description
template<class ResultSet = SingleObjectiveResultSet<RealVector>>
class shark::MaxIterations< ResultSet >
This stopping criterion stops after a fixed number of iterations.
Definition at line 43 of file MaxIterations.h.
Constructor & Destructor Documentation
◆ MaxIterations()
|
inline |
constructs the MaxIterations stopping criterion
- Parameters
-
maxIterations maximum iterations before training should stop
Definition at line 47 of file MaxIterations.h.
References shark::MaxIterations< ResultSet >::m_iteration, and shark::MaxIterations< ResultSet >::m_maxIterations.
Member Function Documentation
◆ reset()
|
inlinevirtual |
reset iteration counter
Implements shark::AbstractStoppingCriterion< ResultSet >.
Definition at line 61 of file MaxIterations.h.
References shark::MaxIterations< ResultSet >::m_iteration.
◆ setMaxIterations()
|
inline |
Definition at line 52 of file MaxIterations.h.
References shark::MaxIterations< ResultSet >::m_maxIterations.
Referenced by main().
◆ stop()
|
inlinevirtual |
returns true if training should stop
Implements shark::AbstractStoppingCriterion< ResultSet >.
Definition at line 56 of file MaxIterations.h.
References shark::MaxIterations< ResultSet >::m_iteration, and shark::MaxIterations< ResultSet >::m_maxIterations.
Member Data Documentation
◆ m_iteration
|
protected |
current number of iterations
Definition at line 66 of file MaxIterations.h.
Referenced by shark::MaxIterations< ResultSet >::MaxIterations(), shark::MaxIterations< ResultSet >::reset(), and shark::MaxIterations< ResultSet >::stop().
◆ m_maxIterations
|
protected |
maximum number of iteration allowed
Definition at line 68 of file MaxIterations.h.
Referenced by shark::MaxIterations< ResultSet >::MaxIterations(), shark::MaxIterations< ResultSet >::setMaxIterations(), and shark::MaxIterations< ResultSet >::stop().
The documentation for this class was generated from the following file:
- include/shark/Algorithms/StoppingCriteria/MaxIterations.h