Package jsl.modeling.elements.variable.nhpp

Interface RateSegmentIfc

    • Method Detail

      • newInstance

        RateSegmentIfc newInstance()
        Returns a new instance of the rate segment
        Returns:
        a new instance of the rate segment

      • contains

        boolean contains​(double time)
        Returns true if the supplied time is within this rate segments time interval
        Parameters:
        time - the time to be evaluated
        Returns:
        true if in the segment

      • getRate

        double getRate​(double time)
        Returns the rate for the interval
        Parameters:
        time - the time to evaluate
        Returns:
        the rate at the time

      • getRateAtLowerTimeLimit

        double getRateAtLowerTimeLimit()
        The rate at the time that the time interval begins
        Returns:
        The rate at the time that the time interval begins

      • getRateAtUpperTimeLimit

        double getRateAtUpperTimeLimit()
        The rate at the time that the time interval ends
        Returns:
        The rate at the time that the time interval ends

      • getLowerTimeLimit

        double getLowerTimeLimit()
        The lower time limit
        Returns:
        The lower time limit

      • getUpperTimeLimit

        double getUpperTimeLimit()
        The upper time limit
        Returns:
        The upper time limit

      • getTimeWidth

        double getTimeWidth()
        The width of the interval
        Returns:
        The width of the interval

      • getCumulativeRateLowerLimit

        double getCumulativeRateLowerLimit()
        The lower limit on the cumulative rate axis
        Returns:
        The lower limit on the cumulative rate axis

      • getCumulativeRateUpperLimit

        double getCumulativeRateUpperLimit()
        The upper limit on the cumulative rate axis
        Returns:
        The upper limit on the cumulative rate axis

      • getCumulativeRateIntervalWidth

        double getCumulativeRateIntervalWidth()
        The cumulative rate interval width
        Returns:
        The cumulative rate interval width

      • getCumulativeRate

        double getCumulativeRate​(double time)
        Returns the value of the cumulative rate function for the interval given a value of time within that interval
        Parameters:
        time - the time to be evaluated
        Returns:
        the cumulative rate at the given time

      • getInverseCumulativeRate

        double getInverseCumulativeRate​(double cumRate)
        Returns the inverse of the cumulative rate function given the interval and a cumulative rate value within that interval. Returns a time
        Parameters:
        cumRate - the cumulative rate
        Returns:
        the inverse of the cumulative rate function