Package org.apache.commons.math4.legacy.analysis.function

Class Gaussian

java.lang.Object

org.apache.commons.math4.legacy.analysis.function.Gaussian

All Implemented Interfaces:

DoubleUnaryOperator, UnivariateDifferentiableFunction, UnivariateFunction

public class Gaussian
extends Object
implements UnivariateDifferentiableFunction

Gaussian function.

Since:

3.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Gaussian.Parametric	Parametric function where the input array contains the parameters of the Gaussian.

Constructor Summary

Constructors

Constructor	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	Description
double	value(double x)	Compute the value of the function.
DerivativeStructure	value(DerivativeStructure t)	Simple mathematical function.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.function.DoubleUnaryOperator

andThen, compose

Methods inherited from interface org.apache.commons.math4.legacy.analysis.UnivariateFunction

applyAsDouble

Constructor Detail

Gaussian

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

Gaussian with given normalization factor, mean and standard deviation.

Parameters:

norm - Normalization factor.

mean - Mean.

sigma - Standard deviation.

Throws:

NotStrictlyPositiveException - if sigma <= 0.

Gaussian

public Gaussian(double mean,
                double sigma)
         throws NotStrictlyPositiveException

Normalized gaussian with given mean and standard deviation.

Parameters:

mean - Mean.

sigma - Standard deviation.

Throws:

NotStrictlyPositiveException - 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 DerivativeStructure value(DerivativeStructure t)
                          throws DimensionMismatchException

Simple mathematical function.

UnivariateDifferentiableFunction classes compute both the value and the first derivative of the function.

Specified by:

value in interface UnivariateDifferentiableFunction

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