boone.map

Class Function.Composition

java.lang.Object

boone.map.Function

boone.map.Function.Composition

All Implemented Interfaces:

Storable, java.lang.Cloneable

Enclosing class:

Function

public static class Function.Composition
extends Function

composition function, returns g(f(x)).

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	f
Function	g

Constructor Summary

Constructors

Constructor and Description
Composition()
Composition(Function f, Function g)

Method Summary

Modifier and Type	Method and Description
Function.Composition	clone() Return a deep copy of this object.
void	fromXML(org.jdom2.Element element) Reads attributes from XML tree.
double	getMaxValue() Returns the maximum value of the g function.
double	getMinValue() Returns the minimum value of the g function.
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

f

public Function f

g

public Function g

Constructor Detail

Composition

public Composition()

Composition

public Composition(Function f,
                   Function g)

Method Detail

clone

public Function.Composition 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()

Returns the minimum value of the g function. Note that this is an estimation and may not be the actual minimum value that can be produced by g from results of f (but this value is always smaller than the real value).

Specified by:

getMinValue in class Function

Returns:

the minimum function result.

getMaxValue

public double getMaxValue()

Returns the maximum value of the g function. Note that this is an estimation and may not be the actual maximum value that can be produced by g from results of f (but it's always larger).

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