boone.map

Class Function.Clip

java.lang.Object

boone.map.Function

boone.map.Function.Clip

All Implemented Interfaces:

Storable, java.lang.Cloneable

Enclosing class:

Function

public static class Function.Clip
extends Function

Clip: return value if value in the given range, else the low/high range border value. Defaults: lowBorder = 0.0, highBorder = 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

Constructor Summary

Constructors

Constructor and Description
Clip()
Clip(double _lowBorder, double _highBorder)

Method Summary

Modifier and Type	Method and Description
void	fromXML(org.jdom2.Element element) Reads attributes from XML tree.
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) Adds a function element 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

Clip

public Clip()

Clip

public Clip(double _lowBorder,
            double _highBorder)

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)

Description copied from interface: Storable

Reads attributes from XML tree.

Specified by:

fromXML in interface Storable

Overrides:

fromXML in class Function

Parameters:

element - a JDOM element

toXML

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

Description copied from class: Function

Adds a function element to XML.

Specified by:

toXML in interface Storable

Overrides:

toXML in class Function

Parameters:

element - the parent element

Returns:

the function element