Class Sigmoid.Parametric
java.lang.Object
org.apache.commons.math3.analysis.function.Sigmoid.Parametric
- All Implemented Interfaces:
ParametricUnivariateFunction
- Enclosing class:
Sigmoid
Parametric function where the input array contains the parameters of
the
sigmoid function
, ordered
as follows:
- Lower asymptote
- Higher asymptote
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondouble[]
gradient
(double x, double... param) Computes the value of the gradient atx
.private void
validateParameters
(double[] param) Validates parameters to ensure they are appropriate for the evaluation of thevalue(double,double[])
andgradient(double,double[])
methods.double
value
(double x, double... param) Computes the value of the sigmoid atx
.
-
Constructor Details
-
Parametric
public Parametric()
-
-
Method Details
-
value
public double value(double x, double... param) throws NullArgumentException, DimensionMismatchException Computes the value of the sigmoid atx
.- Specified by:
value
in 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
- ifparam
isnull
.DimensionMismatchException
- if the size ofparam
is 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:
gradient
in 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
- ifparam
isnull
.DimensionMismatchException
- if the size ofparam
is not 2.
-
validateParameters
private void validateParameters(double[] param) throws NullArgumentException, DimensionMismatchException Validates parameters to ensure they are appropriate for the evaluation of thevalue(double,double[])
andgradient(double,double[])
methods.- Parameters:
param
- Values for lower and higher asymptotes.- Throws:
NullArgumentException
- ifparam
isnull
.DimensionMismatchException
- if the size ofparam
is not 2.
-