RateFunctionIfc (JSLAll 1.0-SNAPSHOT API)

All Known Subinterfaces:

CumulativeRateFunctionIfc, InvertibleCumulativeRateFunctionIfc

All Known Implementing Classes:

PiecewiseConstantRateFunction, PiecewiseLinearRateFunction, PiecewiseRateFunction
```
public interface RateFunctionIfc
```
Models a rate function for the non-stationary Poisson Process

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`contains(double time)`	Returns true if the supplied time is within the time range of the rate function
`double`	`getMaximum()`	Gets the maximum value of the rate function over its time horizon
`double`	`getMinimum()`	Gets the minimum value of the rate function over its time horizon
`double`	`getRate(double time)`	Returns the rate the the supplied time
`double`	`getTimeRangeLowerLimit()`	The function's lower limit on the time range
`double`	`getTimeRangeUpperLimit()`	The function's upper limit on the time range

- Method Detail
  - getRate
```
double getRate(double time)
```
    Returns the rate the the supplied time
    
    Parameters:
    
    time - the time to evaluate
    
    Returns:
    
    Returns the rate the the supplied time
  - getMaximum
```
double getMaximum()
```
    Gets the maximum value of the rate function over its time horizon
    
    Returns:
    
    Gets the maximum value of the rate function over its time horizon
  - getMinimum
```
double getMinimum()
```
    Gets the minimum value of the rate function over its time horizon
    
    Returns:
    
    Gets the minimum value of the rate function over its time horizon
  - getTimeRangeLowerLimit
```
double getTimeRangeLowerLimit()
```
    The function's lower limit on the time range
    
    Returns:
    
    The function's lower limit on the time range
  - getTimeRangeUpperLimit
```
double getTimeRangeUpperLimit()
```
    The function's upper limit on the time range
    
    Returns:
    
    The function's upper limit on the time range
  - contains
```
boolean contains(double time)
```
    Returns true if the supplied time is within the time range of the rate function
    
    Parameters:
    
    time - the time to evaluate
    
    Returns:
    
    true if the supplied time is within the time range