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

DoubleField

object DoubleField : ExtendedField<Double> , Norm<Double, Double> , ScaleOperations<Double> (source)

A field for Double without boxing. Does not produce appropriate field element.

Functions

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

Absolute of the comparable value

open inline override fun acos(arg: Double): Double

Computes the inverse cosine of arg.

open inline override fun acosh(arg: Double): Double

Computes the inverse hyperbolic cosine of arg.

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

Addition of two elements.

open inline override fun asin(arg: Double): Double

Computes the inverse sine of arg.

open inline override fun asinh(arg: Double): Double

Computes the inverse hyperbolic sine of arg.

open inline override fun atan(arg: Double): Double

Computes the inverse tangent of arg.

open inline override fun atanh(arg: Double): Double

Computes the inverse hyperbolic tangent of arg.

binaryOperation

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

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

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

Dynamically dispatches a binary operation with the certain name.

open fun bindSymbol(value: String): Double

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): Double?

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

bindSymbolOrNull

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

open inline override fun cos(arg: Double): Double

Computes the cosine of arg.

open inline override fun cosh(arg: Double): Double

Computes the hyperbolic cosine of arg.

open inline operator override fun Double.div(arg: Double): Double

Division of two elements.

open operator fun Double.div(k: Number): Double

Division of this element by scalar.

open inline override fun divide(left: Double, right: Double): Double

Division of two elements.

open inline override fun exp(arg: Double): Double

Computes Euler's number e raised to the power of the value arg.

@UnstableKMathAPI

open fun export(arg: Double): Double

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.

inline fun DoubleField.expression(block: FunctionalExpressionExtendedField<Double, DoubleField>.() -> Expression<Double>): Expression<Double>

leftSideNumberOperation

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

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

leftSideNumberOperationFunction

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

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

open inline override fun ln(arg: Double): Double

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

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

Subtraction of two elements.

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

Multiplies two elements.

fun DoubleField.ndAlgebra(vararg shape: Int): DoubleFieldND

fun DoubleField.ndAlgebra(shape: ShapeND): DoubleFieldND

open inline override fun norm(arg: Double): Double

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

open inline override fun number(value: Number): Double

Wraps a number to T object.

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

Addition of two elements.

open infix fun Double.pow(pow: Number): Double

Raises this value to the power pow.

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

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

open fun power(arg: Double, pow: Int): Double

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

Raises arg to the integer power pow.

rightSideNumberOperation

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

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

rightSideNumberOperationFunction

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

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

open inline override fun scale(a: Double, value: Double): Double

Scaling an element by a scalar.

open inline override fun sin(arg: Double): Double

Computes the sine of arg.

open inline override fun sinh(arg: Double): Double

Computes the hyperbolic sine of arg.

open override fun sqrt(arg: Double): Double

Computes the square root of the value arg.

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 override fun tan(arg: Double): Double

Computes the tangent of arg.

open inline override fun tanh(arg: Double): Double

Computes the hyperbolic tangent of arg.

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

Multiplies this element by scalar.

open operator fun Double.times(k: Number): Double

Multiplication of this element by a scalar.

open operator fun Number.times(arg: Double): Double

Multiplication of this number by element.

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

The negation of this element.

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

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

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

Dynamically dispatches a unary operation with the certain name.

open operator fun Double.unaryPlus(): Double

Returns this value.

@UnstableKMathAPI

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

Produce a context for n-dimensional operations inside this real field

Properties

open override val bufferFactory: MutableBufferFactory<Double>

Provide a factory for buffers, associated with this Algebra

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

The e mathematical constant.

val DoubleField.linearSpace: DoubleLinearSpace

val DoubleField.ndAlgebra: DoubleFieldOpsND

open override val one: Double

The neutral element of multiplication

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

The π mathematical constant.

open override val zero: Double

The neutral element of addition.