kmath-core/space.kscience.kmath.operations/ShortRing

ShortRing

object ShortRing : Ring<Short> , Norm<Short, Short> , NumericAlgebra<Short> (source)

A field for Short without boxing. Does not produce appropriate ring element.

Functions

fun <T : Comparable<T>> Group<T>.abs(value: T): T

Absolute of the comparable value

open inline override fun add(left: Short, right: Short): Short

Addition of two elements.

binaryOperation

open fun binaryOperation(operation: String, left: Short, right: Short): Short

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

open override fun binaryOperationFunction(operation: String): (left: Short, right: Short) -> Short

Dynamically dispatches a binary operation with the certain name.

open fun bindSymbol(value: String): Short

The same as bindSymbolOrNull but throws an error if symbol could not be bound

fun <T> Algebra<T>.bindSymbol(symbol: Symbol): T

bindSymbolOrNull

open fun bindSymbolOrNull(value: String): Short?

Wraps a raw string to T object. This method is designed for three purposes:

bindSymbolOrNull

fun <T> Algebra<T>.bindSymbolOrNull(symbol: Symbol): T?

@UnstableKMathAPI

open fun export(arg: Short): Short

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.

leftSideNumberOperation

open fun leftSideNumberOperation(operation: String, left: Number, right: Short): Short

Dynamically invokes a binary operation with the certain name with numeric first argument.

leftSideNumberOperationFunction

open fun leftSideNumberOperationFunction(operation: String): (left: Number, right: Short) -> Short

Dynamically dispatches a binary operation with the certain name with numeric first argument.

open inline operator override fun Short.minus(arg: Short): Short

Subtraction of two elements.

open inline override fun multiply(left: Short, right: Short): Short

Multiplies two elements.

open override fun norm(arg: Short): Short

Computes the norm of arg (i.e., absolute value or vector length).

open override fun number(value: Number): Short

Wraps a number to T object.

open inline operator override fun Short.plus(arg: Short): Short

Addition of two elements.

open fun power(arg: Short, pow: UInt): Short

Raises arg to the integer power pow.

rightSideNumberOperation

open fun rightSideNumberOperation(operation: String, left: Short, right: Number): Short

Dynamically invokes a binary operation with the certain name with numeric second argument.

rightSideNumberOperationFunction

open fun rightSideNumberOperationFunction(operation: String): (left: Short, right: Number) -> Short

Dynamically dispatches a binary operation with the certain name with numeric first argument.

fun <T> Group<T>.sum(data: Iterable<T>): T

@PerformancePitfall(message = "Potential boxing access to buffer elements")

fun <T> Group<T>.sum(data: Buffer<T>): T

Returns the sum of all elements in the iterable in this Group.

fun <T> Group<T>.sum(data: Sequence<T>): T

Returns the sum of all elements in the sequence in this Group.

open inline operator override fun Short.times(arg: Short): Short

Multiplies this element by scalar.

open inline operator override fun Short.unaryMinus(): Short

The negation of this element.

open fun unaryOperation(operation: String, arg: Short): Short

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

open override fun unaryOperationFunction(operation: String): (arg: Short) -> Short

Dynamically dispatches a unary operation with the certain name.

open operator fun Short.unaryPlus(): Short

Returns this value.

inline fun <R> ShortRing.withNdAlgebra(vararg shape: Int, action: ShortRingND.() -> R): R

Properties

val ShortRing.bufferAlgebra: BufferRingOps<Short, ShortRing>

open override val bufferFactory: MutableBufferFactory<Short>

Provide a factory for buffers, associated with this Algebra

val <T> NumericAlgebra<T>.e: T

The e mathematical constant.

open override val one: Short

The neutral element of multiplication

val <T> NumericAlgebra<T>.pi: T

The π mathematical constant.

open override val zero: Short

The neutral element of addition.