shark::ValidatedStoppingCriterion Class Reference

Given the current Result set of the optimizer, calculates the validation error using a validation function and hands the results over to the underlying stopping criterion. More...

#include <shark/Algorithms/StoppingCriteria/ValidatedStoppingCriterion.h>

+ Inheritance diagram for shark::ValidatedStoppingCriterion:

Public Types

typedef ValidatedSingleObjectiveResultSet< PointType > ValidationResultSet
 
typedef AbstractStoppingCriterion< ValidationResultSetStoppingCriterionType
 
typedef SingleObjectiveFunction ObjectiveFunctionType
 
- Public Types inherited from shark::AbstractStoppingCriterion< SingleObjectiveResultSet< RealVector > >
typedef SingleObjectiveResultSet< RealVector > ResultSet
 

Public Member Functions

 ValidatedStoppingCriterion (ObjectiveFunctionType *validation, StoppingCriterionType *child)
 
bool stop (ResultSet const &set)
 returns true if training should stop More...
 
void reset ()
 resets the internal state. call before a new trial More...
 

Protected Attributes

ObjectiveFunctionTypempe_validation
 
StoppingCriterionTypempe_child
 

Detailed Description

Given the current Result set of the optimizer, calculates the validation error using a validation function and hands the results over to the underlying stopping criterion.

Currently only implemented for functions over RealVector

Definition at line 47 of file ValidatedStoppingCriterion.h.

Member Typedef Documentation

◆ ObjectiveFunctionType

◆ StoppingCriterionType

◆ ValidationResultSet

Constructor & Destructor Documentation

◆ ValidatedStoppingCriterion()

shark::ValidatedStoppingCriterion::ValidatedStoppingCriterion ( ObjectiveFunctionType validation,
StoppingCriterionType child 
)
inline

Definition at line 58 of file ValidatedStoppingCriterion.h.

References reset().

Member Function Documentation

◆ reset()

void shark::ValidatedStoppingCriterion::reset ( )
inlinevirtual

◆ stop()

bool shark::ValidatedStoppingCriterion::stop ( ResultSet const &  set)
inlinevirtual

Member Data Documentation

◆ mpe_child

StoppingCriterionType* shark::ValidatedStoppingCriterion::mpe_child
protected

Definition at line 72 of file ValidatedStoppingCriterion.h.

Referenced by reset(), and stop().

◆ mpe_validation

ObjectiveFunctionType* shark::ValidatedStoppingCriterion::mpe_validation
protected

Definition at line 71 of file ValidatedStoppingCriterion.h.

Referenced by stop().


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