Range

Range

Range(
    lower: T, 
    upper: T)

Create a new immutable range.

The endpoints are [lower, upper]; that is the range is bounded. lower must be lesser or equal to upper.

clamp

fun clamp(value: T): T

Clamps value to this range.

If the value is within this range, it is returned. Otherwise, if it is < than the lower endpoint, the lower endpoint is returned, else the upper endpoint is returned. Comparisons are performed using the Comparable interface.

contains

fun contains(value: T): Boolean

Checks if the value is within the bounds of this range.

A value is considered to be within this range if it's >= the lower endpoint and <= the upper endpoint (using the Comparable interface.)

contains

fun contains(range: Range<T>!): Boolean

Checks if another range is within the bounds of this range.

A range is considered to be within this range if both of its endpoints are within this range.

create

static fun <T : Comparable<T>!> create(
    lower: T, 
    upper: T
): Range<T>!

Create a new immutable range, with the argument types inferred.

The endpoints are [lower, upper]; that is the range is bounded. lower must be lesser or equal to upper.

equals

fun equals(other: Any?): Boolean

Compare two ranges for equality.

A range is considered equal if and only if both the lower and upper endpoints are also equal.

extend

fun extend(range: Range<T>!): Range<T>!

Returns the smallest range that includes this range and another range.

E.g. if a < b < c < d, the extension of [a, c] and [b, d] ranges is [a, d]. As the endpoints are object references, there is no guarantee which specific endpoint reference is used from the input ranges:

E.g. if a == a' < b < c, the extension of [a, b] and [a', c] ranges could be either [a, c] or ['a, c], where ['a, c] could be either the exact input range, or a newly created range with the same endpoints.

extend

fun extend(
    lower: T, 
    upper: T
): Range<T>!

Returns the smallest range that includes this range and the inclusive range specified by [lower, upper].

See extend(android.util.Range) for more details.

extend

fun extend(value: T): Range<T>!

Returns the smallest range that includes this range and the value.

See extend(android.util.Range) for more details, as this method is equivalent to extend(Range.create(value, value)).

getLower

fun getLower(): T

Get the lower endpoint.

getUpper

fun getUpper(): T

Get the upper endpoint.

hashCode

fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

intersect

fun intersect(range: Range<T>!): Range<T>!

Returns the intersection of this range and another range.

E.g. if a < b < c < d, the intersection of [a, c] and [b, d] ranges is [b, c]. As the endpoints are object references, there is no guarantee which specific endpoint reference is used from the input ranges:

E.g. if a == a' < b < c, the intersection of [a, b] and [a', c] ranges could be either [a, b] or ['a, b], where [a, b] could be either the exact input range, or a newly created range with the same endpoints.

intersect

fun intersect(
    lower: T, 
    upper: T
): Range<T>!

Returns the intersection of this range and the inclusive range specified by [lower, upper].

See intersect(android.util.Range) for more details.

toString

fun toString(): String

Return the range as a string representation "[lower, upper]".