shark::MaxIterations< ResultSet > Class Template Reference

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
void	reset ()
	reset iteration counter

Protected Attributes
unsigned int	m_iteration
	current number of iterations
unsigned int	m_maxIterations
	maximum number of iteration allowed

Additional Inherited Members
Public Types inherited from shark::AbstractStoppingCriterion< ResultSetT >
typedef ResultSetT	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()

template<class ResultSet = SingleObjectiveResultSet<RealVector>>

shark::MaxIterations< ResultSet >::MaxIterations ( unsigned int  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()

template<class ResultSet = SingleObjectiveResultSet<RealVector>>

void shark::MaxIterations< ResultSet >::reset ( )

inlinevirtual

reset iteration counter

Implements shark::AbstractStoppingCriterion< ResultSetT >.

Definition at line 61 of file MaxIterations.h.

References shark::MaxIterations< ResultSet >::m_iteration.

setMaxIterations()

template<class ResultSet = SingleObjectiveResultSet<RealVector>>

void shark::MaxIterations< ResultSet >::setMaxIterations ( unsigned int  newIterations )

inline

Definition at line 52 of file MaxIterations.h.

References shark::MaxIterations< ResultSet >::m_maxIterations.

Referenced by main().

stop()

template<class ResultSet = SingleObjectiveResultSet<RealVector>>

bool shark::MaxIterations< ResultSet >::stop ( const ResultSet &  set )

inlinevirtual

returns true if training should stop

Implements shark::AbstractStoppingCriterion< ResultSetT >.

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

template<class ResultSet = SingleObjectiveResultSet<RealVector>>

unsigned int shark::MaxIterations< ResultSet >::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

template<class ResultSet = SingleObjectiveResultSet<RealVector>>

unsigned int shark::MaxIterations< ResultSet >::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