0.0.0-experiment

kone.algebraic/dev.lounres.kone.algebraic/Ring

Ring

interface Ring<Number> : Semiring<Number> (source)

Describes a context that represents mathematical commutative ring. It means that it provides operations like +, - (both unary and binary), *, power, and some other that satisfy axioms of ring like a + b == b + a or a * (b * c) == (a * b) * c.

Usual structures like integers or real numbers satisfy the axioms (one says that they form commutative rings), so you don't need to worry about fully understanding the concept of commutative ring. It won't be true only the moment you introduce such structures as a ring of matrices 2⨯2 with usual operations you learn on any course of linear algebra.

Obviously, the Ring interface extends the Equality interface (via Semiring interface) because otherwise there is no understanding of the mathematical operations.

Inheritors

Types

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

Registry key for Ring interface in KoneContextRegistry.

Properties

abstract val one: Number

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

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.

abstract val zero: Number

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

Functions

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

open fun Number.isNotOne(): Boolean

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

open fun Number.isNotZero(): Boolean

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

open fun Number.isOne(): Boolean

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

open fun Number.isZero(): Boolean

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

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.

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.

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

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

Raises this number in the power of exponent.

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

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

Raises base number in the power of exponent.

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.

abstract operator fun Number.unaryMinus(): Number

Inverses this value in terms of the Ring.

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.