boone.map

Class Function.TanH

java.lang.Object

boone.map.Function

boone.map.Function.TanH

All Implemented Interfaces:

Storable, java.lang.Cloneable

Enclosing class:

Function

public static class Function.TanH
extends Function

The tanh function f(x) = (e^x - e^-x) / (e^x + e^-x) with caching and fast, numerically safe computation. First and second Derivatives are implemented.

Nested Class Summary

Nested classes/interfaces inherited from class boone.map.Function

Function.AboutEqual, Function.AtLeast, Function.AtMost, Function.CatmullRomSpline, Function.Clip, Function.Composition, Function.Exponential, Function.GreaterThan, Function.Identity, Function.LessThan, Function.NaturalSpline, Function.NotImplemented, Function.ReLU, Function.Scaled, Function.Sigmoid, Function.Signum, Function.SignumWithoutZero, Function.Sinus, Function.SoftMax, Function.Spline, Function.TanH

Constructor Summary

Constructors

Constructor and Description
TanH()

Method Summary

Modifier and Type	Method and Description
double	getMaxValue() Return the largest possible function value.
double	getMinValue() Return the smallest possible function value.
double	map(double value) Map a value through the function.
double	mapDerivative(double value) Map a value through the first derivative of this function.
double	mapSecondDerivative(double value) Map a value through the second derivative of this function.

Methods inherited from class boone.map.Function

clone, create, fromXML, setParameters, toXML

Methods inherited from class java.lang.Object

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

Constructor Detail

TanH

public TanH()

Method Detail

map

public double map(double value)

Description copied from class: Function

Map a value through the function.

Overrides:

map in class Function

mapDerivative

public double mapDerivative(double value)

Description copied from class: Function

Map a value through the first derivative of this function.

Overrides:

mapDerivative in class Function

mapSecondDerivative

public double mapSecondDerivative(double value)

Description copied from class: Function

Map a value through the second derivative of this function.

Overrides:

mapSecondDerivative in class Function

getMinValue

public double getMinValue()

Description copied from class: Function

Return the smallest possible function value. If no exact value can be produced easily, this should return an estimation (lower bound).

Specified by:

getMinValue in class Function

Returns:

the minimum function result.

getMaxValue

public double getMaxValue()

Description copied from class: Function

Return the largest possible function value. If no exact value can be produced easily, this should return an estimation (upper bound).

Specified by:

getMaxValue in class Function

Returns:

the maximum function result.