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

Interface NamedFunctionTwoOps

All Superinterfaces:
DoubleBinaryOperator, NamedObjectOps, RealValuedFunctTwoOps, RealValuedFunctVAOps
All Known Implementing Classes:
SimFunctionTwo
public interface NamedFunctionTwoOps extends NamedObjectOps, RealValuedFunctTwoOps
Interface for named objects that provide a function of two arguments.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    deriv11At(double arg1, double arg2)
    Evaluate the partial derivative $\frac{\partial^2 f}{\partial x_1^2}$ for the function f(x1,x2) defined by this object.
    double
    deriv12At(double arg1, double arg2)
    Evaluate the partial derivative $\frac{\partial^2 f}{\partial x_1 \partial x_2}$ for the function f(x1,x2) defined by this object.
    double
    deriv1At(double arg1, double arg2)
    Evaluate the partial derivative $\frac{\partial f}{\partial x_1}$ for the function f(x1,x2) defined by this object.
    double
    deriv21At(double arg1, double arg2)
    Evaluate the partial derivative $\frac{\partial^2 f}{\partial x_2 \partial x_1}$ for the function f(x1,x2) defined by this object.
    double
    deriv22At(double arg1, double arg2)
    Evaluate the partial derivative $\frac{\partial^2 f}{\partial x_2^2}$ for the function f(x1,x2) defined by this object.
    double
    deriv2At(double arg1, double arg2)
    Evaluate the partial derivative $\frac{\partial f}{\partial x_2}$ for the function f(x1,x2) defined by this object.
    boolean
    domainMax1Closed()
    Determine if the domain maximum for the first argument is in the domain.
    boolean
    domainMax2Closed()
    Determine if the domain maximum for the second argument is in the domain.
    boolean
    domainMin1Closed()
    Determine if the domain minimum for the first argument is in the domain.
    boolean
    domainMin2Closed()
    Determine if the domain minumum for the second argument is in the domain.
    double
    getDomainMax1()
    Get the maximum value of the first argument in the domain of the function.
    double
    getDomainMax2()
    Get the maximum value of the second argument in the domain of the function.
    double
    getDomainMin1()
    Get the minimum value of the first argument in the domain of the function.
    double
    getDomainMin2()
    Get the minimum value of the second argument in the domain of the function.
    RealValuedFunctionTwo
    getFunction()
    Get the RealValuedFunctionTwo associated with this named object.
    boolean
    isInDomain(double x, double y)
    Determine if a point (x, y) is within the domain of a real-valued function of two arguments.
    double
    valueAt(double arg1, double arg2)
    Call the function.

    Methods inherited from interface org.bzdev.obnaming.NamedObjectOps

    canDelete, delete, deletePending, getName, isDeleted, isInterned

    Methods inherited from interface org.bzdev.math.RealValuedFunctTwoOps

    applyAsDouble, maxArgLength, minArgLength, valueAt

  • Method Details

    • getFunction

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

    • getDomainMin1

      double getDomainMin1()
      Get the minimum value of the first argument in the domain of the function.
      Returns:
      the minimum value

    • domainMin1Closed

      boolean domainMin1Closed()
      Determine if the domain minimum for the first argument is in the domain.
      Returns:
      true if the domain minimum is in the domain; false otherwise

    • getDomainMax1

      double getDomainMax1()
      Get the maximum value of the first argument in the domain of the function.
      Returns:
      the maximum value

    • domainMax1Closed

      boolean domainMax1Closed()
      Determine if the domain maximum for the first argument is in the domain.
      Returns:
      true if the domain maximum is in the domain; false otherwise

    • getDomainMin2

      double getDomainMin2()
      Get the minimum value of the second argument in the domain of the function.
      Returns:
      the minimum value

    • domainMin2Closed

      boolean domainMin2Closed()
      Determine if the domain minumum for the second argument is in the domain.
      Returns:
      true if the domain minimum is in the domain; false otherwise

    • getDomainMax2

      double getDomainMax2()
      Get the maximum value of the second argument in the domain of the function.
      Returns:
      the maximum value

    • domainMax2Closed

      boolean domainMax2Closed()
      Determine if the domain maximum for the second argument is in the domain.
      Returns:
      true if the domain maximum is in the domain; false otherwise

    • isInDomain

      boolean isInDomain(double x, double y) throws UnsupportedOperationException
      Determine if a point (x, y) is within the domain of a real-valued function of two arguments.
      Parameters:
      x - the 1st argument
      y - the 2nd argument
      Returns:
      true if the point (x, y) is in this function's domain; false otherwise
      Throws:
      UnsupportedOperationException - domain membership could not be determined.

    • valueAt

      double valueAt(double arg1, double arg2) throws IllegalArgumentException, UnsupportedOperationException
      Call the function.
      Specified by:
      valueAt in interface RealValuedFunctTwoOps
      Parameters:
      arg1 - the function's first argument
      arg2 - the function's second 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.

    • deriv1At

      double deriv1At(double arg1, double arg2) throws IllegalArgumentException, UnsupportedOperationException
      Evaluate the partial derivative $\frac{\partial f}{\partial x_1}$ for the function f(x1,x2) defined by this object.
      Parameters:
      arg1 - the function's first argument
      arg2 - the function's second argument
      Returns:
      the value of the partial derivative for the given argument
      Throws:
      IllegalArgumentException - the function's argument(s) were out of range
      UnsupportedOperationException - the operation is not supported.

    • deriv2At

      double deriv2At(double arg1, double arg2) throws IllegalArgumentException, UnsupportedOperationException
      Evaluate the partial derivative $\frac{\partial f}{\partial x_2}$ for the function f(x1,x2) defined by this object.
      Parameters:
      arg1 - the function's first argument
      arg2 - the function's second argument
      Returns:
      the value of the partial derivative for the given argument
      Throws:
      IllegalArgumentException - the function's argument(s) were out of range
      UnsupportedOperationException - the operation is not supported.

    • deriv11At

      double deriv11At(double arg1, double arg2) throws IllegalArgumentException, UnsupportedOperationException
      Evaluate the partial derivative $\frac{\partial^2 f}{\partial x_1^2}$ for the function f(x1,x2) defined by this object.
      Parameters:
      arg1 - the function's first argument
      arg2 - the function's second argument
      Returns:
      the value of the partial derivative for the given argument
      Throws:
      IllegalArgumentException - the function's argument(s) were out of range
      UnsupportedOperationException - the operation is not supported.

    • deriv12At

      double deriv12At(double arg1, double arg2) throws IllegalArgumentException, UnsupportedOperationException
      Evaluate the partial derivative $\frac{\partial^2 f}{\partial x_1 \partial x_2}$ for the function f(x1,x2) defined by this object.
      Parameters:
      arg1 - the function's first argument
      arg2 - the function's second argument
      Returns:
      the value of the partial derivative for the given argument
      Throws:
      IllegalArgumentException - the function's argument(s) were out of range
      UnsupportedOperationException - the operation is not supported.

    • deriv21At

      double deriv21At(double arg1, double arg2) throws IllegalArgumentException, UnsupportedOperationException
      Evaluate the partial derivative $\frac{\partial^2 f}{\partial x_2 \partial x_1}$ for the function f(x1,x2) defined by this object.
      Parameters:
      arg1 - the function's first argument
      arg2 - the function's second argument
      Returns:
      the value of the partial derivative for the given argument
      Throws:
      IllegalArgumentException - the function's argument(s) were out of range
      UnsupportedOperationException - the operation is not supported.

    • deriv22At

      double deriv22At(double arg1, double arg2) throws IllegalArgumentException, UnsupportedOperationException
      Evaluate the partial derivative $\frac{\partial^2 f}{\partial x_2^2}$ for the function f(x1,x2) defined by this object.
      Parameters:
      arg1 - the function's first argument
      arg2 - the function's second argument
      Returns:
      the value of the partial derivative for the given argument
      Throws:
      IllegalArgumentException - the function's argument(s) were out of range
      UnsupportedOperationException - the operation is not supported.