boone.map

Class Function.AtLeast

java.lang.Object

boone.map.Function

boone.map.Function.AtLeast

All Implemented Interfaces:

Storable, java.lang.Cloneable

Enclosing class:

Function

public static class Function.AtLeast
extends Function

At Least: return 1.0 if value >= minValue, 0.0 else. Default: minValue = 1.0

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

Field Summary

Fields

Modifier and Type	Field and Description
double	minValue

Constructor Summary

Constructors

Constructor and Description
AtLeast()
AtLeast(double minValue)

Method Summary

Modifier and Type	Method and Description
void	fromXML(org.jdom2.Element element) Reads attribute from XML.
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) Returns always 1.0.
org.jdom2.Element	toXML(org.jdom2.Element element) Writes attribute to XML.

Methods inherited from class boone.map.Function

clone, create, mapSecondDerivative, setParameters

Methods inherited from class java.lang.Object

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

Field Detail

minValue

public double minValue

Constructor Detail

AtLeast

public AtLeast()

AtLeast

public AtLeast(double minValue)

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)

Returns always 1.0. Obviously, this is incorrect, but it may be used by training algorithms as an "estimation" of the derivative. The correct value of 0 would render all training methods relying on the derivative meaningless.

Overrides:

mapDerivative in class Function

Parameters:

value - a value

Returns:

1.0

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.

fromXML

public void fromXML(org.jdom2.Element element)

Reads attribute from XML.

Specified by:

fromXML in interface Storable

Overrides:

fromXML in class Function

Parameters:

element - the function element

toXML

public org.jdom2.Element toXML(org.jdom2.Element element)

Writes attribute to XML.

Specified by:

toXML in interface Storable

Overrides:

toXML in class Function

Parameters:

element - the function element

Returns:

the function element