kotlin-stdlib/kotlin/Int

Int

class Int : Number, Comparable<Int> (source)

Represents a 32-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type int.

Since Kotlin

1.0
class Int : Number, Comparable<Int> (source)

Represents a 32-bit signed integer.

Since Kotlin

1.3

Types

Link copied to clipboard
object Companion
Since Kotlin 1.0
object Companion
Since Kotlin 1.3

Properties

Link copied to clipboard
expect val Int.absoluteValue: Int

Returns the absolute value of this value.

Since Kotlin 1.2
actual val Int.absoluteValue: Int

Returns the absolute value of this value.

Since Kotlin 1.2
actual val Int.absoluteValue: Int

Returns the absolute value of this value.

Since Kotlin 1.2
actual val Int.absoluteValue: Int

Returns the absolute value of this value.

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalTime
val Int.days: Duration

Returns a Duration equal to this Int number of days.

Since Kotlin 1.3
val Int.days: Duration

Returns a Duration equal to this Int number of days.

Since Kotlin 1.6
Link copied to clipboard
@ExperimentalTime
val Int.hours: Duration

Returns a Duration equal to this Int number of hours.

Since Kotlin 1.3
val Int.hours: Duration

Returns a Duration equal to this Int number of hours.

Since Kotlin 1.6
Link copied to clipboard
@ExperimentalTime
val Int.microseconds: Duration

Returns a Duration equal to this Int number of microseconds.

Since Kotlin 1.3
val Int.microseconds: Duration

Returns a Duration equal to this Int number of microseconds.

Since Kotlin 1.6
Link copied to clipboard
@ExperimentalTime
val Int.milliseconds: Duration

Returns a Duration equal to this Int number of milliseconds.

Since Kotlin 1.3
val Int.milliseconds: Duration

Returns a Duration equal to this Int number of milliseconds.

Since Kotlin 1.6
Link copied to clipboard
@ExperimentalTime
val Int.minutes: Duration

Returns a Duration equal to this Int number of minutes.

Since Kotlin 1.3
val Int.minutes: Duration

Returns a Duration equal to this Int number of minutes.

Since Kotlin 1.6
Link copied to clipboard
@ExperimentalTime
val Int.nanoseconds: Duration

Returns a Duration equal to this Int number of nanoseconds.

Since Kotlin 1.3
val Int.nanoseconds: Duration

Returns a Duration equal to this Int number of nanoseconds.

Since Kotlin 1.6
Link copied to clipboard
@ExperimentalTime
val Int.seconds: Duration

Returns a Duration equal to this Int number of seconds.

Since Kotlin 1.3
val Int.seconds: Duration

Returns a Duration equal to this Int number of seconds.

Since Kotlin 1.6
Link copied to clipboard
expect val Int.sign: Int

Returns the sign of this value:

Since Kotlin 1.2
actual val Int.sign: Int

Returns the sign of this value:

Since Kotlin 1.2
actual val Int.sign: Int

Returns the sign of this value:

Since Kotlin 1.2
actual val Int.sign: Int

Returns the sign of this value:

Since Kotlin 1.3

Functions

Link copied to clipboard
infix fun and(other: Int): Int

Performs a bitwise AND operation between the two values.

Since Kotlin 1.0
infix external fun and(other: Int): Int

Performs a bitwise AND operation between the two values.

Since Kotlin 1.3
Link copied to clipboard
fun Int.coerceAtLeast(minimumValue: Int): Int

Ensures that this value is not less than the specified minimumValue.

Since Kotlin 1.0
Link copied to clipboard
fun Int.coerceAtMost(maximumValue: Int): Int

Ensures that this value is not greater than the specified maximumValue.

Since Kotlin 1.0
Link copied to clipboard
fun Int.coerceIn(range: ClosedRange<Int>): Int

Ensures that this value lies in the specified range.

Since Kotlin 1.0
fun Int.coerceIn(minimumValue: Int, maximumValue: Int): Int

Ensures that this value lies in the specified range minimumValue..maximumValue.

Since Kotlin 1.0
Link copied to clipboard
operator fun compareTo(other: Byte): Int
operator fun compareTo(other: Double): Int
operator fun compareTo(other: Float): Int
open operator override fun compareTo(other: Int): Int
operator fun compareTo(other: Long): Int
operator fun compareTo(other: Short): Int

Compares this value with the specified value for order. Returns zero if this value is equal to the specified other value, a negative number if it's less than other, or a positive number if it's greater than other.

Since Kotlin 1.0
inline operator fun compareTo(other: Byte): Int
inline operator fun compareTo(other: Double): Int
inline operator fun compareTo(other: Float): Int
open operator external override fun compareTo(other: Int): Int
inline operator fun compareTo(other: Long): Int
inline operator fun compareTo(other: Short): Int

Compares this value with the specified value for order. Returns zero if this value is equal to the specified other value, a negative number if it's less than other, or a positive number if it's greater than other.

Since Kotlin 1.3
Link copied to clipboard
infix inline fun <T> Comparable<T>.compareTo(other: T): Int

Compares this object with the specified object for order. Returns zero if this object is equal to the specified other object, a negative number if it's less than other, or a positive number if it's greater than other.

Since Kotlin 1.6
Link copied to clipboard
inline external fun <R : Any> Int.convert(): R
Since Kotlin 1.3
Link copied to clipboard
expect fun Int.countLeadingZeroBits(): Int

Counts the number of consecutive most significant bits that are zero in the binary representation of this Int number.

Since Kotlin 1.4
actual inline fun Int.countLeadingZeroBits(): Int

Counts the number of consecutive most significant bits that are zero in the binary representation of this Int number.

Since Kotlin 1.4
actual inline fun Int.countLeadingZeroBits(): Int

Counts the number of consecutive most significant bits that are zero in the binary representation of this Int number.

Since Kotlin 1.4
actual fun Int.countLeadingZeroBits(): Int

Counts the number of consecutive most significant bits that are zero in the binary representation of this Int number.

Since Kotlin 1.4
Link copied to clipboard
expect fun Int.countOneBits(): Int

Counts the number of set bits in the binary representation of this Int number.

Since Kotlin 1.4
actual fun Int.countOneBits(): Int

Counts the number of set bits in the binary representation of this Int number.

Since Kotlin 1.4
actual inline fun Int.countOneBits(): Int

Counts the number of set bits in the binary representation of this Int number.

Since Kotlin 1.4
actual external fun Int.countOneBits(): Int

Counts the number of set bits in the binary representation of this Int number.

Since Kotlin 1.4
Link copied to clipboard
expect fun Int.countTrailingZeroBits(): Int

Counts the number of consecutive least significant bits that are zero in the binary representation of this Int number.

Since Kotlin 1.4
actual fun Int.countTrailingZeroBits(): Int

Counts the number of consecutive least significant bits that are zero in the binary representation of this Int number.

Since Kotlin 1.4
actual inline fun Int.countTrailingZeroBits(): Int

Counts the number of consecutive least significant bits that are zero in the binary representation of this Int number.

Since Kotlin 1.4
actual fun Int.countTrailingZeroBits(): Int

Counts the number of consecutive least significant bits that are zero in the binary representation of this Int number.

Since Kotlin 1.4
Link copied to clipboard
operator fun dec(): Int

Returns this value decremented by one.

Since Kotlin 1.0
operator external fun dec(): Int

Returns this value decremented by one.

Since Kotlin 1.3
Link copied to clipboard
fun Int.digitToChar(): Char

Returns the Char that represents this decimal digit. Throws an exception if this value is not in the range 0..9.

Since Kotlin 1.5
fun Int.digitToChar(radix: Int): Char

Returns the Char that represents this numeric digit value in the specified radix. Throws an exception if the radix is not in the range 2..36 or if this value is not in the range 0 until radix.

Since Kotlin 1.5
Link copied to clipboard
operator fun div(other: Byte): Int
operator fun div(other: Int): Int
operator fun div(other: Long): Long
operator fun div(other: Short): Int

Divides this value by the other value, truncating the result to an integer that is closer to zero.

Since Kotlin 1.0
operator fun div(other: Double): Double
operator fun div(other: Float): Float

Divides this value by the other value.

Since Kotlin 1.0
inline operator fun div(other: Byte): Int
operator external fun div(other: Int): Int
inline operator fun div(other: Long): Long
inline operator fun div(other: Short): Int

Divides this value by the other value, truncating the result to an integer that is closer to zero.

Since Kotlin 1.3
inline operator fun div(other: Double): Double
inline operator fun div(other: Float): Float

Divides this value by the other value.

Since Kotlin 1.3
Link copied to clipboard
infix fun Int.downTo(to: Byte): IntProgression
infix fun Int.downTo(to: Int): IntProgression
infix fun Int.downTo(to: Long): LongProgression
infix fun Int.downTo(to: Short): IntProgression

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

Since Kotlin 1.0
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Since Kotlin 1.0
open operator override fun equals(other: Any?): Boolean
fun equals(other: Int): Boolean
Since Kotlin 1.3
Link copied to clipboard
inline fun Int.floorDiv(other: Byte): Int
inline fun Int.floorDiv(other: Int): Int
inline fun Int.floorDiv(other: Long): Long
inline fun Int.floorDiv(other: Short): Int

Divides this value by the other value, flooring the result to an integer that is closer to negative infinity.

Since Kotlin 1.5
Link copied to clipboard
open override fun hashCode(): Int
Since Kotlin 1.3
Link copied to clipboard
operator fun inc(): Int

Returns this value incremented by one.

Since Kotlin 1.0
operator external fun inc(): Int

Returns this value incremented by one.

Since Kotlin 1.3
Link copied to clipboard
fun inv(): Int

Inverts the bits in this value.

Since Kotlin 1.0
external fun inv(): Int

Inverts the bits in this value.

Since Kotlin 1.3
Link copied to clipboard
operator fun minus(other: Byte): Int
operator fun minus(other: Double): Double
operator fun minus(other: Float): Float
operator fun minus(other: Int): Int
operator fun minus(other: Long): Long
operator fun minus(other: Short): Int

Subtracts the other value from this value.

Since Kotlin 1.0
inline operator fun minus(other: Byte): Int
inline operator fun minus(other: Double): Double
inline operator fun minus(other: Float): Float
operator external fun minus(other: Int): Int
inline operator fun minus(other: Long): Long
inline operator fun minus(other: Short): Int

Subtracts the other value from this value.

Since Kotlin 1.3
Link copied to clipboard
inline fun Int.mod(other: Byte): Byte
inline fun Int.mod(other: Int): Int
inline fun Int.mod(other: Long): Long
inline fun Int.mod(other: Short): Short

Calculates the remainder of flooring division of this value (dividend) by the other value (divisor).

Since Kotlin 1.5
Link copied to clipboard
inline external fun <R : Number> Number.narrow(): R
Since Kotlin 1.3
Link copied to clipboard
infix fun or(other: Int): Int

Performs a bitwise OR operation between the two values.

Since Kotlin 1.0
infix external fun or(other: Int): Int

Performs a bitwise OR operation between the two values.

Since Kotlin 1.3
Link copied to clipboard
operator fun plus(other: Byte): Int
operator fun plus(other: Double): Double
operator fun plus(other: Float): Float
operator fun plus(other: Int): Int
operator fun plus(other: Long): Long
operator fun plus(other: Short): Int

Adds the other value to this value.

Since Kotlin 1.0
inline operator fun plus(other: Byte): Int
inline operator fun plus(other: Double): Double
inline operator fun plus(other: Float): Float
operator external fun plus(other: Int): Int
inline operator fun plus(other: Long): Long
inline operator fun plus(other: Short): Int

Adds the other value to this value.

Since Kotlin 1.3
Link copied to clipboard
operator fun rangeTo(other: Byte): IntRange
operator fun rangeTo(other: Int): IntRange
operator fun rangeTo(other: Long): LongRange
operator fun rangeTo(other: Short): IntRange

Creates a range from this value to the specified other value.

Since Kotlin 1.0
operator fun rangeTo(other: Byte): IntRange
operator fun rangeTo(other: Int): IntRange
operator fun rangeTo(other: Long): LongRange
operator fun rangeTo(other: Short): IntRange

Creates a range from this value to the specified other value.

Since Kotlin 1.3
Link copied to clipboard
@ExperimentalStdlibApi
operator fun rangeUntil(other: Byte): IntRange
@ExperimentalStdlibApi
operator fun rangeUntil(other: Int): IntRange
@ExperimentalStdlibApi
operator fun rangeUntil(other: Long): LongRange
@ExperimentalStdlibApi
operator fun rangeUntil(other: Short): IntRange

Creates a range from this value up to but excluding the specified other value.

Since Kotlin 1.7
@ExperimentalStdlibApi
operator fun rangeUntil(other: Byte): IntRange
@ExperimentalStdlibApi
operator fun rangeUntil(other: Int): IntRange
@ExperimentalStdlibApi
operator fun rangeUntil(other: Long): LongRange
@ExperimentalStdlibApi
operator fun rangeUntil(other: Short): IntRange

Creates a range from this value up to but excluding the specified other value.

Since Kotlin 1.7
Link copied to clipboard
operator fun rem(other: Byte): Int
operator fun rem(other: Double): Double
operator fun rem(other: Float): Float
operator fun rem(other: Int): Int
operator fun rem(other: Long): Long
operator fun rem(other: Short): Int

Calculates the remainder of truncating division of this value (dividend) by the other value (divisor).

Since Kotlin 1.1
inline operator fun rem(other: Byte): Int
inline operator fun rem(other: Double): Double
inline operator fun rem(other: Float): Float
operator external fun rem(other: Int): Int
inline operator fun rem(other: Long): Long
inline operator fun rem(other: Short): Int

Calculates the remainder of truncating division of this value (dividend) by the other value (divisor).

Since Kotlin 1.3
Link copied to clipboard
expect fun Int.rotateLeft(bitCount: Int): Int

Rotates the binary representation of this Int number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.

Since Kotlin 1.6
actual fun Int.rotateLeft(bitCount: Int): Int

Rotates the binary representation of this Int number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.

Since Kotlin 1.6
actual inline fun Int.rotateLeft(bitCount: Int): Int

Rotates the binary representation of this Int number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.

Since Kotlin 1.6
actual fun Int.rotateLeft(bitCount: Int): Int

Rotates the binary representation of this Int number left by the specified bitCount number of bits. The most significant bits pushed out from the left side reenter the number as the least significant bits on the right side.

Since Kotlin 1.6
Link copied to clipboard
expect fun Int.rotateRight(bitCount: Int): Int

Rotates the binary representation of this Int number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.

Since Kotlin 1.6
actual fun Int.rotateRight(bitCount: Int): Int

Rotates the binary representation of this Int number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.

Since Kotlin 1.6
actual inline fun Int.rotateRight(bitCount: Int): Int

Rotates the binary representation of this Int number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.

Since Kotlin 1.6
actual fun Int.rotateRight(bitCount: Int): Int

Rotates the binary representation of this Int number right by the specified bitCount number of bits. The least significant bits pushed out from the right side reenter the number as the most significant bits on the left side.

Since Kotlin 1.6
Link copied to clipboard
infix fun shl(bitCount: Int): Int

Shifts this value left by the bitCount number of bits.

Since Kotlin 1.0
infix external fun shl(bitCount: Int): Int

Shifts this value left by the bitCount number of bits.

Since Kotlin 1.3
Link copied to clipboard
infix fun shr(bitCount: Int): Int

Shifts this value right by the bitCount number of bits, filling the leftmost bits with copies of the sign bit.

Since Kotlin 1.0
infix external fun shr(bitCount: Int): Int

Shifts this value right by the bitCount number of bits, filling the leftmost bits with copies of the sign bit.

Since Kotlin 1.3
Link copied to clipboard
inline external fun <R : Number> Number.signExtend(): R
Since Kotlin 1.3
Link copied to clipboard
expect fun Int.takeHighestOneBit(): Int

Returns a number having a single bit set in the position of the most significant set bit of this Int number, or zero, if this number is zero.

Since Kotlin 1.4
actual fun Int.takeHighestOneBit(): Int

Returns a number having a single bit set in the position of the most significant set bit of this Int number, or zero, if this number is zero.

Since Kotlin 1.4
actual inline fun Int.takeHighestOneBit(): Int

Returns a number having a single bit set in the position of the most significant set bit of this Int number, or zero, if this number is zero.

Since Kotlin 1.4
actual fun Int.takeHighestOneBit(): Int

Returns a number having a single bit set in the position of the most significant set bit of this Int number, or zero, if this number is zero.

Since Kotlin 1.4
Link copied to clipboard
expect fun Int.takeLowestOneBit(): Int

Returns a number having a single bit set in the position of the least significant set bit of this Int number, or zero, if this number is zero.

Since Kotlin 1.4
actual fun Int.takeLowestOneBit(): Int

Returns a number having a single bit set in the position of the least significant set bit of this Int number, or zero, if this number is zero.

Since Kotlin 1.4
actual inline fun Int.takeLowestOneBit(): Int

Returns a number having a single bit set in the position of the least significant set bit of this Int number, or zero, if this number is zero.

Since Kotlin 1.4
actual fun Int.takeLowestOneBit(): Int

Returns a number having a single bit set in the position of the least significant set bit of this Int number, or zero, if this number is zero.

Since Kotlin 1.4
Link copied to clipboard
operator fun times(other: Byte): Int
operator fun times(other: Double): Double
operator fun times(other: Float): Float
operator fun times(other: Int): Int
operator fun times(other: Long): Long
operator fun times(other: Short): Int

Multiplies this value by the other value.

Since Kotlin 1.0
inline operator fun times(other: Byte): Int
inline operator fun times(other: Double): Double
inline operator fun times(other: Float): Float
operator external fun times(other: Int): Int
inline operator fun times(other: Long): Long
inline operator fun times(other: Short): Int

Multiplies this value by the other value.

Since Kotlin 1.3
Link copied to clipboard
inline operator fun Int.times(duration: Duration): Duration

Returns a duration whose value is the specified duration value multiplied by this number.

Since Kotlin 1.6
Link copied to clipboard
inline fun Int.toBigDecimal(): BigDecimal
inline fun Int.toBigDecimal(mathContext: MathContext): BigDecimal

Returns the value of this Int number as a BigDecimal.

Since Kotlin 1.2
Link copied to clipboard
inline fun Int.toBigInteger(): BigInteger

Returns the value of this Int number as a BigInteger.

Since Kotlin 1.2
Link copied to clipboard
open override fun toByte(): Byte

Converts this Int value to Byte.

Since Kotlin 1.0
open external override fun toByte(): Byte

Converts this Int value to Byte.

Since Kotlin 1.3
Link copied to clipboard
open override fun toChar(): Char

Converts this Int value to Char.

Since Kotlin 1.0
open external override fun toChar(): Char

Converts this Int value to Char.

Since Kotlin 1.3
Link copied to clipboard
open override fun toDouble(): Double

Converts this Int value to Double.

Since Kotlin 1.0
open external override fun toDouble(): Double

Converts this Int value to Double.

Since Kotlin 1.3
Link copied to clipboard
fun Int.toDuration(unit: DurationUnit): Duration

Returns a Duration equal to this Int number of the specified unit.

Since Kotlin 1.6
Link copied to clipboard
open override fun toFloat(): Float

Converts this Int value to Float.

Since Kotlin 1.0
open external override fun toFloat(): Float

Converts this Int value to Float.

Since Kotlin 1.3
Link copied to clipboard
open override fun toInt(): Int

Returns this value.

Since Kotlin 1.0
open inline override fun toInt(): Int

Returns this value.

Since Kotlin 1.3
Link copied to clipboard
open override fun toLong(): Long

Converts this Int value to Long.

Since Kotlin 1.0
open external override fun toLong(): Long

Converts this Int value to Long.

Since Kotlin 1.3
Link copied to clipboard
open override fun toShort(): Short

Converts this Int value to Short.

Since Kotlin 1.0
open external override fun toShort(): Short

Converts this Int value to Short.

Since Kotlin 1.3
Link copied to clipboard
open override fun toString(): String
Since Kotlin 1.0
open external override fun toString(): String
Since Kotlin 1.3
Link copied to clipboard
expect fun Int.toString(radix: Int): String

Returns a string representation of this Int value in the specified radix.

Since Kotlin 1.2
actual fun Int.toString(radix: Int): String

Returns a string representation of this Int value in the specified radix.

Since Kotlin 1.2
actual inline fun Int.toString(radix: Int): String

Returns a string representation of this Int value in the specified radix.

Since Kotlin 1.1
actual inline fun Int.toString(radix: Int): String

Returns a string representation of this Int value in the specified radix.

Since Kotlin 1.3
Link copied to clipboard
inline fun Int.toUByte(): UByte

Converts this Int value to UByte.

Since Kotlin 1.5
Link copied to clipboard
inline fun Int.toUInt(): UInt

Converts this Int value to UInt.

Since Kotlin 1.5
Link copied to clipboard
inline fun Int.toULong(): ULong

Converts this Int value to ULong.

Since Kotlin 1.5
Link copied to clipboard
inline fun Int.toUShort(): UShort

Converts this Int value to UShort.

Since Kotlin 1.5
Link copied to clipboard
operator fun unaryMinus(): Int

Returns the negative of this value.

Since Kotlin 1.0
operator external fun unaryMinus(): Int

Returns the negative of this value.

Since Kotlin 1.3
Link copied to clipboard
operator fun unaryPlus(): Int

Returns this value.

Since Kotlin 1.0
operator external fun unaryPlus(): Int

Returns this value.

Since Kotlin 1.3
Link copied to clipboard
infix fun Int.until(to: Byte): IntRange
infix fun Int.until(to: Int): IntRange
infix fun Int.until(to: Long): LongRange
infix fun Int.until(to: Short): IntRange

Returns a range from this value up to but excluding the specified to value.

Since Kotlin 1.0
Link copied to clipboard
infix fun ushr(bitCount: Int): Int

Shifts this value right by the bitCount number of bits, filling the leftmost bits with zeros.

Since Kotlin 1.0
infix external fun ushr(bitCount: Int): Int

Shifts this value right by the bitCount number of bits, filling the leftmost bits with zeros.

Since Kotlin 1.3
Link copied to clipboard
infix fun xor(other: Int): Int

Performs a bitwise XOR operation between the two values.

Since Kotlin 1.0
infix external fun xor(other: Int): Int

Performs a bitwise XOR operation between the two values.

Since Kotlin 1.3