Package com.amalgamasimulation.core.piecewise

Interface PiecewiseFunction.BreakPoint

Enclosing class:
PiecewiseFunction
public static interface PiecewiseFunction.BreakPoint
Represents a break point in the piecewise function, characterized by its argument, and one or both of the following:
  • value step change,
  • rate change.
Any piecewise function has at least two break points - one at the argument of -∞, and the other at +∞.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    argument()
    Returns the argument at which this break point occurs.
    default boolean
    isDecreasing()
    Checks whether the function is decreasing at this break point, i.e: it has a negative step change, or the rate is negative at and immediately after this break point.
    default boolean
    isIncreasing()
    Checks whether the function is increasing at this break point, i.e: it has a positive step change, or the rate is positive at and immediately after this break point.
    double
    rate()
    Returns the rate of change of the function at this break point, after the possible rate change.
    double
    rateDelta()
    Returns the change in rate at this break point, possibly zero, always finite.
    double
    value()
    Returns the value of the function at this break point, after the possible step change.
    default double
    valueBeforeStepChange()
    Returns the value of the function before a step change at this break point, if any.
    double
    valueDelta()
    Returns the change in value at this break point, possibly zero, always finite.

  • Method Details

    • argument

      double argument()
      Returns the argument at which this break point occurs.
      Returns:
      the argument of this break point, might be infinite

    • value

      double value()
      Returns the value of the function at this break point, after the possible step change.
      Returns:
      the value at this break point

    • rate

      double rate()
      Returns the rate of change of the function at this break point, after the possible rate change.
      Returns:
      the rate at this break point

    • valueDelta

      double valueDelta()
      Returns the change in value at this break point, possibly zero, always finite.
      Returns:
      the value delta at this break point

    • rateDelta

      double rateDelta()
      Returns the change in rate at this break point, possibly zero, always finite.
      Returns:
      the value delta at this break point

    • valueBeforeStepChange

      default double valueBeforeStepChange()
      Returns the value of the function before a step change at this break point, if any.
      Returns:
      the value before a possible step change

    • isIncreasing

      default boolean isIncreasing()
      Checks whether the function is increasing at this break point, i.e:
      • it has a positive step change, or
      • the rate is positive at and immediately after this break point.
      Returns:
      true if the the function is increasing at this break point, false otherwise.

    • isDecreasing

      default boolean isDecreasing()
      Checks whether the function is decreasing at this break point, i.e:
      • it has a negative step change, or
      • the rate is negative at and immediately after this break point.
      Returns:
      true if the the function is decreasing at this break point, false otherwise.