types/kotools.types.number

Package-level declarations

Contains types such as NonZeroInt for manipulating numbers.

Types

@Serializable(with = AnyIntSerializer::class)

sealed interface AnyInt : Comparable<AnyInt>

Represents an integer number of type Int.

@Serializable(with = NegativeIntSerializer::class)

sealed interface NegativeInt : AnyInt

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

@Serializable(with = NonZeroIntSerializer::class)

sealed interface NonZeroInt : AnyInt

Represents an integer number of type Int that is other than zero.

@Serializable(with = PositiveIntSerializer::class)

sealed interface PositiveInt : AnyInt

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

StrictlyNegativeInt

@Serializable(with = StrictlyNegativeIntSerializer::class)

value class StrictlyNegativeInt : NonZeroInt, NegativeInt

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

StrictlyPositiveInt

@Serializable(with = StrictlyPositiveIntSerializer::class)

value class StrictlyPositiveInt : NonZeroInt, PositiveInt

Represents an integer number of type Int that is greater than zero.

@Serializable(with = ZeroIntSerializer::class)

object ZeroInt : PositiveInt, NegativeInt

Represents an integer number of type Int that equals zero.

Functions

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

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 Int.minus(other: AnyInt): Int

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

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

Subtracts the other integer from this one.

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

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

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

Adds the other integer to this one.

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

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 Int.times(other: AnyInt): Int

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

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

Multiplies this integer by the other one.

fun Number.toNegativeInt(): Result<NegativeInt>

Returns this number as an encapsulated NegativeInt, which may involve rounding or truncation, or returns an encapsulated IllegalArgumentException if this number is strictly positive.

fun Number.toNonZeroInt(): Result<NonZeroInt>

Returns this number as an encapsulated NonZeroInt, which may involve rounding or truncation, or returns an encapsulated IllegalArgumentException if this number equals zero.

fun Number.toPositiveInt(): Result<PositiveInt>

Returns this number as an encapsulated PositiveInt, which may involve rounding or truncation, or returns an encapsulated IllegalArgumentException if this number is strictly negative.

toStrictlyNegativeInt

fun Number.toStrictlyNegativeInt(): Result<StrictlyNegativeInt>

Returns this number as an encapsulated StrictlyNegativeInt, which may involve rounding or truncation, or returns an encapsulated IllegalArgumentException if this number is positive.

toStrictlyPositiveInt

fun Number.toStrictlyPositiveInt(): Result<StrictlyPositiveInt>

Returns this number as an encapsulated StrictlyPositiveInt, which may involve rounding or truncation, or returns an encapsulated IllegalArgumentException if this number is negative.