Enum Class ArtificialNeuralNetwork.Activator

java.lang.Object

java.lang.Enum<ArtificialNeuralNetwork.Activator>

org.ojalgo.ann.ArtificialNeuralNetwork.Activator

All Implemented Interfaces:

Serializable, Comparable<ArtificialNeuralNetwork.Activator>, Constable

Enclosing class:

ArtificialNeuralNetwork

public static enum ArtificialNeuralNetwork.Activator
extends Enum<ArtificialNeuralNetwork.Activator>

https://en.wikipedia.org/wiki/Activation_function

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
IDENTITY	(-,+)
RELU	ReLU: [0,+)
SIGMOID	[0,1]
SOFTMAX	[0,1] Currently this can only be used in the final layer in combination with ArtificialNeuralNetwork.Error.CROSS_ENTROPY.
TANH	[-1,1]

Field Summary

Fields

Modifier and Type	Field	Description
private final PrimitiveFunction.Unary	myDerivativeInTermsOfOutput
private final Consumer<PhysicalStore<Double>>	myFunction
private final boolean	mySingleFolded

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Activator(Consumer<PhysicalStore<Double>> function, PrimitiveFunction.Unary derivativeInTermsOfOutput, boolean singleFolded)

Method Summary

Modifier and Type	Method	Description
(package private) void	activate(PhysicalStore<Double> output)
(package private) void	activate(PhysicalStore<Double> output, double probabilityToKeep)
(package private) PrimitiveFunction.Unary	getDerivativeInTermsOfOutput()
(package private) boolean	isSingleFolded()
static ArtificialNeuralNetwork.Activator	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ArtificialNeuralNetwork.Activator[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IDENTITY

public static final ArtificialNeuralNetwork.Activator IDENTITY

(-,+)

RELU

public static final ArtificialNeuralNetwork.Activator RELU

ReLU: [0,+)

SIGMOID

public static final ArtificialNeuralNetwork.Activator SIGMOID

[0,1]

SOFTMAX

public static final ArtificialNeuralNetwork.Activator SOFTMAX

[0,1]
Currently this can only be used in the final layer in combination with ArtificialNeuralNetwork.Error.CROSS_ENTROPY. All other usage will give incorrect network training.

TANH

public static final ArtificialNeuralNetwork.Activator TANH

[-1,1]

Field Details

myDerivativeInTermsOfOutput

private final PrimitiveFunction.Unary myDerivativeInTermsOfOutput

myFunction

private final Consumer<PhysicalStore<Double>> myFunction

mySingleFolded

private final boolean mySingleFolded

Constructor Details

Activator

private Activator(Consumer<PhysicalStore<Double>> function,
 PrimitiveFunction.Unary derivativeInTermsOfOutput,
 boolean singleFolded)

Method Details

values

public static ArtificialNeuralNetwork.Activator[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static ArtificialNeuralNetwork.Activator valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

activate

void activate(PhysicalStore<Double> output)

activate

void activate(PhysicalStore<Double> output,
 double probabilityToKeep)

getDerivativeInTermsOfOutput

PrimitiveFunction.Unary getDerivativeInTermsOfOutput()

isSingleFolded

boolean isSingleFolded()