kotlin-stdlib/kotlin.ranges/downTo

downTo

infix fun Int.downTo(to: Byte): IntProgression(source)
infix fun Long.downTo(to: Byte): LongProgression(source)
infix fun Byte.downTo(to: Byte): IntProgression(source)
infix fun Short.downTo(to: Byte): IntProgression(source)
infix fun Char.downTo(to: Char): CharProgression(source)
infix fun Int.downTo(to: Int): IntProgression(source)
infix fun Long.downTo(to: Int): LongProgression(source)
infix fun Byte.downTo(to: Int): IntProgression(source)
infix fun Short.downTo(to: Int): IntProgression(source)
infix fun Int.downTo(to: Long): LongProgression(source)
infix fun Long.downTo(to: Long): LongProgression(source)
infix fun Byte.downTo(to: Long): LongProgression(source)
infix fun Short.downTo(to: Long): LongProgression(source)
infix fun Int.downTo(to: Short): IntProgression(source)
infix fun Long.downTo(to: Short): LongProgression(source)
infix fun Byte.downTo(to: Short): IntProgression(source)
infix fun Short.downTo(to: Short): IntProgression(source)

Returns a progression from this value down to and including the specified to value with the step -1.

The to value should be less than or equal to this value. If the to value is greater than this value the returned progression is empty.

Since Kotlin

1.0

Samples

import java.sql.Date
import kotlin.test.assertFalse
import kotlin.test.assertTrue

fun main() { 
   //sampleStart 
   val descendingProgression = 5 downTo 1
println(descendingProgression.toList()) // [5, 4, 3, 2, 1]
val singleElementProgression = 5 downTo 5
println(singleElementProgression.toList()) // [5]
val emptyProgression = 5 downTo 7
println(emptyProgression.toList()) // []

for (i in 3 downTo 0) {
    if (i > 0) println("$i...") else println("Launch!")
} 
   //sampleEnd
}
infix fun UByte.downTo(to: UByte): UIntProgression(source)
infix fun UInt.downTo(to: UInt): UIntProgression(source)
infix fun ULong.downTo(to: ULong): ULongProgression(source)
infix fun UShort.downTo(to: UShort): UIntProgression(source)

Returns a progression from this value down to and including the specified to value with the step -1.

The to value should be less than or equal to this value. If the to value is greater than this value the returned progression is empty.

Since Kotlin

1.5

Samples

import java.sql.Date
import kotlin.test.assertFalse
import kotlin.test.assertTrue

fun main() { 
   //sampleStart 
   val descendingProgression = 5 downTo 1
println(descendingProgression.toList()) // [5, 4, 3, 2, 1]
val singleElementProgression = 5 downTo 5
println(singleElementProgression.toList()) // [5]
val emptyProgression = 5 downTo 7
println(emptyProgression.toList()) // []

for (i in 3 downTo 0) {
    if (i > 0) println("$i...") else println("Launch!")
} 
   //sampleEnd
}