Top Description Constructors Methods
org.apache.commons.math3.ml.neuralnet.sofm

public Class LearningFactorFunctionFactory

extends Object
Class Inheritance
Imports
org.apache.commons.math3.ml.neuralnet.sofm.util.ExponentialDecayFunction, .QuasiSigmoidDecayFunction, org.apache.commons.math3.exception.OutOfRangeException
Factory for creating instances of LearningFactorFunction.
Since
3.3

Constructor Summary

AccessConstructor and Description
private
LearningFactorFunctionFactory()

Class contains only static methods.

Method Summary

Modifier and TypeMethod and Description
public static LearningFactorFunction

Returns:

the learning factor function.
exponentialDecay(final double
Initial value, i.e. value(0).
initValue, final double
Value of the function at numCall.
valueAtNumCall, final long
Argument for which the function returns valueAtNumCall.
numCall)

Creates an exponential decay function.

public static LearningFactorFunction

Returns:

the learning factor function.
quasiSigmoidDecay(final double
Initial value, i.e. value(0).
initValue, final double
Value of the function derivative at numCall.
slope, final long
Inflexion point.
numCall)

Creates an sigmoid-like LearningFactorFunction function.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

LearningFactorFunctionFactoryback to summary
private LearningFactorFunctionFactory()

Class contains only static methods.

Method Detail

exponentialDecayback to summary
public static LearningFactorFunction exponentialDecay(final double initValue, final double valueAtNumCall, final long numCall)

Creates an exponential decay function. It will compute a e-x / b, where x is the (integer) independent variable and

  • a = initValue
  • b = -numCall / ln(valueAtNumCall / initValue)
Parameters
initValue:double

Initial value, i.e. value(0).

valueAtNumCall:double

Value of the function at numCall.

numCall:long

Argument for which the function returns valueAtNumCall.

Returns:LearningFactorFunction

the learning factor function.

Exceptions
OutOfRangeException:
if initValue <= 0 or initValue > 1.
NotStrictlyPositiveException:
  • if valueAtNumCall <= 0.
  • if numCall <= 0.
NumberIsTooLargeException:
if valueAtNumCall >= initValue.
quasiSigmoidDecayback to summary
public static LearningFactorFunction quasiSigmoidDecay(final double initValue, final double slope, final long numCall)

Creates an sigmoid-like LearningFactorFunction function. The function f will have the following properties:

  • f(0) = initValue
  • numCall is the inflexion point
  • slope = f'(numCall)
Parameters
initValue:double

Initial value, i.e. value(0).

slope:double

Value of the function derivative at numCall.

numCall:long

Inflexion point.

Returns:LearningFactorFunction

the learning factor function.

Exceptions
OutOfRangeException:
if initValue <= 0 or initValue > 1.
NumberIsTooLargeException:
if slope >= 0.
NotStrictlyPositiveException:
if numCall <= 0.