sort

expect fun IntArray.sort()(source)(source)
actual fun IntArray.sort()(source)(source)
expect fun LongArray.sort()(source)(source)
actual fun LongArray.sort()(source)(source)
expect fun ByteArray.sort()(source)(source)
actual fun ByteArray.sort()(source)(source)
expect fun ShortArray.sort()(source)(source)
actual fun ShortArray.sort()(source)(source)
expect fun DoubleArray.sort()(source)(source)
actual fun DoubleArray.sort()(source)(source)
expect fun FloatArray.sort()(source)(source)
actual fun FloatArray.sort()(source)(source)
expect fun CharArray.sort()(source)(source)
actual fun CharArray.sort()(source)(source)

Sorts the array in-place.

Since Kotlin

1.0

Samples

import kotlin.test.*

fun main() { 
   //sampleStart 
   val intArray = intArrayOf(4, 3, 2, 1)

// before sorting
println(intArray.joinToString()) // 4, 3, 2, 1

intArray.sort()

// after sorting
println(intArray.joinToString()) // 1, 2, 3, 4 
   //sampleEnd
}

expect fun <T : Comparable<T>> Array<out T>.sort()(source)(source)
actual inline fun <T : Comparable<T>> Array<out T>.sort()(source)(source)

Sorts the array in-place according to the natural order of its elements.

The sort is stable. It means that equal elements preserve their order relative to each other after sorting.

Since Kotlin

1.0

Samples

import kotlin.test.*

fun main() { 
   //sampleStart 
   class Person(val firstName: String, val lastName: String) : Comparable<Person> {
    override fun compareTo(other: Person): Int = this.lastName.compareTo(other.lastName)
    override fun toString(): String = "$firstName $lastName"
}

val people = arrayOf(
    Person("Ragnar", "Lodbrok"),
    Person("Bjorn", "Ironside"),
    Person("Sweyn", "Forkbeard")
)

// before sorting
println(people.joinToString()) // Ragnar Lodbrok, Bjorn Ironside, Sweyn Forkbeard

people.sort()

// after sorting
println(people.joinToString()) // Sweyn Forkbeard, Bjorn Ironside, Ragnar Lodbrok 
   //sampleEnd
}

expect fun <T : Comparable<T>> MutableList<T>.sort()(source)(source)

Since Kotlin

1.0

actual fun <T : Comparable<T>> MutableList<T>.sort()(source)(source)

Sorts elements in the list in-place according to their natural sort order.

The sort is stable. It means that equal elements preserve their order relative to each other after sorting.

Since Kotlin

1.0

Samples

import kotlin.test.*

fun main() { 
   //sampleStart 
   val mutableList = mutableListOf(4, 3, 2, 1)

// before sorting
println(mutableList.joinToString()) // 4, 3, 2, 1

mutableList.sort()

// after sorting
println(mutableList.joinToString()) // 1, 2, 3, 4 
   //sampleEnd
}

fun <T> Array<out T>.sort()(source)

Sorts the array in-place according to the natural order of its elements.

The sort is stable. It means that equal elements preserve their order relative to each other after sorting.

Since Kotlin

1.0

Throws

if any element of the array is not Comparable.


actual fun ByteArray.sort(fromIndex: Int = 0, toIndex: Int = size)(source)
actual fun ShortArray.sort(fromIndex: Int = 0, toIndex: Int = size)(source)
actual fun IntArray.sort(fromIndex: Int = 0, toIndex: Int = size)(source)
actual fun LongArray.sort(fromIndex: Int = 0, toIndex: Int = size)(source)
actual fun FloatArray.sort(fromIndex: Int = 0, toIndex: Int = size)(source)
actual fun DoubleArray.sort(fromIndex: Int = 0, toIndex: Int = size)(source)
actual fun CharArray.sort(fromIndex: Int = 0, toIndex: Int = size)(source)

Sorts a range in the array in-place.

Since Kotlin

1.0

Parameters

fromIndex

the start of the range (inclusive) to sort, 0 by default.

toIndex

the end of the range (exclusive) to sort, size of this array by default.

Throws

if fromIndex is less than zero or toIndex is greater than the size of this array.

Samples

import kotlin.test.*

fun main() { 
   //sampleStart 
   val intArray = intArrayOf(4, 3, 2, 1)

// before sorting
println(intArray.joinToString()) // 4, 3, 2, 1

intArray.sort(0, 3)

// after sorting
println(intArray.joinToString()) // 2, 3, 4, 1 
   //sampleEnd
}

fun <T> Array<out T>.sort(fromIndex: Int = 0, toIndex: Int = size)(source)

Sorts a range in the array in-place.

The sort is stable. It means that equal elements preserve their order relative to each other after sorting.

Since Kotlin

1.0

Parameters

fromIndex

the start of the range (inclusive) to sort, 0 by default.

toIndex

the end of the range (exclusive) to sort, size of this array by default.

Throws

if fromIndex is less than zero or toIndex is greater than the size of this array.

Samples

import kotlin.test.*

fun main() { 
   //sampleStart 
   class Person(val firstName: String, val lastName: String) : Comparable<Person> {
    override fun compareTo(other: Person): Int = this.lastName.compareTo(other.lastName)
    override fun toString(): String = "$firstName $lastName"
}

val people = arrayOf(
    Person("Ragnar", "Lodbrok"),
    Person("Bjorn", "Ironside"),
    Person("Sweyn", "Forkbeard")
)

// before sorting
println(people.joinToString()) // Ragnar Lodbrok, Bjorn Ironside, Sweyn Forkbeard

people.sort(0, 2)

// after sorting
println(people.joinToString()) // Bjorn Ironside, Ragnar Lodbrok, Sweyn Forkbeard 
   //sampleEnd
}

inline fun <T> MutableList<T>.sort(comparator: Comparator<in T>)(source)

Deprecated (with error)

Use sortWith(comparator) instead.

Replace with

this.sortWith(comparator)

Since Kotlin

1.0

inline fun <T> MutableList<T>.sort(comparison: (T, T) -> Int)(source)

Deprecated (with error)

Use sortWith(Comparator(comparison)) instead.

Replace with

this.sortWith(Comparator(comparison))

Since Kotlin

1.0