org.nd4j.linalg.api.activation

Class BaseActivationFunction

java.lang.Object

org.nd4j.linalg.api.activation.BaseActivationFunction

All Implemented Interfaces:

Function<INDArray,INDArray>, java.io.Serializable, ActivationFunction

Direct Known Subclasses:

Exp, HardTanh, Linear, MaxOut, RectifiedLinear, RoundedLinear, Sigmoid, SoftMax, Tanh

public abstract class BaseActivationFunction
extends java.lang.Object
implements ActivationFunction

Base activation function: mainly to give the function a canonical representation

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BaseActivationFunction()

Method Summary

Modifier and Type	Method and Description
INDArray	apply(INDArray input) Returns the result of applying this function to input.
boolean	equals(java.lang.Object o) Indicates whether another object is equal to this function.
java.lang.String	toString() The type()
java.lang.String	type() Name of the function

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.nd4j.linalg.api.activation.ActivationFunction

applyDerivative, transformClazz

Constructor Detail

BaseActivationFunction

public BaseActivationFunction()

Method Detail

type

public java.lang.String type()

Name of the function

Specified by:

type in interface ActivationFunction

Returns:

the name of the function

equals

public boolean equals(java.lang.Object o)

Description copied from interface: Function

Indicates whether another object is equal to this function.

Most implementations will have no reason to override the behavior of Object.equals(java.lang.Object). However, an implementation may also choose to return true whenever object is a Function that it considers interchangeable with this one. "Interchangeable" typically means that Objects.equal(this.apply(f), that.apply(f)) is true for all f of type F. Note that a false result from this method does not imply that the functions are known not to be interchangeable.

Specified by:

equals in interface Function<INDArray,INDArray>

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

The type()

Overrides:

toString in class java.lang.Object

Returns:

apply

public INDArray apply(INDArray input)

Returns the result of applying this function to input. This method is generally expected, but not absolutely required, to have the following properties:

• Its execution does not cause any observable side effects.
• The computation is consistent with equals; that is, Objects.equal(a, b) implies that Objects.equal(function.apply(a), function.apply(b)).

Specified by:

apply in interface Function<INDArray,INDArray>

Parameters:

input -

Throws:

java.lang.NullPointerException - if input is null and this function does not accept null arguments