Class StepFunction
java.lang.Object
org.apache.commons.math3.analysis.function.StepFunction
- All Implemented Interfaces:
UnivariateFunction
- Since:
- 3.0
-
Constructor Summary
ConstructorsConstructorDescriptionStepFunction(double[] x, double[] y) Builds a step function from a list of arguments and the corresponding values. -
Method Summary
-
Constructor Details
-
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
The value ofh(x) = y[0] for all x < x[1] y[1] for x[1] ≤ x < x[2] ... y[y.length - 1] for x ≥ x[x.length - 1]x[0]is ignored, but it must be strictly less thanx[1].- Parameters:
x- Domain values where the function changes value.y- Values of the function.- Throws:
NonMonotonicSequenceException- if thexarray is not sorted in strictly increasing order.NullArgumentException- ifxoryarenull.NoDataException- ifxoryare zero-length.DimensionMismatchException- ifxandydo not have the same length.
-
-
Method Details
-
value
public double value(double x) Compute the value of the function.- Specified by:
valuein interfaceUnivariateFunction- Parameters:
x- Point at which the function value should be computed.- Returns:
- the value of the function.
-