boone.map

Class Function.AtMost

java.lang.Object

boone.map.Function

boone.map.Function.AtMost

All Implemented Interfaces:

Storable, java.lang.Cloneable

Enclosing class:

Function

public static class Function.AtMost
extends Function

At Most: return 1.0 if value <= maxValue, 0.0 else. Default: maxValue = 0.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

Constructor Summary

Constructors

Constructor and Description
AtMost()
AtMost(double maxValue)

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.
org.jdom2.Element	toXML(org.jdom2.Element element) Writes attributes to XML.

Methods inherited from class boone.map.Function

clone, create, mapDerivative, mapSecondDerivative, setParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

AtMost

public AtMost()

AtMost

public AtMost(double maxValue)

Method Detail

map

public double map(double value)

Description copied from class: Function

Map a value through the function.

Overrides:

map 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.

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 attributes to XML.

Specified by:

toXML in interface Storable

Overrides:

toXML in class Function

Parameters:

element - the function element

Returns:

the function element