types/kotools.types.number/NegativeInt

NegativeInt

@Serializable(with = NegativeIntSerializer::class)
@Since(version = KotoolsTypesVersion.V1_1_0)
interface NegativeInt : AnyInt

Represents an integer number of type Int that is less than or equals zero.

You can use the toNegativeInt function for creating an instance of this type.


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 number: NegativeInt = (-123).toNegativeInt()
    .getOrThrow()
val encoded: String = Json.encodeToString(number)
assertEquals(expected = "-123", actual = encoded)
val decoded: NegativeInt = Json.decodeFromString(encoded)
assertEquals(expected = number, actual = decoded)
Content copied to clipboard

Inheritors

Types

Link copied to clipboard
object Companion

Contains declarations for holding or building a NegativeInt.

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
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun AnyInt.div(other: NonZeroInt): Int
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun NegativeInt.div(other: StrictlyNegativeInt): PositiveInt
@Since(version = KotoolsTypesVersion.V4_1_0)
operator fun NegativeInt.div(other: StrictlyPositiveInt): NegativeInt

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 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
@Since(version = KotoolsTypesVersion.V4_0_0)
abstract override fun toInt(): Int

Returns this integer as an Int.

Link copied to clipboard
@Since(version = KotoolsTypesVersion.V4_0_0)
abstract override fun toString(): String

Returns the string representation of this integer.

Link copied to clipboard
@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.