Kotools Types/kotools.types.number/ZeroInt

ZeroInt

@Serializable(with = ZeroIntSerializer::class)
@Since(version = KotoolsTypesVersion.V4_0_0)
object ZeroInt : PositiveInt, NegativeInt

Represents an integer number of type Int that equals zero.

Functions

Link copied to clipboard
@Since(version = KotoolsTypesVersion.V4_1_0)
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.

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

Returns this integer as an Int.

Link copied to clipboard
open override fun toString(): String

Returns the string representation of this integer.

Extensions

Link copied to clipboard
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun PositiveInt.div(other: StrictlyPositiveInt): PositiveInt
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun PositiveInt.div(other: StrictlyNegativeInt): NegativeInt
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun AnyInt.div(other: NonZeroInt): Int
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun NegativeInt.div(other: StrictlyPositiveInt): NegativeInt
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun NegativeInt.div(other: StrictlyNegativeInt): PositiveInt

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

Link copied to clipboard
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun AnyInt.minus(other: Int): Int
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun AnyInt.minus(other: AnyInt): Int

Subtracts the other integer from this one.

Link copied to clipboard
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun AnyInt.plus(other: Int): Int
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun AnyInt.plus(other: AnyInt): Int

Adds the other integer to this one.

Link copied to clipboard
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun PositiveInt.rem(other: NonZeroInt): PositiveInt
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun AnyInt.rem(other: NonZeroInt): Int
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun NegativeInt.rem(other: NonZeroInt): NegativeInt

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

Link copied to clipboard
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun AnyInt.times(other: Int): Int
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun AnyInt.times(other: AnyInt): Int

Multiplies this integer by the other one.

Link copied to clipboard
@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_4_0)
operator fun PositiveInt.unaryMinus(): NegativeInt
@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_4_0)
operator fun AnyInt.unaryMinus(): AnyInt
@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_4_0)
operator fun NegativeInt.unaryMinus(): PositiveInt

Returns the negative of this integer number.