Kotools Types/kotools.types.number/NegativeInt/Companion

Companion

object Companion

Contains declarations for holding or building a NegativeInt.

Properties

Link copied to clipboard
val max: ZeroInt

The maximum value a NegativeInt can have.

Link copied to clipboard
val min: StrictlyNegativeInt

The minimum value a NegativeInt can have.

Link copied to clipboard
@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_4_0)
val NegativeInt.Companion.range: NotEmptyRange<NegativeInt>

The range of values a NegativeInt can have.

Functions

Link copied to clipboard
@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_5_0)
fun create(number: Number): NegativeInt

Creates a NegativeInt from the specified number, which may involve rounding or truncation, or throws an IllegalArgumentException if the number is greater than zero.

Link copied to clipboard
@ExperimentalKotoolsTypesApi
@ExperimentalSince(version = KotoolsTypesVersion.V4_5_0)
fun createOrNull(number: Number): NegativeInt?

Creates a NegativeInt from the specified number, which may involve rounding or truncation, or returns null if the number is greater than zero.

Link copied to clipboard
@Since(version = KotoolsTypesVersion.V3_0_0)
fun random(): NegativeInt

Returns a random NegativeInt.