Class ExponentialDecayFunction
- java.lang.Object
-
- org.apache.commons.math3.ml.neuralnet.sofm.util.ExponentialDecayFunction
-
public class ExponentialDecayFunction extends Object
Exponential decay function:a e-x / b
, wherex
is the (integer) independent variable.
Class is immutable.- Since:
- 3.3
-
-
Constructor Summary
Constructors Constructor Description ExponentialDecayFunction(double initValue, double valueAtNumCall, long numCall)
Creates an instance.
-
-
-
Constructor Detail
-
ExponentialDecayFunction
public ExponentialDecayFunction(double initValue, double valueAtNumCall, long numCall)
Creates an instance. It will be such thata = initValue
b = -numCall / ln(valueAtNumCall / initValue)
- Parameters:
initValue
- Initial value, i.e.value(0)
.valueAtNumCall
- Value of the function atnumCall
.numCall
- Argument for which the function returnsvalueAtNumCall
.- Throws:
NotStrictlyPositiveException
- ifinitValue <= 0
.NotStrictlyPositiveException
- ifvalueAtNumCall <= 0
.NumberIsTooLargeException
- ifvalueAtNumCall >= initValue
.NotStrictlyPositiveException
- ifnumCall <= 0
.
-
-