org.encog.neural.networks.training.competitive.neighborhood
Class NeighborhoodGaussianMulti

java.lang.Object
  org.encog.neural.networks.training.competitive.neighborhood.NeighborhoodGaussianMulti

All Implemented Interfaces:

NeighborhoodFunction

public class NeighborhoodGaussianMulti
extends java.lang.Object
implements NeighborhoodFunction

Implements a multi-dimensional gaussian neighborhood function. DO not use this for a 1D gaussian, just use the NeighborhoodGaussian for that.

Constructor Summary

NeighborhoodGaussianMulti(int x, int y)
Construct a 2d neighborhood function based on the sizes for the x and y dimensions.

Method Summary

double	function(int currentNeuron, int bestNeuron) Calculate the value for the multi RBF function.
double	getRadius()
RadialBasisFunctionMulti	getRBF()
void	setRadius(double radius) Set the radius.

Methods inherited from class java.lang.Object

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

Constructor Detail

NeighborhoodGaussianMulti

public NeighborhoodGaussianMulti(int x,
                                 int y)

Construct a 2d neighborhood function based on the sizes for the x and y dimensions.

Parameters:

x - The size of the x-dimension.

y - The size of the y-dimension.

Method Detail

function

public double function(int currentNeuron,
                       int bestNeuron)

Calculate the value for the multi RBF function.

Specified by:

function in interface NeighborhoodFunction

Parameters:

currentNeuron - The current neuron.

bestNeuron - The best neuron.

Returns:

A percent that determines the amount of training the current neuron should get. Usually 100% when it is the bestNeuron.

getRadius

public double getRadius()

Specified by:

getRadius in interface NeighborhoodFunction

Returns:

The radius.

getRBF

public RadialBasisFunctionMulti getRBF()

Returns:

The RBF to use.

setRadius

public void setRadius(double radius)

Set the radius.

Specified by:

setRadius in interface NeighborhoodFunction

Parameters:

radius - The radius.