kone.algebraic/dev.lounres.kone.algebraic/EuclideanRing

EuclideanRing

interface EuclideanRing<Number> : Ring<Number> , EuclideanSemiring<Number> (source)

Describes a context that represents Euclidean ring (a.k.a. Euclidean domain). It means that it extends both Ring and EuclideanSemiring interfaces without adding anything new to them. Just a composition of this two.

Inheritors

BigIntegerContext

Types

Key

class Key<Number>(elementType: SuppliedType<Number>) : RegistryKey<EuclideanRing<Number>>

Registry key for EuclideanRing interface in KoneContextRegistry.

Properties

one

abstract val one: Number

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

value

open val Int.value: Number

Converts instance of Int to an element of the Ring it is equal to.

open val Long.value: Number

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

open val UInt.value: Number

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

open val ULong.value: Number

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

zero

abstract val zero: Number

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

Functions

div

open operator fun Number.div(other: Number): Number

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

divrem

abstract infix fun Number.divrem(other: Number): EuclideanDivisionResult<Number>

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

equalsTo

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

isNotOne

open fun Number.isNotOne(): Boolean

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

isNotZero

open fun Number.isNotZero(): Boolean

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

isOne

open fun Number.isOne(): Boolean

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

isZero

open fun Number.isZero(): Boolean

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

minus

abstract operator fun Number.minus(other: Number): Number

Subtracts this and the other numbers in terms of the Ring.

open operator fun Number.minus(other: Int): Number

open operator fun Number.minus(other: Long): Number

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

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

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

open operator fun Int.minus(other: Number): Number

open operator fun Long.minus(other: Number): Number

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

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

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

plus

open operator fun Number.plus(other: Int): Number

open operator fun Number.plus(other: Long): Number

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

open operator fun Int.plus(other: Number): Number

open operator fun Long.plus(other: Number): Number

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

abstract operator fun Number.plus(other: Number): Number

Sums this and the other numbers in terms of the Semiring.

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

open operator fun Number.plus(other: ULong): Number

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

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

open operator fun ULong.plus(other: Number): Number

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

pow

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

open infix fun Number.pow(exponent: ULong): Number

Raises this number in the power of exponent.

power

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

open fun power(base: Number, exponent: ULong): Number

Raises base number in the power of exponent.

rem

open operator fun Number.rem(other: Number): Number

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

times

open operator fun Number.times(other: Int): Number

open operator fun Number.times(other: Long): Number

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

open operator fun Int.times(other: Number): Number

open operator fun Long.times(other: Number): Number

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

abstract operator fun Number.times(other: Number): Number

Multiplies this and the other numbers in terms of the Semiring.

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

open operator fun Number.times(other: ULong): Number

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

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

open operator fun ULong.times(other: Number): Number

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

unaryMinus

abstract operator fun Number.unaryMinus(): Number

Inverses this value in terms of the Ring.

valueOf

open fun valueOf(arg: Int): Number

Converts instance of Int to an element of the Ring it is equal to.

open fun valueOf(arg: Long): Number

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

open fun valueOf(arg: UInt): Number

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

open fun valueOf(arg: ULong): Number

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