org.cognity.neural.train

Class MinErrorChangeCondition

java.lang.Object

org.cognity.neural.train.MinErrorChangeCondition

All Implemented Interfaces:

StopCondition

public final class MinErrorChangeCondition
extends Object
implements StopCondition

The stop condition for a gradient descent algorithm.
This stop condition is satisfied when error change in two consequential iterations is less than the minimal error change value.

Author:

Artur Markiewicz

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_MIN_ERROR_CHANGE

Constructor Summary

Constructors

Constructor and Description
MinErrorChangeCondition(GradientDescent algorithm) Creates a new stop condition using default minimal error change value.
MinErrorChangeCondition(GradientDescent algorithm, double minErrorChange) Creates a new stop condition.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isNotSatisfied() Returns true is this condition is not satisfied.
boolean	isSatisfied() Returns true is this condition is satisfied.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_MIN_ERROR_CHANGE

public static final double DEFAULT_MIN_ERROR_CHANGE

See Also:

Constant Field Values

Constructor Detail

MinErrorChangeCondition

public MinErrorChangeCondition(GradientDescent algorithm,
                       double minErrorChange)

Creates a new stop condition.

Parameters:

algorithm - The algorithm which should be monitored.

minErrorChange - The minimal error change in two consequential iterations

MinErrorChangeCondition

public MinErrorChangeCondition(GradientDescent algorithm)

Creates a new stop condition using default minimal error change value.

Parameters:

algorithm - The algorithm which should be monitored.

Method Detail

isSatisfied

public boolean isSatisfied()

Description copied from interface: StopCondition

Returns true is this condition is satisfied.

Specified by:

isSatisfied in interface StopCondition

Returns:

• true - if this condition is satisfied
• false - otherwise

isNotSatisfied

public boolean isNotSatisfied()

Description copied from interface: StopCondition

Returns true is this condition is not satisfied.

Specified by:

isNotSatisfied in interface StopCondition

Returns:

• true - if this condition is not satisfied
• false - otherwise

toString

public String toString()

Overrides:

toString in class Object