org.apache.commons.math3.analysis.function

## Class StepFunction

• All Implemented Interfaces:
UnivariateFunction

public class StepFunction
extends Object
implements UnivariateFunction
Since:
3.0
• ### Constructor Summary

Constructors
Constructor and Description
StepFunction(double[] x, double[] y)
Builds a step function from a list of arguments and the corresponding values.
• ### Method Summary

Methods
Modifier and Type Method and Description
double value(double x)
Compute the value of the function.
• ### Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
• ### Constructor Detail

• #### StepFunction

public StepFunction(double[] x,
double[] y)
throws NullArgumentException,
NoDataException,
DimensionMismatchException,
NonMonotonicSequenceException
Builds a step function from a list of arguments and the corresponding values. Specifically, returns the function h(x) defined by

h(x) = y for all x < x
y for x ≤ x < x
...
y[y.length - 1] for x ≥ x[x.length - 1]

The value of x is ignored, but it must be strictly less than x.
Parameters:
x - Domain values where the function changes value.
y - Values of the function.
Throws:
NonMonotonicSequenceException - if the x array is not sorted in strictly increasing order.
NullArgumentException - if x or y are null.
NoDataException - if x or y are zero-length.
DimensionMismatchException - if x and y do not have the same length.
• ### Method Detail

• #### value

public double value(double x)
Compute the value of the function.
Specified by:
value in interface UnivariateFunction
Parameters:
x - Point at which the function value should be computed.
Returns:
the value of the function.