org.tensorics.incubate.function

Class SortedMapBackedDiscreteFunction<X extends java.lang.Comparable<X>,Y>

java.lang.Object

org.tensorics.incubate.function.SortedMapBackedDiscreteFunction<X,Y>

Type Parameters:

X - function arguments type

Y - function values type

All Implemented Interfaces:

java.io.Serializable, DiscreteFunction<X,Y>, KeyValueFunction<X,Y>

public class SortedMapBackedDiscreteFunction<X extends java.lang.Comparable<X>,Y>
extends java.lang.Object
implements DiscreteFunction<X,Y>, java.io.Serializable

This implementation of KeyValueFunction only provides values at discrete points of X argument. If value is requested for unavailable value an IllegalDiscreteFunctionUsageException is thrown.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SortedMapBackedDiscreteFunction.Builder<X extends java.lang.Comparable<X>,Y> The builder for the function based on a sorted map.

Method Summary

Modifier and Type	Method and Description
static <X extends java.lang.Comparable<X>,Y> SortedMapBackedDiscreteFunction.Builder<X,Y>	builder()
java.lang.String	getName()
java.util.List<X>	getXs()
Y	getY(X xValue)
java.util.List<Y>	getYs()
java.util.List<Y>	getYsErr()

Methods inherited from class java.lang.Object

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

Method Detail

getY

public Y getY(X xValue)

Specified by:

getY in interface KeyValueFunction<X extends java.lang.Comparable<X>,Y>

Parameters:

xValue - argument of type <X>

Returns:

value of type <Y>

getXs

public java.util.List<X> getXs()

Specified by:

getXs in interface DiscreteFunction<X extends java.lang.Comparable<X>,Y>

getYs

public java.util.List<Y> getYs()

Specified by:

getYs in interface DiscreteFunction<X extends java.lang.Comparable<X>,Y>

getYsErr

public java.util.List<Y> getYsErr()

Specified by:

getYsErr in interface DiscreteFunction<X extends java.lang.Comparable<X>,Y>

getName

public java.lang.String getName()

Specified by:

getName in interface DiscreteFunction<X extends java.lang.Comparable<X>,Y>

builder

public static final <X extends java.lang.Comparable<X>,Y> SortedMapBackedDiscreteFunction.Builder<X,Y> builder()