Interface RealValuedDomainOps

All Known Implementing Classes:
BezierPolynomial, BSpline, BSplineArray, ChiSquareDistr, CubicBezierSpline1, CubicSpline, CubicSpline1, CubicSpline2, FDistr, GaussianDistr, KDistr, LeastSquaresFit, LeastSquaresFit.BSpline, LeastSquaresFit.FunctionBasis, LeastSquaresFit.Linear, LeastSquaresFit.NonLinear, LeastSquaresFit.Polynomial, NurbsArray, Polynomial, ProbDistribution, RealValuedFunction, StudentsTDistr, VectorValuedFunction

public interface RealValuedDomainOps
Operations for the domain of a function with a single real-valued argument. This interface is provided primarily because the documentation is common to multiple classes.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    Determine if the domain maximum is in the domain.
    boolean
    Determine if the domain minimum is in the domain.
    double
    Get the maximum value in the domain of the function.
    double
    Get the minimum value in the domain of the function.
    boolean
    isInDomain(double x)
    Determine if an argument is within the domain of a function.
  • Method Details

    • getDomainMin

      double getDomainMin() throws IllegalStateException
      Get the minimum value in the domain of the function.
      Returns:
      the minimum value
      Throws:
      IllegalStateException - the function was not fully initialized.
    • getDomainMax

      double getDomainMax() throws IllegalStateException
      Get the maximum value in the domain of the function.
      Returns:
      the maximum value
      Throws:
      IllegalStateException - the function was not fully initialized.
    • domainMinClosed

      boolean domainMinClosed() throws IllegalStateException
      Determine if the domain minimum is in the domain.
      Returns:
      true if the domain minimum is in the domain; false if it is the greatest lower bound for the domain
      Throws:
      IllegalStateException - the function was not fully initialized.
    • domainMaxClosed

      boolean domainMaxClosed() throws IllegalStateException
      Determine if the domain maximum is in the domain.
      Returns:
      true if the domain maximum is in the domain; false if it is the least upper bound for the domain
      Throws:
      IllegalStateException - the function was not fully initialized.
    • isInDomain

      boolean isInDomain(double x) throws UnsupportedOperationException, IllegalStateException
      Determine if an argument is within the domain of a function.
      Parameters:
      x - a value to test
      Returns:
      true if x is in this function's domain; false otherwise
      Throws:
      UnsupportedOperationException - domain membership could not be determined.
      IllegalStateException - the function was not fully initialized.