org.encog.engine.network.activation
Class ActivationCompetitive

java.lang.Object
  org.encog.engine.network.activation.ActivationCompetitive

All Implemented Interfaces:

Serializable, Cloneable, ActivationFunction

public class ActivationCompetitive
extends Object
implements ActivationFunction

An activation function that only allows a specified number, usually one, of the out-bound connection to win. These connections will share in the sum of the output, whereas the other neurons will receive zero. This activation function can be useful for "winner take all" layers.

See Also:

Serialized Form

Field Summary

static int

PARAM_COMPETITIVE_MAX_WINNERS The offset to the parameter that holds the max winners.

Constructor Summary

ActivationCompetitive()
Create a competitive activation function with one winner allowed.

ActivationCompetitive(int winners)
Create a competitive activation function with the specified maximum number of winners.

Method Summary

void	activationFunction(double[] x, int start, int size) Implements the activation function.
ActivationFunction	clone()
double	derivativeFunction(double b, double a) Calculate the derivative.
String	getFactoryCode()
int	getMaxWinners()
String[]	getParamNames()
double[]	getParams()
boolean	hasDerivative()
void	setParam(int index, double value) Set one of the params for this activation function.

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_COMPETITIVE_MAX_WINNERS

public static final int PARAM_COMPETITIVE_MAX_WINNERS

The offset to the parameter that holds the max winners.

See Also:

Constant Field Values

Constructor Detail

ActivationCompetitive

public ActivationCompetitive()

Create a competitive activation function with one winner allowed.

ActivationCompetitive

public ActivationCompetitive(int winners)

Create a competitive activation function with the specified maximum number of winners.

Parameters:

winners - The maximum number of winners that this function supports.

Method Detail

activationFunction

public final void activationFunction(double[] x,
                                     int start,
                                     int size)

Implements the activation function. The array is modified according to the activation function being used. See the class description for more specific information on this type of activation function.

Specified by:

activationFunction in interface ActivationFunction

Parameters:

x - The input array to the activation function.

start - The starting index.

size - The number of values to calculate.

clone

public final ActivationFunction clone()

Specified by:

clone in interface ActivationFunction

Overrides:

clone in class Object

Returns:

A cloned copy of this object.

derivativeFunction

public final double derivativeFunction(double b,
                                       double a)

Calculate the derivative. For performance reasons two numbers are provided. First, the value "b" is simply the number that we would like to calculate the derivative of. Second, the value "a", which is the value returned by the activation function, when presented with "b". We use two values because some of the most common activation functions make use of the result of the activation function. It is bad for performance to calculate this value twice. Yet, not all derivatives are calculated this way. By providing both the value before the activation function is applied ("b"), and after the activation function is applied("a"), the class can be constructed to use whichever value will be the most efficient.

Specified by:

derivativeFunction in interface ActivationFunction

Parameters:

b - The number to calculate the derivative of, the number "before" the activation function was applied.

a - The number "after" an activation function has been applied.

Returns:

The derivative.

getMaxWinners

public final int getMaxWinners()

Returns:

The maximum number of winners this function supports.

getParamNames

public final String[] getParamNames()

Specified by:

getParamNames in interface ActivationFunction

Returns:

The names of the parameters.

getParams

public final double[] getParams()

Specified by:

getParams in interface ActivationFunction

Returns:

The params for this activation function.

hasDerivative

public final boolean hasDerivative()

Specified by:

hasDerivative in interface ActivationFunction

Returns:

False, indication that no derivative is available for this function.

setParam

public final void setParam(int index,
                           double value)

Set one of the params for this activation function.

Specified by:

setParam in interface ActivationFunction

Parameters:

index - The index of the param to set.

value - The value to set.

getFactoryCode

public String getFactoryCode()

Specified by:

getFactoryCode in interface ActivationFunction

Returns:

The string for the Encog factory code. Return null if you do not care to be support for creating of your activation through factory.