org.cognity.neural.train

Class MaxErrorCondition

java.lang.Object

org.cognity.neural.train.MaxErrorCondition

All Implemented Interfaces:

StopCondition

public final class MaxErrorCondition
extends Object
implements StopCondition

The stop condition for a gradient descent algorithm.
This stop condition is satisfied when the current error in the gradient descent algorithm is equal or less than the maximum acceptable error.

Author:

Artur Markiewicz

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_MAX_ERROR

Constructor Summary

Constructors

Constructor and Description
MaxErrorCondition(GradientDescent algorithm) Creates a new stop condition using default value for the maximum acceptable error.
MaxErrorCondition(GradientDescent algorithm, double maxError) 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_MAX_ERROR

public static final double DEFAULT_MAX_ERROR

See Also:

Constant Field Values

Constructor Detail

MaxErrorCondition

public MaxErrorCondition(GradientDescent algorithm,
                 double maxError)

Creates a new stop condition.

Parameters:

algorithm - The algorithm which should be monitored.

maxError - The maximum acceptable error.

MaxErrorCondition

public MaxErrorCondition(GradientDescent algorithm)

Creates a new stop condition using default value for the maximum acceptable error.

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