kone.algebraic/dev.lounres.kone.algebraic/signInt

signInt

context(monoid: Monoid<Number>, order: Order<Number>)
fun <Number> Number.signInt(): Int(source)

Returns value of (mathematical) sign function. I.e. returns 1 if this number is positive, -1 if this number is negative, or 0 if this number is zero.

Receiver

The number whose sign integer is to be returned.

Return

1 if this number is positive, -1 if negative, 0 if zero.

Context Parameters

monoid

The monoid providing the zero element for comparison.

order

The order relation for comparison.

Type Parameters

Number

The type of numbers being compared.