Export an algebra element, so it could be accessed even after algebra scope is closed. This method must be used on algebras where data is stored externally or any local algebra state is used. By default (if not overridden), exports the object itself.

getFeature

@UnstableKMathAPI

open fun <F : StructureFeature> getFeature(structure: StructureND<Double>, type: KClass<out F>): F?

Get a feature of the structure in this scope. Structure features take precedence other context features.

getFeature

@UnstableKMathAPI

inline fun <T : Any, F : StructureFeature> AlgebraND<T, *>.getFeature(structure: StructureND<T>): F?

Get a feature of the structure in this scope. Structure features take precedence other context features.

invoke

@PerformancePitfall

open operator fun (Double) -> Double.invoke(structure: StructureND<Double>): StructureND<Double>

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

open override fun ln(arg: StructureND<Double>): DoubleBufferND

Computes the natural logarithm (base e) of the value arg.

map

open override fun StructureND<Double>.map(transform: DoubleField.(Double) -> Double): BufferND<Double>

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

mapIndexed

@PerformancePitfall(message = "Very slow on remote execution algebras")

open fun StructureND<Double>.mapIndexed(transform: DoubleField.(index: IntArray, Double) -> Double): StructureND<Double>

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

mapInline

inline fun <T, A : Algebra<T>> BufferAlgebraND<T, A>.mapInline(arg: BufferND<T>, crossinline transform: A.(T) -> T): BufferND<T>

minus

open operator override fun Double.minus(arg: StructureND<Double>): StructureND<Double>

Subtracts an ND structure from an element of it.

open operator override fun StructureND<Double>.minus(arg: Double): StructureND<Double>

Subtracts an element from ND structure of it.

open operator override fun StructureND<Double>.minus(arg: StructureND<Double>): DoubleBufferND

Subtraction of two elements.

multiply

open override fun multiply(left: StructureND<Double>, right: StructureND<Double>): DoubleBufferND

Element-wise multiplication.

one

fun <T, A : Ring<T>> AlgebraND<T, A>.one(shape: ShapeND): StructureND<T>

@JvmName(name = "oneVarArg")

fun <T, A : Ring<T>> AlgebraND<T, A>.one(shapeFirst: Int, vararg shapeRest: Int): StructureND<T>

plus

open operator override fun Double.plus(arg: StructureND<Double>): StructureND<Double>

Adds an element to ND structure of it.

open operator override fun StructureND<Double>.plus(arg: Double): DoubleBufferND

Adds an ND structure to an element of it.

open operator override fun StructureND<Double>.plus(arg: StructureND<Double>): DoubleBufferND

Addition of two elements.

pow

open infix fun StructureND<Double>.pow(pow: Number): StructureND<Double>

Raises this value to the power pow.

power

open override fun power(arg: StructureND<Double>, pow: Number): StructureND<Double>

Raises arg to a power if possible (negative number could not be raised to a fractional power). Throws IllegalArgumentException if not possible.

scale

open override fun scale(a: StructureND<Double>, value: Double): DoubleBufferND

Scaling an element by a scalar.

sin

open override fun sin(arg: StructureND<Double>): DoubleBufferND

Computes the sine of arg.

sinh

open override fun sinh(arg: StructureND<Double>): DoubleBufferND

Computes the hyperbolic sine of arg.

sqrt

open fun sqrt(arg: StructureND<Double>): StructureND<Double>

Computes the square root of the value arg.

structureND

open override fun structureND(shape: ShapeND, initializer: DoubleField.(IntArray) -> Double): DoubleBufferND

Produces a new StructureND using given initializer function.

structureND

fun <T, A : Algebra<T>> BufferAlgebraND<T, A>.structureND(vararg shape: Int, initializer: A.(IntArray) -> T): BufferND<T>

fun <T, A : Algebra<T>> AlgebraND<T, A>.structureND(shapeFirst: Int, vararg shapeRest: Int, initializer: A.(IntArray) -> T): StructureND<T>

tan

open override fun tan(arg: StructureND<Double>): DoubleBufferND

Computes the tangent of arg.

tanh

open override fun tanh(arg: StructureND<Double>): DoubleBufferND

Computes the hyperbolic tangent of arg.

times

open operator override fun Number.times(arg: StructureND<Double>): DoubleBufferND

Multiplication of this number by element.

open operator override fun StructureND<Double>.times(k: Number): DoubleBufferND

Multiplication of this element by a scalar.

open operator override fun StructureND<Double>.times(arg: StructureND<Double>): DoubleBufferND

Multiplies this element by scalar.

open operator fun Double.times(arg: StructureND<Double>): StructureND<Double>

Multiplies an element by a ND structure of it.

open operator fun StructureND<Double>.times(arg: Double): StructureND<Double>

Multiplies an ND structure by an element of it.

toBufferND

open override fun StructureND<Double>.toBufferND(): DoubleBufferND

unaryMinus

open operator override fun StructureND<Double>.unaryMinus(): DoubleBufferND

The negation of this element.

unaryOperation

open fun unaryOperation(operation: String, arg: StructureND<Double>): StructureND<Double>

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

open override fun unaryOperationFunction(operation: String): (arg: StructureND<Double>) -> StructureND<Double>

Dynamically dispatches a unary operation with the certain name.

unaryPlus

open operator override fun StructureND<Double>.unaryPlus(): DoubleBufferND

Returns this value.

zero

fun <T, A : Group<T>> AlgebraND<T, A>.zero(shape: ShapeND): StructureND<T>

@JvmName(name = "zeroVarArg")

fun <T, A : Group<T>> AlgebraND<T, A>.zero(shapeFirst: Int, vararg shapeRest: Int): StructureND<T>

zip

open override fun zip(left: StructureND<Double>, right: StructureND<Double>, transform: DoubleField.(Double, Double) -> Double): BufferND<Double>

Combines two structures into one.

Properties

bufferAlgebra

open override val bufferAlgebra: BufferAlgebra<Double, DoubleField>

bufferFactory

open val bufferFactory: MutableBufferFactory<StructureND<Double>>

Provide a factory for buffers, associated with this Algebra

elementAlgebra

abstract val elementAlgebra: DoubleField

The algebra over elements of ND structure.

indexerBuilder

open override val indexerBuilder: (ShapeND) -> ShapeIndexer