kone.algebraic/dev.lounres.kone.algebraic/Sign

Sign

enum Sign : Enum<Sign> (source)

Represents the sign of a number: negative, zero, or positive.

Parameters

signInt

The integer representation of the sign: -1 for negative, 0 for zero, 1 for positive.

Entries

Negative sign (for numbers less than zero).

Zero sign (for numbers equal to zero).

Positive sign (for numbers greater than zero).

Properties

val entries: EnumEntries<Sign>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

expect val name: String

expect val ordinal: Int

Functions

fun Sign.isNegative(): Boolean

Checks if this sign is negative.

fun Sign.isNonNegative(): Boolean

Checks if this sign is non-negative (i.e. zero or positive).

fun Sign.isNonPositive(): Boolean

Checks if this sign is non-positive (i.e. zero or negative).

fun Sign.isNonZero(): Boolean

Checks if this sign is non-zero.

fun Sign.isPositive(): Boolean

Checks if this sign is positive.

fun Sign.isZero(): Boolean

Checks if this sign is zero.

operator fun Sign.times(other: Sign): Sign

Multiplies this sign by another sign.

fun toSignInt(): Int

Returns the integer representation of this sign.

operator fun Sign.unaryMinus(): Sign

Returns the negation of this sign.

fun valueOf(value: String): Sign

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<Sign>

Returns an array containing the constants of this enum type, in the order they're declared.