Range

class Range<T : Comparable<*>>(range: Range<T>)

Represents a mathematical range. See wikipedia article of interval.

Parameters

range

adapted guava range class

Constructors

Range

fun <T : Comparable<*>> Range(range: Range<T>)

Types

Companion

object Companion

Functions

contains

operator fun contains(value: T): Boolean

Returns true, if the value is within this Range bounds.

containsResult

fun containsResult(value: T): Either<IllegalArgumentException, Boolean>

Returns Either.Right, if the value is contained within this Range.

encloses

infix fun encloses(other: Range<T>): Boolean

Returns true, if the bounds of the other range do not extend the bounds of this range.

equals

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

hashCode

open override fun hashCode(): Int

hasLowerBound

fun hasLowerBound(): Boolean

Returns true, if this range has a lower endpoint.

hasUpperBound

fun hasUpperBound(): Boolean

Returns true, if this range has an upper endpoint.

intersection

fun intersection(connectedRange: Range<T>): Range<T>

Returns the intersecting range of this range with the other connectedRange.

isConnected

fun isConnected(other: Range<T>): Boolean

Returns true, if there exists a (possibly empty) range which is enclosed by both this range and other.

isEmpty

fun isEmpty(): Boolean

Returns true, if this range has the form v..v) or (v..v.

isNotEmpty

fun isNotEmpty(): Boolean

join

fun join(connectedRange: Range<T>): Range<T>

Joins this and a connectedRange by building the span.

lowerBoundType

fun lowerBoundType(): BoundType

Returns the lower BoundType of this range.

lowerEndpointOrNull

fun lowerEndpointOrNull(): T?

Returns the lower endpoint, if this range has one; otherwise null is returned.

lowerEndpointResult

fun lowerEndpointResult(): Either<IllegalStateException, T>

Returns the lower endpoint as result.

span

fun span(other: Range<T>): Range<T>

Returns the minimal range that encloses this and the other range. For example, the span of [1, 3) and 5, 7 is 1, 7.

toRangeG

fun toRangeG(): Range<T>

Conversion to Guava range.

toString

open override fun toString(): String

Conversion to String.

upperBoundType

fun upperBoundType(): BoundType

Returns the upper BoundType of this range.

upperEndpointOrNull

fun upperEndpointOrNull(): T?

Returns the upper endpoint, if this range has one; otherwise null is returned.

upperEndpointResult

fun upperEndpointResult(): Either<IllegalStateException, T>

Returns the upper endpoint as result.

Extensions

arrange

fun Range<Double>.arrange(step: Double, includeClosedEndPoint: Boolean = false, tolerance: Double): DoubleArray

Arranges an array of Double with step size.

difference

val Range<Double>.difference: Double

Difference between the upper and lower bound of the Range.

fuzzyContains

fun Range<Double>.fuzzyContains(value: Double, tolerance: Double): Boolean

Returns true, if the value is fuzzily contained within this Range by the tolerance.

fuzzyEncloses

fun Range<Double>.fuzzyEncloses(other: Range<Double>, tolerance: Double): Boolean

Returns true, if the other is fuzzily enclosed with a tolerance.

length

val Range<Double>.length: Double

Absolute length between upper and lower bound.

shift

fun Range<Double>.shift(value: Double): Range<Double>

Shifts the Range by a value.

shiftLowerEndpointTo

fun Range<Double>.shiftLowerEndpointTo(value: Double): Range<Double>

Shift the Range so that the lower endpoint is represented by the value.

toRangeSet

fun <T : Comparable<*>> Range<T>.toRangeSet(): RangeSet<T>

Conversion to RangeSet.

widened

fun Range<Double>.widened(lowerWideningValue: Double, upperWideningValue: Double): Range<Double>

Widens the lower bound of the Range by lowerWideningValue and the upper bound of the Range by upperWideningValue.

fun Range<Double>.widened(wideningValue: Double): Range<Double>

Widens the Range by wideningValue on the lower and upper bound.