Int
class Int : Number, Comparable<Int>
For Common, JVM, JS
Represents a 32-bit signed integer. On the JVM, non-nullable values of this type are represented as values of the primitive type int.
For Native
Represents a 32-bit signed integer.
Functions
and
Performs a bitwise AND operation between the two values.
infix fun and(other: Int): Int
compareTo
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.
operator fun compareTo(other: Byte): Int
operator fun compareTo(other: Short): Int
operator fun compareTo(other: Int): Int
operator fun compareTo(other: Long): Int
operator fun compareTo(other: Float): Int
operator fun compareTo(other: Double): Int
dec
Returns this value decremented by one.
operator fun dec(): Int
div
Divides this value by the other value, truncating the result to an integer that is closer to zero.
operator fun div(other: Byte): Int
operator fun div(other: Short): Int
operator fun div(other: Int): Int
operator fun div(other: Long): Long
Divides this value by the other value.
operator fun div(other: Float): Float
operator fun div(other: Double): Double
equals
fun equals(other: Int): Boolean
Indicates whether some other object is "equal to" this one. Implementations must fulfil the following requirements:
fun equals(other: Any?): Boolean
hashCode
Returns a hash code value for the object. The general contract of hashCode is:
fun hashCode(): Int
inc
Returns this value incremented by one.
operator fun inc(): Int
inv
Inverts the bits in this value.
fun inv(): Int
minus
Subtracts the other value from this value.
operator fun minus(other: Byte): Int
operator fun minus(other: Short): Int
operator fun minus(other: Int): Int
operator fun minus(other: Long): Long
operator fun minus(other: Float): Float
operator fun minus(other: Double): Double
or
Performs a bitwise OR operation between the two values.
infix fun or(other: Int): Int
plus
Adds the other value to this value.
operator fun plus(other: Byte): Int
operator fun plus(other: Short): Int
operator fun plus(other: Int): Int
operator fun plus(other: Long): Long
operator fun plus(other: Float): Float
operator fun plus(other: Double): Double
rangeTo
Creates a range from this value to the specified other value.
operator fun rangeTo(other: Byte): IntRange
operator fun rangeTo(other: Short): IntRange
operator fun rangeTo(other: Int): IntRange
operator fun rangeTo(other: Long): LongRange
rem
Calculates the remainder of truncating division of this value by the other value.
operator fun rem(other: Byte): Int
operator fun rem(other: Short): Int
operator fun rem(other: Int): Int
operator fun rem(other: Long): Long
operator fun rem(other: Float): Float
operator fun rem(other: Double): Double
shl
Shifts this value left by the bitCount number of bits.
infix fun shl(bitCount: Int): Int
shr
Shifts this value right by the bitCount number of bits, filling the leftmost bits with copies of the sign bit.
infix fun shr(bitCount: Int): Int
times
Multiplies this value by the other value.
operator fun times(other: Byte): Int
operator fun times(other: Short): Int
operator fun times(other: Int): Int
operator fun times(other: Long): Long
operator fun times(other: Float): Float
operator fun times(other: Double): Double
toByte
toChar
toDouble
toFloat
toInt
Returns this value.
fun toInt(): Int
toLong
toShort
toString
Returns a string representation of the object.
fun toString(): String
unaryMinus
Returns the negative of this value.
operator fun unaryMinus(): Int
unaryPlus
Returns this value.
operator fun unaryPlus(): Int
ushr
Shifts this value right by the bitCount number of bits, filling the leftmost bits with zeros.
infix fun ushr(bitCount: Int): Int
xor
Performs a bitwise XOR operation between the two values.
infix fun xor(other: Int): Int
Companion Object Properties
MAX_VALUE
A constant holding the maximum value an instance of Int can have.
const val MAX_VALUE: Int
MIN_VALUE
A constant holding the minimum value an instance of Int can have.
const val MIN_VALUE: Int
SIZE_BITS
The number of bits used to represent an instance of Int in a binary form.
const val SIZE_BITS: Int
SIZE_BYTES
The number of bytes used to represent an instance of Int in a binary form.
const val SIZE_BYTES: Int
Extension Properties
days
hours
microseconds
milliseconds
minutes
nanoseconds
Extension Functions
coerceAtLeast
Ensures that this value is not less than the specified minimumValue.
fun Int.coerceAtLeast(minimumValue: Int): Int
fun <T : Comparable<T>> T.coerceAtLeast(minimumValue: T): T
coerceAtMost
Ensures that this value is not greater than the specified maximumValue.
fun Int.coerceAtMost(maximumValue: Int): Int
fun <T : Comparable<T>> T.coerceAtMost(maximumValue: T): T
coerceIn
Ensures that this value lies in the specified range minimumValue..maximumValue.
fun Int.coerceIn(minimumValue: Int, maximumValue: Int): Int
fun <T : Comparable<T>> T.coerceIn( minimumValue: T?, maximumValue: T? ): T
Ensures that this value lies in the specified range.
fun Int.coerceIn(range: ClosedRange<Int>): Int
fun <T : Comparable<T>> T.coerceIn( range: ClosedFloatingPointRange<T> ): T
fun <T : Comparable<T>> T.coerceIn(range: ClosedRange<T>): T
compareTo
convert
fun <R : Any> Int.convert(): R
digitToChar
Returns the Char that represents this decimal digit. Throws an exception if this value is not in the range 0..9.
fun Int.digitToChar(): Char
downTo
Returns a progression from this value down to the specified to value with the step -1.
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
floorDiv
Divides this value by the other value, flooring the result to an integer that is closer to negative infinity.
fun Int.floorDiv(other: Byte): Int
fun Int.floorDiv(other: Short): Int
fun Int.floorDiv(other: Int): Int
fun Int.floorDiv(other: Long): Long
mod
Calculates the remainder of flooring division of this value by the other value.
fun Int.mod(other: Byte): Byte
fun Int.mod(other: Short): Short
fun Int.mod(other: Int): Int
fun Int.mod(other: Long): Long
narrow
fun <R : Number> Number.narrow(): R
rangeTo
Creates a range from this Comparable value to the specified that value.
operator fun <T : Comparable<T>> T.rangeTo( that: T ): ClosedRange<T>
signExtend
fun <R : Number> Number.signExtend(): R
times
Returns a duration whose value is the specified duration value multiplied by this number.
operator fun Int.times(duration: Duration): Duration
toBigDecimal
Returns the value of this Int number as a BigDecimal.
fun Int.toBigDecimal(): BigDecimal
fun Int.toBigDecimal(mathContext: MathContext): BigDecimal
toBigInteger
Returns the value of this Int number as a BigInteger.
fun Int.toBigInteger(): BigInteger
toDuration
toUByte
toUInt
toULong
toUShort
until
Returns a range from this value up to but excluding the specified to value.
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
© 2010–2021 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/-int/index.html