Package xal.tools.math.fnc

Interface ISmoothRealFunction

All Superinterfaces:
IRealFunction
All Known Implementing Classes:
InverseRealPolynomial, MeanFieldPolynomial, RealUnivariatePolynomial
public interface ISmoothRealFunction extends IRealFunction
Interface exposing the characteristics of a real function of a real variable which has derivatives.
Since:
Sep 24, 2015
Author:
Christopher K. Allen

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    derivativeAt(double dblLoc)
    Return the first-order derivative (n = 1) of the function.
    double
    derivativeAt(int nOrder, double dblLoc)
    Compute and return the nth derivative at the given location x within the function domain.

    Methods inherited from interface xal.tools.math.fnc.IRealFunction

    evaluateAt, getDomain

  • Method Details

    • derivativeAt

      double derivativeAt(double dblLoc)

      Return the first-order derivative (n = 1) of the function. Thus, this method is the equivalent of calling derivativeAt(1, dblLoc).

      A smooth, real-valued function has at least one derivative. Thus, the derivative f'(x) should always exist for any class implementing this interface.

      Parameters:
      dblLoc - the location x at which to evaluate the derivative
      Returns:
      the derivative f'(x) of the function f
      Since:
      Sep 25, 2015 by Christopher K. Allen

    • derivativeAt

      double derivativeAt(int nOrder, double dblLoc) throws IllegalArgumentException

      Compute and return the nth derivative at the given location x within the function domain. The order argument n must be 0 or greater where the 0th derivative is simply the value of the function itself.

      It is possible that the derivatives of a function are all zero for n greater than a certain value. Consider a polynomial for example, when n is greater than the degree of that polynomial.

      Parameters:
      nOrder - the order n of the derivative
      dblLoc - the location x at which to evaluate the derivative
      Returns:
      the derivative f(n)(x) of the function
      Throws:
      IllegalArgumentException - the derivative order must be positive.
      Since:
      Sep 24, 2015 by Christopher K. Allen