NonZeroInt

@SinceKotools(project = Project.Types, version = "1.1")

~~interface~~ ~~NonZeroInt~~ : ~~IntHolder~~

Representation of integers other than zero.

Types

Companion

common

object Companion

Contains declarations for holding or building a NonZeroInt.

ConstructionError

common

@SinceKotools(project = Project.Types, version = "3.0")

~~object~~ ~~ConstructionError~~ : ~~IllegalArgumentException~~

Error thrown when creating a NonZeroInt fails.

Functions

compareTo

common

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

common

open operator override fun dec(): NonZeroInt

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

common

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.

inc

common

open operator override fun inc(): NonZeroInt

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

common

open operator fun minus(other: Int): Int

open operator fun minus(other: IntHolder): Int

Subtracts the other value from this value.

plus

common

open operator fun plus(other: Int): Int

open operator fun plus(other: IntHolder): Int

Adds the other value to this value.

times

common

open operator fun times(other: Int): Int

open operator fun times(other: IntHolder): Int

Multiplies this value by the other value.

open operator fun times(other: NonZeroInt): NonZeroInt

Multiplies this value by the other value.

unaryMinus

common

open operator override fun unaryMinus(): NonZeroInt

Returns the negative of this value.

Properties

value

common

abstract val value: Int

The value to hold.

Inheritors

StrictlyNegativeInt

StrictlyPositiveInt