types/kotools.types.number/ZeroInt

ZeroInt

@Serializable(with = ZeroIntSerializer::class)

object ZeroInt : PositiveInt, NegativeInt

Represents an integer number of type Int that equals zero.

Serialization and deserialization

The serialization and deserialization processes of this type behave like for the Int type.

Here's an example of Kotlin code that encodes and decodes this type using the JavaScript Object Notation (JSON) format from kotlinx.serialization:

val encoded: String = Json.encodeToString(ZeroInt)
assertEquals(expected = "0", actual = encoded)
val decoded: ZeroInt = Json.decodeFromString(encoded)
assertSame(expected = ZeroInt, actual = decoded)

Since

4.0.0

Functions

open infix operator override fun compareTo(other: AnyInt): Int

Compares this integer with the other one for order. Returns zero if this integer equals the other one, a negative number if it's less than the other one, or a positive number if it's greater than the other one.

operator fun AnyInt.div(other: NonZeroInt): Int

operator fun NegativeInt.div(other: StrictlyNegativeInt): PositiveInt

operator fun NegativeInt.div(other: StrictlyPositiveInt): NegativeInt

operator fun PositiveInt.div(other: StrictlyNegativeInt): NegativeInt

operator fun PositiveInt.div(other: StrictlyPositiveInt): PositiveInt

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

operator fun AnyInt.minus(other: Int): Int

operator fun AnyInt.minus(other: AnyInt): Int

Subtracts the other integer from this one.

operator fun AnyInt.plus(other: Int): Int

operator fun AnyInt.plus(other: AnyInt): Int

Adds the other integer to this one.

operator fun AnyInt.rem(other: NonZeroInt): Int

operator fun NegativeInt.rem(other: NonZeroInt): NegativeInt

operator fun PositiveInt.rem(other: NonZeroInt): PositiveInt

Calculates the remainder of truncating division of this integer by the other one.

operator fun AnyInt.times(other: Int): Int

operator fun AnyInt.times(other: AnyInt): Int

Multiplies this integer by the other one.

open override fun toInt(): Int

Returns this integer as an Int.

open override fun toString(): String

Returns the string representation of this integer.