com.numericalmethod.suanshu.analysis.function.special.gaussian

Class Gaussian

java.lang.Object

com.numericalmethod.suanshu.analysis.function.rn2r1.univariate.UnivariateRealFunction

com.numericalmethod.suanshu.analysis.function.special.gaussian.Gaussian

All Implemented Interfaces:

Function<Vector,java.lang.Double>, RealScalarFunction, java.io.Serializable

public class Gaussian
extends UnivariateRealFunction

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

See Also:

Wikipedia: Gaussian function, Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.numericalmethod.suanshu.analysis.function.Function

Function.EvaluationException

Constructor Summary

Constructors

Constructor and 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 and 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 com.numericalmethod.suanshu.analysis.function.rn2r1.univariate.UnivariateRealFunction

dimensionOfDomain, dimensionOfRange, evaluate

Methods inherited from class java.lang.Object

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

Constructor Detail

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 Detail

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 class: UnivariateRealFunction

Evaluate y = f(x).

Specified by:

evaluate in class UnivariateRealFunction

Parameters:

x - x

Returns:

f(x)