org.simbrain.network.neuron_update_rules

Enum PointNeuronRule.OutputFunction

java.lang.Object

java.lang.Enum<PointNeuronRule.OutputFunction>

org.simbrain.network.neuron_update_rules.PointNeuronRule.OutputFunction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PointNeuronRule.OutputFunction>

Enclosing class:

PointNeuronRule

public static enum PointNeuronRule.OutputFunction
extends java.lang.Enum<PointNeuronRule.OutputFunction>

Output functions. (p. 45-48)

Enum Constant Summary

Enum Constants

Enum Constant and Description
DISCRETE_SPIKING The spikes themselves are the output.
LINEAR The number of spikes over a given time is translated into a continuous rate value without being passed through any other function.
NOISY_RATE_CODE TODO: No implementation.
NONE The membrane potential is the output.
RATE_CODE The number of spikes over a given time is translated into a continuous rate value which is then put through a squashing function to represent saturation or a max and min firing rate.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	toString()
static PointNeuronRule.OutputFunction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PointNeuronRule.OutputFunction[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DISCRETE_SPIKING

public static final PointNeuronRule.OutputFunction DISCRETE_SPIKING

The spikes themselves are the output.

LINEAR

public static final PointNeuronRule.OutputFunction LINEAR

The number of spikes over a given time is translated into a continuous rate value without being passed through any other function.

RATE_CODE

public static final PointNeuronRule.OutputFunction RATE_CODE

The number of spikes over a given time is translated into a continuous rate value which is then put through a squashing function to represent saturation or a max and min firing rate.

NOISY_RATE_CODE

public static final PointNeuronRule.OutputFunction NOISY_RATE_CODE

TODO: No implementation.

NONE

public static final PointNeuronRule.OutputFunction NONE

The membrane potential is the output.

Method Detail

values

public static PointNeuronRule.OutputFunction[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PointNeuronRule.OutputFunction c : PointNeuronRule.OutputFunction.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PointNeuronRule.OutputFunction valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toString

public abstract java.lang.String toString()

Overrides:

toString in class java.lang.Enum<PointNeuronRule.OutputFunction>

Returns:

the name of the output function.