ClosedRange

kotlin-stdlib / kotlin.ranges / ClosedRange
Platform and version requirements: JVM (1.0), JS (1.1), Native (1.3) 
interface ClosedRange<T : Comparable<T>>

Represents a range of values (for example, numbers or characters). See the Kotlin language documentation for more information.

Properties

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

endInclusive

The maximum value in the range (inclusive).

abstract val endInclusive: T
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

start

The minimum value in the range.

abstract val start: T

Functions

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

contains

Checks whether the specified value belongs to the range.

open operator fun contains(value: T): Boolean
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

isEmpty

Checks whether the range is empty.

open fun isEmpty(): Boolean

Extension Functions

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

contains

Checks if the specified value belongs to this range.

operator fun ClosedRange<Int>.contains(value: Byte): Boolean
operator fun ClosedRange<Long>.contains(value: Byte): Boolean
operator fun ClosedRange<Short>.contains(
    value: Byte
): Boolean
operator fun ClosedRange<Double>.contains(
    value: Byte
): Boolean
operator fun ClosedRange<Float>.contains(
    value: Byte
): Boolean
operator fun ClosedRange<Int>.contains(
    value: Double
): Boolean
operator fun ClosedRange<Long>.contains(
    value: Double
): Boolean
operator fun ClosedRange<Byte>.contains(
    value: Double
): Boolean
operator fun ClosedRange<Short>.contains(
    value: Double
): Boolean
operator fun ClosedRange<Float>.contains(
    value: Double
): Boolean
operator fun ClosedRange<Int>.contains(value: Float): Boolean
operator fun ClosedRange<Long>.contains(
    value: Float
): Boolean
operator fun ClosedRange<Byte>.contains(
    value: Float
): Boolean
operator fun ClosedRange<Short>.contains(
    value: Float
): Boolean
operator fun ClosedRange<Double>.contains(
    value: Float
): Boolean
operator fun ClosedRange<Long>.contains(value: Int): Boolean
operator fun ClosedRange<Byte>.contains(value: Int): Boolean
operator fun ClosedRange<Short>.contains(value: Int): Boolean
operator fun ClosedRange<Double>.contains(
    value: Int
): Boolean
operator fun ClosedRange<Float>.contains(value: Int): Boolean
operator fun ClosedRange<Int>.contains(value: Long): Boolean
operator fun ClosedRange<Byte>.contains(value: Long): Boolean
operator fun ClosedRange<Short>.contains(
    value: Long
): Boolean
operator fun ClosedRange<Double>.contains(
    value: Long
): Boolean
operator fun ClosedRange<Float>.contains(
    value: Long
): Boolean
operator fun ClosedRange<Int>.contains(value: Short): Boolean
operator fun ClosedRange<Long>.contains(
    value: Short
): Boolean
operator fun ClosedRange<Byte>.contains(
    value: Short
): Boolean
operator fun ClosedRange<Double>.contains(
    value: Short
): Boolean
operator fun ClosedRange<Float>.contains(
    value: Short
): Boolean

Inheritors

Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

CharRange

A range of values of type Char.

class CharRange : CharProgression, ClosedRange<Char>
Platform and version requirements: JVM (1.1), JS (1.1), Native (1.1)

ClosedFloatingPointRange

Represents a range of floating point numbers. Extends ClosedRange interface providing custom operation lessThanOrEquals for comparing values of range domain type.

interface ClosedFloatingPointRange<T : Comparable<T>> : 
    ClosedRange<T>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

IntRange

A range of values of type Int.

class IntRange : IntProgression, ClosedRange<Int>
Platform and version requirements: JVM (1.0), JS (1.0), Native (1.0)

LongRange

A range of values of type Long.

class LongRange : LongProgression, ClosedRange<Long>
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

UIntRange

A range of values of type UInt.

class UIntRange : UIntProgression, ClosedRange<UInt>
Platform and version requirements: JVM (1.3), JS (1.3), Native (1.3)

ULongRange

A range of values of type ULong.

class ULongRange : ULongProgression, ClosedRange<ULong>

© 2010–2020 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.ranges/-closed-range/index.html