Package dev.nm.analysis.function.special.gaussian

Class Gaussian

java.lang.Object

dev.nm.analysis.function.rn2r1.AbstractRealScalarFunction

dev.nm.analysis.function.rn2r1.univariate.AbstractUnivariateRealFunction

dev.nm.analysis.function.special.gaussian.Gaussian

All Implemented Interfaces:

Function<Vector,Double>, RealScalarFunction, UnivariateRealFunction

public class Gaussian
extends AbstractUnivariateRealFunction

The Gaussian function is defined as: \[ f(x) = a e^{- { \frac{(x-b)^2 }{ 2 c^2} } } \]

See Also:

• Wikipedia: Gaussian function

Nested Class Summary

Nested classes/interfaces inherited from interface dev.nm.analysis.function.Function

Function.EvaluationException

Constructor Summary

Constructors

Constructor	Description
Gaussian()	Construct an instance of the standard Gaussian function: \(f(x) = e^{-{\frac{(x)^2}{2}}}\)
Gaussian(double a, double b, double c)	Construct an instance of the Gaussian function.

Method Summary

Modifier and Type	Method	Description
double	a()	Get a.
double	b()	Get b.
double	c()	Get c.
double	evaluate(double x)	Evaluate y = f(x).

Methods inherited from class dev.nm.analysis.function.rn2r1.univariate.AbstractUnivariateRealFunction

evaluate

Methods inherited from class dev.nm.analysis.function.rn2r1.AbstractRealScalarFunction

dimensionOfDomain, dimensionOfRange

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.nm.analysis.function.Function

dimensionOfDomain, dimensionOfRange

Constructor Details

Gaussian

public Gaussian(double a,
 double b,
 double c)

Construct an instance of the Gaussian function.

Parameters:

a - a

b - b

c - c

Gaussian

public Gaussian()

Construct an instance of the standard Gaussian function: \(f(x) = e^{-{\frac{(x)^2}{2}}}\)

Method Details

a

public double a()

Get a.

Returns:

a

b

public double b()

Get b.

Returns:

b

c

public double c()

Get c.

Returns:

c

evaluate

public double evaluate(double x)

Description copied from interface: UnivariateRealFunction

Evaluate y = f(x).

Parameters:

x - x

Returns:

f(x)