PositiveInt

@SinceKotools(project = Project.Types, version = "1.1")
interface PositiveInt : IntHolder
Content copied to clipboard

Representation of positive integers, including zero.

Types

Companion
Link copied to clipboard
common
object Companion
Content copied to clipboard

Contains declarations for holding or building a PositiveInt.

ConstructionError
Link copied to clipboard
common
@SinceKotools(project = Project.Types, version = "3.0")
class ConstructionError(value: Int) : IllegalArgumentException
Content copied to clipboard

Error thrown when creating a PositiveInt fails.

Functions

compareTo
Link copied to clipboard
common
open operator fun compareTo(other: Int): Int
Content copied to clipboard
open operator override fun compareTo(other: IntHolder): Int
Content copied to clipboard

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
Link copied to clipboard
common
open operator override fun dec(): PositiveInt
Content copied to clipboard

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

div
Link copied to clipboard
common
open operator fun div(other: NonZeroInt): Int
Content copied to clipboard

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
Content copied to clipboard
open operator fun div(other: StrictlyPositiveInt): PositiveInt
Content copied to clipboard

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

inc
Link copied to clipboard
common
open operator override fun inc(): PositiveInt
Content copied to clipboard

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

minus
Link copied to clipboard
common
open operator fun minus(other: Int): Int
Content copied to clipboard
open operator fun minus(other: IntHolder): Int
Content copied to clipboard

Subtracts the other value from this value.

plus
Link copied to clipboard
common
open operator fun plus(other: Int): Int
Content copied to clipboard
open operator fun plus(other: IntHolder): Int
Content copied to clipboard

Adds the other value to this value.

times
Link copied to clipboard
common
open operator fun times(other: Int): Int
Content copied to clipboard
open operator fun times(other: IntHolder): Int
Content copied to clipboard

Multiplies this value by the other value.

unaryMinus
Link copied to clipboard
common
open operator override fun unaryMinus(): NegativeInt
Content copied to clipboard

Returns the negative of this value.

Properties

value
Link copied to clipboard
common
abstract val value: Int
Content copied to clipboard

The value to hold.

Inheritors

StrictlyPositiveInt
Link copied to clipboard