Package xal.tools.math.fnc

Interface IRealFunction

All Known Subinterfaces:
ISmoothRealFunction
All Known Implementing Classes:
InverseRealPolynomial, MeanFieldPolynomial, RealUnivariatePolynomial
public interface IRealFunction
Interface describing the characteristics of a real-valued function of a real variable. It can be evaluated at a given point within its domain of definition, which here is an interval. If a class chooses not to implement the getDomain() method the default implementation returns the value Interval.REAL_LINE.
Since:
Sep 24, 2015
Author:
Christopher K. Allen

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    evaluateAt(double dblLoc)
    Evaluate the function at the given location within its domain.
    default Interval
    getDomain()
    Returns the domain of the function.

  • Method Details

    • getDomain

      default Interval getDomain()
      Returns the domain of the function. The default implementation is to return the entire real line ℝ. That is, the function is assumed to be defined on the whole real line.
      Returns:
      the interval of definition for the function
      Since:
      Sep 24, 2015 by Christopher K. Allen

    • evaluateAt

      double evaluateAt(double dblLoc) throws IllegalArgumentException
      Evaluate the function at the given location within its domain.
      Parameters:
      dblLoc - a valid point within the function domain
      Returns:
      the value of the function at the given location
      Throws:
      IllegalArgumentException - may be thrown if location is outside function domain
      Since:
      Sep 24, 2015 by Christopher K. Allen