boone.map

Class Function.Scaled

java.lang.Object

boone.map.Function

boone.map.Function.Scaled

All Implemented Interfaces:

Storable, java.lang.Cloneable

Enclosing class:

Function

public static class Function.Scaled
extends Function

function adding scaling factors, applied to the function result value (outside).

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
Function	function

Constructor Summary

Constructors

Constructor and Description
Scaled()
Scaled(double scaleFactor, double addFactor, Function function)

Method Summary

Modifier and Type	Method and Description
Function.Scaled	clone() Return a deep copy of this object.
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.
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.
org.jdom2.Element	toXML(org.jdom2.Element element) Adds a function element to XML.

Methods inherited from class boone.map.Function

create, setParameters

Methods inherited from class java.lang.Object

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

Field Detail

function

public Function function

Constructor Detail

Scaled

public Scaled()

Scaled

public Scaled(double scaleFactor,
              double addFactor,
              Function function)

Method Detail

clone

public Function.Scaled clone()

Description copied from class: Function

Return a deep copy of this object. By default, just calls super.clone().

Overrides:

clone in class Function

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.

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

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