Package org.djutils.math.functions

Record Class DerivativeTest.Scenario

java.lang.Object
java.lang.Record
org.djutils.math.functions.DerivativeTest.Scenario
Record Components:
mathFunction - the MathFunction to run the tests on
minimum - lowest x value of to test
maximum - highest x value of to test
steps - number of points along the range [lowest, highest] to perform the test
delta - range around x test point to verify derivative
epsilon - range around f(x) test point to verify derivative
Enclosing class:
DerivativeTest
static record DerivativeTest.Scenario(MathFunction mathFunction, double minimum, double maximum, int steps, double delta, double epsilon) extends Record
Test scenario.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Scenario(MathFunction mathFunction, double minimum, double maximum, int steps, double delta, double epsilon)
    Creates an instance of a Scenario record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    delta()
    Returns the value of the delta record component.
    double
    epsilon()
    Returns the value of the epsilon record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    MathFunction
    mathFunction()
    Returns the value of the mathFunction record component.
    double
    maximum()
    Returns the value of the maximum record component.
    double
    minimum()
    Returns the value of the minimum record component.
    int
    steps()
    Returns the value of the steps record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Scenario

      Scenario(MathFunction mathFunction, double minimum, double maximum, int steps, double delta, double epsilon)
      Creates an instance of a Scenario record class.
      Parameters:
      mathFunction - the value for the mathFunction record component
      minimum - the value for the minimum record component
      maximum - the value for the maximum record component
      steps - the value for the steps record component
      delta - the value for the delta record component
      epsilon - the value for the epsilon record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • mathFunction

      public MathFunction mathFunction()
      Returns the value of the mathFunction record component.
      Returns:
      the value of the mathFunction record component

    • minimum

      public double minimum()
      Returns the value of the minimum record component.
      Returns:
      the value of the minimum record component

    • maximum

      public double maximum()
      Returns the value of the maximum record component.
      Returns:
      the value of the maximum record component

    • steps

      public int steps()
      Returns the value of the steps record component.
      Returns:
      the value of the steps record component

    • delta

      public double delta()
      Returns the value of the delta record component.
      Returns:
      the value of the delta record component

    • epsilon

      public double epsilon()
      Returns the value of the epsilon record component.
      Returns:
      the value of the epsilon record component