Kotlin區間/範圍

區間(或叫作範圍)表達式由具有操作符形式 ..rangeTo 函數輔以 in{: .keyword } 和 !in{: .keyword } 形成。
區間是爲任何可比較類型定義的,但對於整型原生類型,它有一個優化的實現。以下是使用區間的一些示例

if (i in 1..10) { // 等同於 1 <= i && i <= 10
    println(i)
}

整型區間(IntRangeLongRangeCharRange)有一個額外的特性:它們可以迭代。
編譯器負責將其轉換爲類似 Java 的基於索引的 for{: .keyword }-循環而無額外開銷。

for (i in 1..4) print(i) // 輸出「1234」

for (i in 4..1) print(i) // 什麼都不輸出

如果你想倒序迭代數字呢?也很簡單。你可以使用標準庫中定義的 downTo() 函數

for (i in 4 downTo 1) print(i) // 輸出「4321」

能否以不等於 1 的任意步長迭代數字? 當然沒問題, step() 函數有助於此

for (i in 1..4 step 2) print(i) // 輸出「13」

for (i in 4 downTo 1 step 2) print(i) // 輸出「42」

要創建一個不包括其結束元素的區間,可以使用 until 函數:

for (i in 1 until 10) {   // i in [1, 10) 排除了 10
     println(i)
}

它是如何工作的

區間實現了該庫中的一個公共接口:ClosedRange<T>

ClosedRange<T> 在數學意義上表示一個閉區間,它是爲可比較類型定義的。
它有兩個端點:startendInclusive 他們都包含在區間內。
其主要操作是 contains,通常以 in{: .keyword }/!in{: .keyword } 操作符形式使用。

整型數列(IntProgressionLongProgressionCharProgression)表示等差數列。
數列由 first 元素、last 元素和非零的 step 定義。
第一個元素是 first,後續元素是前一個元素加上 steplast 元素總會被迭代命中,除非該數列是空的。

數列是 Iterable<N> 的子類型,其中 N 分別爲 IntLong 或者 Char,所以它可用於 for{: .keyword }-循環以及像 mapfilter 等函數中。
Progression 迭代相當於 Java/JavaScript 的基於索引的 for{: .keyword }-循環:

for (int i = first; i != last; i += step) {
  // ……
}

對於整型類型,.. 操作符創建一個同時實現 ClosedRange<T>*Progression 的對象。
例如,IntRange 實現了 ClosedRange<Int> 並擴展自 IntProgression,因此爲 IntProgression 定義的所有操作也可用於 IntRange
downTo()step() 函數的結果總是一個 *Progression

數列由在其伴生對象中定義的 fromClosedRange 函數構造:

IntProgression.fromClosedRange(start, end, step)

數列的 last 元素這樣計算:對於正的 step 找到不大於 end 值的最大值、或者對於負的 step 找到不小於 end 值的最小值,使得 (last - first) % increment == 0

一些實用函數

rangeTo()

整型類型的 rangeTo() 操作符只是調用 *Range 類的構造函數,例如:

class Int {
    //……
    operator fun rangeTo(other: Long): LongRange = LongRange(this, other)
    //……
    operator fun rangeTo(other: Int): IntRange = IntRange(this, other)
    //……
}

浮點數(DoubleFloat)未定義它們的 rangeTo 操作符,而使用標準庫提供的泛型 Comparable 類型的操作符:

    public operator fun <T: Comparable<T>> T.rangeTo(that: T): ClosedRange<T>

該函數返回的區間不能用於迭代。

downTo()

擴展函數 downTo() 是爲任何整型類型對定義的,這裏有兩個例子:

fun Long.downTo(other: Int): LongProgression {
    return LongProgression.fromClosedRange(this, other.toLong(), -1L)
}

fun Byte.downTo(other: Int): IntProgression {
    return IntProgression.fromClosedRange(this.toInt(), other, -1)
}

reversed()

擴展函數 reversed() 是爲每個 *Progression 類定義的,並且所有這些函數返回反轉後的數列。

fun IntProgression.reversed(): IntProgression {
    return IntProgression.fromClosedRange(last, first, -step)
}

step()

擴展函數 step() 是爲每個 *Progression 類定義的,
所有這些函數都返回帶有修改了 step 值(函數參數)的數列。
步長(step)值必須始終爲正,因此該函數不會更改迭代的方向。

fun IntProgression.step(step: Int): IntProgression {
    if (step <= 0) throw IllegalArgumentException("Step must be positive, was: $step")
    return IntProgression.fromClosedRange(first, last, if (this.step > 0) step else -step)
}

fun CharProgression.step(step: Int): CharProgression {
    if (step <= 0) throw IllegalArgumentException("Step must be positive, was: $step")
    return CharProgression.fromClosedRange(first, last, if (this.step > 0) step else -step)
}

請注意,返回數列的 last 值可能與原始數列的 last 值不同,以便保持不變式 (last - first) % step == 0 成立。這裏是一個例子:

(1..12 step 2).last == 11  // 值爲 [1, 3, 5, 7, 9, 11] 的數列
(1..12 step 3).last == 10  // 值爲 [1, 4, 7, 10] 的數列
(1..12 step 4).last == 9   // 值爲 [1, 5, 9] 的數列