kone.algebraic/dev.lounres.kone.algebraic/UIntContext

UIntContext

data object UIntContext : Reification<UInt> , EuclideanSemiring<UInt> , ExtendedSemiring<UInt> , Order<UInt> , Hashing<UInt> (source)

Default Euclidean semiring for UInt type which values are seen as non-negative integers and where overflows are ignored. It also implements Reification, ExtendedSemiring, Order, and Hashing interfaces in the default understanding.

Such context is useless when used as is, but useful when used in generalised algorithms.

Properties

one

open override val one: UInt

Represents a unit element (a.k.a. neutral multiplicative element).

value

open val UInt.value: UInt

Converts instance of UInt to an element of the Semiring it is equal to.

open val ULong.value: UInt

Converts instance of Long to an element of the Semiring it is equal to.

zero

open override val zero: UInt

Represents a zero element (a.k.a. neutral additive element).

Functions

compareWith

open infix override fun UInt.compareWith(other: UInt): ComparisonResult

contains

open operator override fun contains(element: Any?): Boolean

div

open operator override fun UInt.div(other: UInt): UInt

Returns quotient of Euclidean division (a.k.a. a division with remainder).

divrem

open infix override fun UInt.divrem(other: UInt): EuclideanDivisionResult<UInt>

Returns result of Euclidean division (a.k.a. a division with remainder), both quotient and remainder.

equalsTo

open infix fun UInt.equalsTo(other: UInt): Boolean

hash

open fun UInt.hash(): Int

isNotOne

open fun UInt.isNotOne(): Boolean

Checks that this number is not a one in the context of the Semiring.

isNotZero

open fun UInt.isNotZero(): Boolean

Checks that this number is not a zero in the context of the Semiring.

isOne

open fun UInt.isOne(): Boolean

Checks that this number is a one in the context of the Semiring.

isZero

open fun UInt.isZero(): Boolean

Checks that this number is a zero in the context of the Semiring.

minus

open operator fun UInt.minus(other: ULong): UInt

Subtracts this number and the other integer as elements of the Ring.

open operator fun ULong.minus(other: UInt): UInt

Sums this integer and the other number as elements of the Ring.

open operator override fun UInt.minus(other: UInt): UInt

Subtracts this number and the other integer as elements of the ExtendedSemiring.

plus

open operator override fun UInt.plus(other: UInt): UInt

open operator override fun UInt.plus(other: ULong): UInt

Sums this number and the other integer as elements of the Semiring.

open operator override fun ULong.plus(other: UInt): UInt

Sums this integer and the other number as elements of the Semiring.

pow

open infix override fun UInt.pow(exponent: UInt): UInt

open infix override fun UInt.pow(exponent: ULong): UInt

Raises this number in the power of exponent.

power

open override fun power(base: UInt, exponent: UInt): UInt

open override fun power(base: UInt, exponent: ULong): UInt

Raises base number in the power of exponent.

reify

open override fun reify(element: Any?): UInt

reifyMaybe

open override fun reifyMaybe(element: Any?): Maybe<UInt>

reifyOrNull

open override fun reifyOrNull(element: Any?): UInt?

rem

open operator override fun UInt.rem(other: UInt): UInt

Returns remainder of Euclidean division (a.k.a. a division with remainder).

times

open operator override fun UInt.times(other: UInt): UInt

open operator override fun UInt.times(other: ULong): UInt

Multiplies this number and the other integer as elements of the Semiring.

open operator override fun ULong.times(other: UInt): UInt

Sums this integer and the other number as elements of the Semiring.

valueOf

open override fun valueOf(arg: UInt): UInt

Converts instance of UInt to an element of the Semiring it is equal to.

open override fun valueOf(arg: ULong): UInt

Converts instance of ULong to an element of the Semiring it is equal to.