org.hipparchus.analysis.function

Class Gaussian

java.lang.Object

org.hipparchus.analysis.function.Gaussian

All Implemented Interfaces:

UnivariateDifferentiableFunction, UnivariateFunction

public class Gaussian
extends Object
implements UnivariateDifferentiableFunction

Gaussian function.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Gaussian.Parametric Parametric function where the input array contains the parameters of the Gaussian, ordered as follows: Norm Mean Standard deviation

Constructor Summary

Constructors

Constructor and Description
Gaussian() 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 Type	Method and Description
double	value(double x) Compute the value of the function.
<T extends Derivative<T>> T	value(T t) Compute the value for the function.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Gaussian

public Gaussian(double norm,
                double mean,
                double sigma)
         throws MathIllegalArgumentException

Gaussian with given normalization factor, mean and standard deviation.

Parameters:

norm - Normalization factor.

mean - Mean.

sigma - Standard deviation.

Throws:

MathIllegalArgumentException - if sigma <= 0.

Gaussian

public Gaussian(double mean,
                double sigma)
         throws MathIllegalArgumentException

Normalized gaussian with given mean and standard deviation.

Parameters:

mean - Mean.

sigma - Standard deviation.

Throws:

MathIllegalArgumentException - if sigma <= 0.

Gaussian

public Gaussian()

Normalized gaussian with zero mean and unit standard deviation.

Method Detail

value

public double value(double x)

Compute the value of the function.

Specified by:

value in interface UnivariateFunction

Parameters:

x - Point at which the function value should be computed.

Returns:

the value of the function.

value

public <T extends Derivative<T>> T value(T t)
                                  throws MathIllegalArgumentException

Compute the value for the function.

Specified by:

value in interface UnivariateDifferentiableFunction

Type Parameters:

T - the type of the field elements

Parameters:

t - the point for which the function value should be computed

Returns:

the value

Throws:

MathIllegalArgumentException - if x does not satisfy the function's constraints (argument out of bound, or unsupported derivative order for example)