Module org.bzdev.obnaming
Package org.bzdev.obnaming

Interface NamedFunctionOps

All Superinterfaces:
DoubleUnaryOperator, NamedObjectOps, RealValuedFunctOps, RealValuedFunctVAOps
All Known Implementing Classes:
SimFunction
public interface NamedFunctionOps extends NamedObjectOps, RealValuedFunctOps
Interface for named objects that provide a function.

  • Method Details

    • getFunction

      RealValuedFunction getFunction()
      Get the RealValuedFunction associated with this named object.
      Returns:
      the function; null if not defined

    • getDomainMin

      double getDomainMin()
      Get the minimum value in the domain of the function.
      Returns:
      the minimum value

    • domainMinClosed

      boolean domainMinClosed()
      Determine if the minimum value for the domain is in the domain
      Returns:
      true if the domain's minimum value is in the domain; false otherwise

    • getDomainMax

      double getDomainMax()
      Get the maximum value in the domain of the function.
      Returns:
      the maximum value

    • domainMaxClosed

      boolean domainMaxClosed()
      Determine if the maximum value for the domain is in the domain
      Returns:
      true if the maximum value for the domain is in the domain; false otherwise

    • valueAt

      double valueAt(double arg) throws IllegalArgumentException, UnsupportedOperationException
      Call the function.
      Specified by:
      valueAt in interface RealValuedFunctOps
      Parameters:
      arg - the function's argument
      Returns:
      the value of the function for the given argument
      Throws:
      IllegalArgumentException - the function's argument was out of range
      UnsupportedOperationException - the operation is not supported.

    • derivAt

      double derivAt(double arg) throws IllegalArgumentException, UnsupportedOperationException
      Evaluate the function's first derivative.
      Parameters:
      arg - the function's argument
      Returns:
      the value of the function for the given argument
      Throws:
      IllegalArgumentException - the function's argument was out of range
      UnsupportedOperationException - the operation is not supported.

    • secondDerivAt

      double secondDerivAt(double arg) throws IllegalArgumentException, UnsupportedOperationException
      Evaluate the function's second derivative.
      Parameters:
      arg - the function's argument
      Returns:
      the value of the function for the given argument
      Throws:
      IllegalArgumentException - the function's argument was out of range
      UnsupportedOperationException - the operation is not supported.