Interval

class Interval(xLower: Double = Double.NEGATIVE_INFINITY, xUpper: Double = Double.POSITIVE_INFINITY)

Can be used to represent confidence intervals. Intervals between two real numbers where the lower limit must be less than or equal to the upper limit. The interval is inclusive of both end points.

Author

rossetti

Parameters

xLower

the lower limit, must be less than or equal to xUpper

xUpper

the upper limit

Constructors

Interval

constructor(xLower: Int, xUpper: Int)

constructor(xLower: Double = Double.NEGATIVE_INFINITY, xUpper: Double = Double.POSITIVE_INFINITY)

Properties

halfWidth

val halfWidth: Double

Half of the width of the interval

lowerLimit

var lowerLimit: Double

midPoint

val midPoint: Double

The mid-point between the upper and lower limits

upperLimit

var upperLimit: Double

width

val width: Double

The width of the interval

Functions

asRange

fun asRange(): ClosedFloatingPointRange<Double>

contains

operator fun contains(x: Double): Boolean

operator fun contains(interval: Interval): Boolean

Checks if the supplied interval is contained within this interval

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

instance

fun instance(): Interval

A new instance with the same interval settings.

roundToIntEndPoints

fun roundToIntEndPoints(): Interval

Returns a new interval where the end points have been rounded down (lower limit) and rounded up (upper limit) to integer valued doubles.

stepPoints

fun stepPoints(numSteps: Int): DoubleArray

Creates an array that holds points from the interval all with the same distance between the points with the first point starting at the lower limit and stepping up towards the upper limit based on the number of steps.

toString

open override fun toString(): String