org.encog.util.math.rbf
Class GaussianFunction

java.lang.Object
  org.encog.util.math.rbf.GaussianFunction

All Implemented Interfaces:

java.io.Serializable, RadialBasisFunction

public class GaussianFunction
extends java.lang.Object
implements RadialBasisFunction, java.io.Serializable

Implements a radial function based on the gaussian function.

Author:

jheaton

See Also:

Serialized Form

Constructor Summary

GaussianFunction(double center, double peak, double width)
Construct a Gaussian RBF with the specified center, peak and width.

Method Summary

double	calculate(double x) Calculate the value of the Gaussian function for the specified value.
double	calculateDerivative(double x) Calculate the value of the derivative of the Gaussian function for the specified value.
double	getCenter()
double	getPeak()
double	getWidth()
void	setWidth(double radius) Set the width.

Methods inherited from class java.lang.Object

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

Constructor Detail

GaussianFunction

public GaussianFunction(double center,
                        double peak,
                        double width)

Construct a Gaussian RBF with the specified center, peak and width.

Parameters:

center - The center.

peak - The peak.

width - The width.

Method Detail

calculate

public double calculate(double x)

Calculate the value of the Gaussian function for the specified value.

Specified by:

calculate in interface RadialBasisFunction

Parameters:

x - The value to calculate the Gaussian function for.

Returns:

The return value for the Gaussian function.

calculateDerivative

public double calculateDerivative(double x)

Calculate the value of the derivative of the Gaussian function for the specified value.

Specified by:

calculateDerivative in interface RadialBasisFunction

Parameters:

x - The value to calculate the derivative Gaussian function for.

Returns:

The return value for the derivative of the Gaussian function.

getCenter

public double getCenter()

Specified by:

getCenter in interface RadialBasisFunction

Returns:

The center of the RBF.

getPeak

public double getPeak()

Specified by:

getPeak in interface RadialBasisFunction

Returns:

The peak of the RBF.

getWidth

public double getWidth()

Specified by:

getWidth in interface RadialBasisFunction

Returns:

The width of the RBF.

setWidth

public void setWidth(double radius)

Description copied from interface: RadialBasisFunction

Set the width.

Specified by:

setWidth in interface RadialBasisFunction

Parameters:

radius - The width.