Class Sigmoid.Parametric
- java.lang.Object
-
- org.apache.commons.math4.legacy.analysis.function.Sigmoid.Parametric
-
- All Implemented Interfaces:
ParametricUnivariateFunction
- Enclosing class:
- Sigmoid
public static class Sigmoid.Parametric extends Object implements ParametricUnivariateFunction
Parametric function where the input array contains the parameters of thesigmoid function. Ordered as follows:- Lower asymptote
- Higher asymptote
-
-
Constructor Summary
Constructors Constructor Description Parametric()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description double[]gradient(double x, double... param)Computes the value of the gradient atx.doublevalue(double x, double... param)Computes the value of the sigmoid atx.
-
-
-
Constructor Detail
-
Parametric
public Parametric()
-
-
Method Detail
-
value
public double value(double x, double... param) throws NullArgumentException, DimensionMismatchException
Computes the value of the sigmoid atx.- Specified by:
valuein interfaceParametricUnivariateFunction- Parameters:
x- Value for which the function must be computed.param- Values of lower asymptote and higher asymptote.- Returns:
- the value of the function.
- Throws:
NullArgumentException- ifparamisnull.DimensionMismatchException- if the size ofparamis not 2.
-
gradient
public double[] gradient(double x, double... param) throws NullArgumentException, DimensionMismatchException
Computes the value of the gradient atx. The components of the gradient vector are the partial derivatives of the function with respect to each of the parameters (lower asymptote and higher asymptote).- Specified by:
gradientin interfaceParametricUnivariateFunction- Parameters:
x- Value at which the gradient must be computed.param- Values for lower asymptote and higher asymptote.- Returns:
- the gradient vector at
x. - Throws:
NullArgumentException- ifparamisnull.DimensionMismatchException- if the size ofparamis not 2.
-
-