Class Gaussian
java.lang.Object
org.apache.commons.math3.analysis.function.Gaussian
- All Implemented Interfaces:
DifferentiableUnivariateFunction,UnivariateDifferentiableFunction,UnivariateFunction
public class Gaussian
extends Object
implements UnivariateDifferentiableFunction, DifferentiableUnivariateFunction
Gaussian function.
- Since:
- 3.0
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classParametric function where the input array contains the parameters of the Gaussian, ordered as follows: Norm Mean Standard deviation -
Constructor Summary
ConstructorsConstructorDescriptionGaussian()Normalized gaussian with zero mean and unit standard deviation.Gaussian(double mean, double sigma) Normalized gaussian with given mean and standard deviation.Gaussian(double norm, double mean, double sigma) Gaussian with given normalization factor, mean and standard deviation. -
Method Summary
Modifier and TypeMethodDescriptionDeprecated.doublevalue(double x) Compute the value of the function.Simple mathematical function.
-
Constructor Details
-
Gaussian
Gaussian with given normalization factor, mean and standard deviation.- Parameters:
norm- Normalization factor.mean- Mean.sigma- Standard deviation.- Throws:
NotStrictlyPositiveException- ifsigma <= 0.
-
Gaussian
Normalized gaussian with given mean and standard deviation.- Parameters:
mean- Mean.sigma- Standard deviation.- Throws:
NotStrictlyPositiveException- ifsigma <= 0.
-
Gaussian
public Gaussian()Normalized gaussian with zero mean and unit standard deviation.
-
-
Method Details
-
value
public double value(double x) Compute the value of the function.- Specified by:
valuein interfaceUnivariateFunction- Parameters:
x- Point at which the function value should be computed.- Returns:
- the value of the function.
-
derivative
Deprecated.as of 3.1, replaced byvalue(DerivativeStructure)Returns the derivative of the function- Specified by:
derivativein interfaceDifferentiableUnivariateFunction- Returns:
- the derivative function
-
value
Simple mathematical function.UnivariateDifferentiableFunctionclasses compute both the value and the first derivative of the function.- Specified by:
valuein interfaceUnivariateDifferentiableFunction- Parameters:
t- function input value- Returns:
- function result
- Throws:
DimensionMismatchException- if t is inconsistent with the function's free parameters or order- Since:
- 3.1
-
value(DerivativeStructure)