boone.map

Class Function.NaturalSpline

java.lang.Object

boone.map.Function

boone.map.Function.NaturalSpline

All Implemented Interfaces:

Storable, Function.Spline, java.lang.Cloneable

Enclosing class:

Function

public static class Function.NaturalSpline
extends Function
implements Function.Spline

Natural Cubic Spline Activation Function

Author:

Andreas Ban

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
protected double[]	data The data used for curve calculation

Constructor Summary

Constructors

Constructor and Description
NaturalSpline() Create a new instance.
NaturalSpline(double[] data) Create a new instance, using the given data.

Method Summary

Modifier and Type	Method and Description
Function.NaturalSpline	clone() Return a deep copy of this object.
void	fromXML(org.jdom2.Element element) Reads attributes from XML tree.
double[]	getData() Return the spline coefficient data array.
double	getMaxValue() Return Double.MAX_VALUE; no minimum estimation is implemented.
double	getMinValue() Return -Double.MAX_VALUE; no minimum estimation is implemented.
double	map(double value) Return the function value at the given point.
double	mapDerivative(double value) Return the derivative function value at the given point.
void	setData(double[] data) Set a new spline coefficient data array, and re-calculate the precomputed values.
org.jdom2.Element	toXML(org.jdom2.Element element) Adds a function element to XML.

Methods inherited from class boone.map.Function

create, mapSecondDerivative, setParameters

Methods inherited from class java.lang.Object

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

Field Detail

data

protected double[] data

The data used for curve calculation

data[0] contains the scale factor of uniform distant x values in the interval [-1,1], the other values are the y coordinates of the control points (the number of control points is data.length - 1)

Constructor Detail

NaturalSpline

public NaturalSpline()

Create a new instance. Uses 12 points, with data[0] := 5, and data[1..11] := 1/(1+exp(i)), i from 5 .. -5 .

NaturalSpline

public NaturalSpline(double[] data)

Create a new instance, using the given data.

Method Detail

clone

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

Return the function value at the given point.

Overrides:

map in class Function

mapDerivative

public double mapDerivative(double value)

Return the derivative function value at the given point.

Overrides:

mapDerivative in class Function

getMinValue

public double getMinValue()

Return -Double.MAX_VALUE; no minimum estimation is implemented.

Specified by:

getMinValue in class Function

Returns:

the minimum function result.

getMaxValue

public double getMaxValue()

Return Double.MAX_VALUE; no minimum estimation is implemented.

Specified by:

getMaxValue in class Function

Returns:

the maximum function result.

getData

public double[] getData()

Return the spline coefficient data array.

Specified by:

getData in interface Function.Spline

setData

public void setData(double[] data)

Set a new spline coefficient data array, and re-calculate the precomputed values.

Specified by:

setData in interface Function.Spline

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