Class Gaussian.Parametric
- java.lang.Object
-
- org.apache.commons.math4.legacy.analysis.function.Gaussian.Parametric
-
- All Implemented Interfaces:
ParametricUnivariateFunction
- Enclosing class:
- Gaussian
public static class Gaussian.Parametric extends Object implements ParametricUnivariateFunction
Parametric function where the input array contains the parameters of the Gaussian. Ordered as follows:- Norm
- Mean
- Standard deviation
-
-
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 Gaussian atx.
-
-
-
Constructor Detail
-
Parametric
public Parametric()
-
-
Method Detail
-
value
public double value(double x, double... param) throws NullArgumentException, DimensionMismatchException, NotStrictlyPositiveException
Computes the value of the Gaussian atx.- Specified by:
valuein interfaceParametricUnivariateFunction- Parameters:
x- Value for which the function must be computed.param- Values of norm, mean and standard deviation.- Returns:
- the value of the function.
- Throws:
NullArgumentException- ifparamisnull.DimensionMismatchException- if the size ofparamis not 3.NotStrictlyPositiveException- ifparam[2]is negative.
-
gradient
public double[] gradient(double x, double... param) throws NullArgumentException, DimensionMismatchException, NotStrictlyPositiveException
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 (norm, mean and standard deviation).- Specified by:
gradientin interfaceParametricUnivariateFunction- Parameters:
x- Value at which the gradient must be computed.param- Values of norm, mean and standard deviation.- Returns:
- the gradient vector at
x. - Throws:
NullArgumentException- ifparamisnull.DimensionMismatchException- if the size ofparamis not 3.NotStrictlyPositiveException- ifparam[2]is negative.
-
-