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

FloatField

object FloatField : ExtendedField<Float> , Norm<Float, Float> (source)

A field for Float 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: Float): Float

Computes the inverse cosine of arg.

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

Computes the inverse hyperbolic cosine of arg.

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

Addition of two elements.

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

Computes the inverse sine of arg.

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

Computes the inverse hyperbolic sine of arg.

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

Computes the inverse tangent of arg.

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

Computes the inverse hyperbolic tangent of arg.

binaryOperation

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

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

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

Dynamically dispatches a binary operation with the certain name.

open fun bindSymbol(value: String): Float

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

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: Float): Float

Computes the cosine of arg.

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

Computes the hyperbolic cosine of arg.

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

Division of two elements.

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

Division of this element by scalar.

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

Division of two elements.

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

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

@UnstableKMathAPI

open fun export(arg: Float): Float

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: Float): Float

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

leftSideNumberOperationFunction

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

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

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

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

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

Subtraction of two elements.

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

Multiplies two elements.

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

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

open override fun number(value: Number): Float

Wraps a number to T object.

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

Addition of two elements.

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

Raises this value to the power pow.

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

open inline override fun power(arg: Float, pow: Number): Float

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: Float, pow: UInt): Float

Raises arg to the integer power pow.

rightSideNumberOperation

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

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

rightSideNumberOperationFunction

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

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

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

Scaling an element by a scalar.

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

Computes the sine of arg.

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

Computes the hyperbolic sine of arg.

open inline override fun sqrt(arg: Float): Float

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: Float): Float

Computes the tangent of arg.

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

Computes the hyperbolic tangent of arg.

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

Multiplies this element by scalar.

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

Multiplication of this element by a scalar.

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

Multiplication of this number by element.

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

The negation of this element.

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

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

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

Dynamically dispatches a unary operation with the certain name.

open operator fun Float.unaryPlus(): Float

Returns this value.

Properties

open override val bufferFactory: MutableBufferFactory<Float>

Provide a factory for buffers, associated with this Algebra

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

The e mathematical constant.

open override val one: Float

The neutral element of multiplication

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

The π mathematical constant.

open override val zero: Float

The neutral element of addition.