NDRing

interface NDRing<T, R : Ring<T>> : Ring<NDStructure<T>> , NDSpace<T, R>

Ring of NDStructure.

Parameters

the type of the element contained in ND structure.

the type of ND structure.

the type of ring of structure elements.

Types

Companion

common

object Companion

Functions

add

common

abstract fun add(a: NDStructure<T>, b: NDStructure<T>): NDStructure<T>

Addition of two elements.

binaryOperation

common

open fun binaryOperation(operation: String, left: NDStructure<T>, right: NDStructure<T>): NDStructure<T>

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

common

open override fun binaryOperationFunction(operation: String): (left: NDStructure<T>, right: NDStructure<T>) -> NDStructure<T>

Dynamically dispatches a binary operation with the certain name.

bindSymbol

common

open fun bindSymbol(value: String): NDStructure<T>

Wraps a raw string to T object.

combine

common

abstract fun combine(a: NDStructure<T>, b: NDStructure<T>, transform: R.(T, T) -> T): NDStructure<T>

Combines two structures into one.

div

common

open operator fun NDStructure<T>.div(k: Number): NDStructure<T>

Division of this element by scalar.

equals

common

open operator fun equals(other: Any?): Boolean

hashCode

common

open fun hashCode(): Int

invoke

common

open operator fun (T) -> T.invoke(structure: NDStructure<T>): NDStructure<T>

Element-wise invocation of function working on T on a NDStructure.

map

common

abstract fun NDStructure<T>.map(transform: R.(T) -> T): NDStructure<T>

Maps elements from one structure to another one by applying transform to them.

mapIndexed

common

abstract fun NDStructure<T>.mapIndexed(transform: R.(index: IntArray, T) -> T): NDStructure<T>

Maps elements from one structure to another one by applying transform to them alongside with their indices.

minus

common

open operator fun T.minus(arg: NDStructure<T>): NDStructure<T>

Subtracts an ND structure from an element of it.

open operator fun NDStructure<T>.minus(arg: T): NDStructure<T>

Subtracts an element from ND structure of it.

open operator fun NDStructure<T>.minus(b: NDStructure<T>): NDStructure<T>

Subtraction of two elements.

multiply

common

open override fun multiply(a: NDStructure<T>, b: NDStructure<T>): NDStructure<T>

Element-wise multiplication.

abstract fun multiply(a: NDStructure<T>, k: Number): NDStructure<T>

Multiplication of element by scalar.

plus

common

open operator fun T.plus(arg: NDStructure<T>): NDStructure<T>

Adds an element to ND structure of it.

open operator fun NDStructure<T>.plus(arg: T): NDStructure<T>

Adds an ND structure to an element of it.

open operator fun NDStructure<T>.plus(b: NDStructure<T>): NDStructure<T>

Addition of two elements.

produce

common

abstract fun produce(initializer: R.(IntArray) -> T): NDStructure<T>

Produces a new N structure using given initializer function.

times

common

open operator fun T.times(arg: NDStructure<T>): NDStructure<T>

Multiplies an element by a ND structure of it.

open operator fun NDStructure<T>.times(arg: T): NDStructure<T>

Multiplies an ND structure by an element of it.

open operator fun NDStructure<T>.times(b: NDStructure<T>): NDStructure<T>

Multiplies this element by scalar.

open operator fun Number.times(b: NDStructure<T>): NDStructure<T>

Multiplication of this number by element.

open operator fun NDStructure<T>.times(k: Number): NDStructure<T>

Multiplication of this element by a scalar.

toString

common

open fun toString(): String

unaryMinus

common

open operator fun NDStructure<T>.unaryMinus(): NDStructure<T>

The negation of this element.

unaryOperation

common

open fun unaryOperation(operation: String, arg: NDStructure<T>): NDStructure<T>

Dynamically invokes an unary operation with the certain name.

unaryOperationFunction

common

open override fun unaryOperationFunction(operation: String): (arg: NDStructure<T>) -> NDStructure<T>

Dynamically dispatches an unary operation with the certain name.

unaryPlus

common

open operator fun NDStructure<T>.unaryPlus(): NDStructure<T>

Returns this value.

Properties

elementContext

common

abstract val elementContext: R

The algebra over elements of ND structure.

one

common

abstract val one: NDStructure<T>

neutral operation for multiplication

shape

common

abstract val shape: IntArray

The shape of ND-structures this algebra operates on.

zero

common

abstract val zero: NDStructure<T>

The neutral element of addition.

Inheritors

BufferedNDRing

NDField