Kotools Types/kotools.types.number/StrictlyPositiveInt

StrictlyPositiveInt

@Serializable(with = StrictlyPositiveIntSerializer::class)

interface ~~StrictlyPositiveInt~~ : NonZeroInt, PositiveInt

Deprecated

Use the kotools.types.StrictlyPositiveInt type instead.

Replace with

import kotools.types.StrictlyPositiveInt

StrictlyPositiveInt

Representation of strictly positive integers, excluding zero.

Types

Companion

object Companion

Contains declarations for holding or building a StrictlyPositiveInt.

ConstructionError

class ~~ConstructionError~~(value: Int) : IllegalArgumentException

Error thrown when creating a StrictlyPositiveInt fails.

Functions

compareTo

open operator fun compareTo(other: Int): Int

open operator override fun compareTo(other: IntHolder): Int

Compares this value with the other value for order. Returns zero if this value equals the other value, a negative number if this value is less than the other value, or a positive number if this value is greater than the other value.

dec

open operator override fun dec(): StrictlyPositiveInt

Returns this value decremented by one. If this value equals 1, it returns -1 instead. If this value is the minimum, it returns the maximum value instead.

div

open operator fun div(other: NonZeroInt): Int

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

open operator fun div(other: StrictlyNegativeInt): NegativeInt

open operator fun div(other: StrictlyPositiveInt): PositiveInt

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

inc

open operator override fun inc(): StrictlyPositiveInt

Returns this value incremented by one. If this value equals -1, it returns 1 instead. If this value is the maximum, it returns the minimum value instead.

minus