Package space.kscience.kmath.operations

Types

Algebra

common

interface Algebra<T>

Represents an algebraic structure.

AlgebraElement

common

interface AlgebraElement<T, C : Algebra<T>>

The generic mathematics elements which is able to store its context

BigInt

common

class BigInt : Comparable<BigInt>

BigIntField

common

object BigIntField : Field<BigInt> , RingWithNumbers<BigInt>

Kotlin Multiplatform implementation of Big Integer numbers (KBigInteger).

ByteRing

common

object ByteRing : Ring<Byte> , Norm<Byte, Byte> , NumericAlgebra<Byte>

A field for Byte without boxing.

ExponentialOperations

common

interface ExponentialOperations<T> : Algebra<T>

A container for operations related to exp and ln functions.

ExtendedField

common

interface ExtendedField<T> : ExtendedFieldOperations<T> , Field<T> , NumericAlgebra<T>

Advanced Number-like field that implements basic operations.

ExtendedFieldOperations

common

interface ExtendedFieldOperations<T> : FieldOperations<T> , TrigonometricOperations<T> , HyperbolicOperations<T> , PowerOperations<T> , ExponentialOperations<T>

Advanced Number-like semifield that implements basic operations.

Field

common

interface Field<T> : Ring<T> , FieldOperations<T>

Represents field, i.e.

FieldElement

common

interface FieldElement<T : FieldElement<T, F>, F : Field<T>> : RingElement<T, F>

The element of Field.

FieldOperations

common

interface FieldOperations<T> : RingOperations<T>

Represents field without identity elements, i.e.

FloatField

common

object FloatField : ExtendedField<Float> , Norm<Float, Float>

A field for Float without boxing.

HyperbolicOperations

common

interface HyperbolicOperations<T> : Algebra<T>

A container for hyperbolic trigonometric operations for specific type.

IntRing

common

object IntRing : Ring<Int> , Norm<Int, Int> , NumericAlgebra<Int>

A field for Int without boxing.

JBigDecimalField

jvm

class JBigDecimalField(mathContext: MathContext) : JBigDecimalFieldBase

A field over BigDecimal.

JBigDecimalFieldBase

jvm

abstract class JBigDecimalFieldBase : Field<BigDecimal> , PowerOperations<BigDecimal> , NumericAlgebra<BigDecimal>

An abstract field over BigDecimal.

JBigIntegerField

jvm

object JBigIntegerField : Field<BigInteger> , NumericAlgebra<BigInteger>

A field over BigInteger.

KMathContext

common

@DslMarker()

annotation class KMathContext

Stub for DSL the Algebra is.

LongRing

common

object LongRing : Ring<Long> , Norm<Long, Long> , NumericAlgebra<Long>

A field for Double without boxing.

Magnitude

common

typealias Magnitude = UIntArray

Norm

common

interface Norm<in T : Any, out R>

A container for norm functional on element.

NumericAlgebra

common

interface NumericAlgebra<T> : Algebra<T>

An algebraic structure where elements can have numeric representation.

PowerOperations

common

interface PowerOperations<T> : Algebra<T>

A context extension to include power operations based on exponentiation.

RealField

common

object RealField : ExtendedField<Double> , Norm<Double, Double>

A field for Double without boxing.

Ring

common

interface Ring<T> : Space<T> , RingOperations<T>

Represents ring, i.e.

RingElement

common

interface RingElement<T : RingElement<T, R>, R : Ring<T>> : SpaceElement<T, R>

The element of Ring.

RingOperations

common

interface RingOperations<T> : SpaceOperations<T>

Represents rng, i.e.

RingWithNumbers

common

interface RingWithNumbers<T> : Ring<T> , NumericAlgebra<T>

A combination of NumericAlgebra and Ring that adds intrinsic simple operations on numbers like T+1 TODO to be removed and replaced by extensions after multiple receivers are there

ShortRing

common

object ShortRing : Ring<Short> , Norm<Short, Short> , NumericAlgebra<Short>

A field for Short without boxing.

Space

common

interface Space<T> : SpaceOperations<T>

Represents linear space with neutral element, i.e.

SpaceElement

common

interface SpaceElement<T : SpaceElement<T, S>, S : Space<T>> : AlgebraElement<T, S>

The element of Space.

SpaceOperations

common

interface SpaceOperations<T> : Algebra<T>

Represents linear space without neutral element, i.e.

TBase

common

typealias TBase = ULong

TrigonometricOperations

common

interface TrigonometricOperations<T> : Algebra<T>

A container for trigonometric operations for specific type.

Functions

abs

common

fun abs(x: BigInt): BigInt

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

Absolute of the comparable value

acos

common

fun <T : AlgebraElement<T, out TrigonometricOperations<T>>> acos(arg: T): T

Computes the inverse cosine of arg.

acosh

common

fun <T : AlgebraElement<T, out HyperbolicOperations<T>>> acosh(arg: T): T

Computes the inverse hyperbolic cosine of arg.

asin

common

fun <T : AlgebraElement<T, out TrigonometricOperations<T>>> asin(arg: T): T

Computes the inverse sine of arg.

asinh

common

fun <T : AlgebraElement<T, out HyperbolicOperations<T>>> asinh(arg: T): T

Computes the inverse hyperbolic sine of arg.

atan

common

fun <T : AlgebraElement<T, out TrigonometricOperations<T>>> atan(arg: T): T

Computes the inverse tangent of arg.

atanh

common

fun <T : AlgebraElement<T, out HyperbolicOperations<T>>> atanh(arg: T): T

Computes the inverse hyperbolic tangent of arg.

average

common

fun <T> Space<T>.average(data: Iterable<T>): T

Returns an average value of elements in the iterable in this Space.

fun <T> Space<T>.average(data: Sequence<T>): T

Returns an average value of elements in the sequence in this Space.

averageWith

common

fun <T> Iterable<T>.averageWith(space: Space<T>): T

Returns an average value of elements in the iterable in this Space.

fun <T> Sequence<T>.averageWith(space: Space<T>): T

Returns an average value of elements in the sequence in this Space.

bigInt

common

fun NDAlgebra.Companion.bigInt(vararg shape: Int): BufferedNDRing<BigInt, BigIntField>

inline fun Buffer.Companion.bigInt(size: Int, initializer: (Int) -> BigInt): Buffer<BigInt>

inline fun MutableBuffer.Companion.bigInt(size: Int, initializer: (Int) -> BigInt): MutableBuffer<BigInt>

bindSymbol

common

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

cos

common

fun <T : AlgebraElement<T, out TrigonometricOperations<T>>> cos(arg: T): T

Computes the cosine of arg.

cosh

common

fun <T : AlgebraElement<T, out HyperbolicOperations<T>>> cosh(arg: T): T

Computes the hyperbolic cosine of arg.

div

common

operator fun <T : AlgebraElement<T, F>, F : Field<T>> T.div(b: T): T

Divides this element by another one.

operator fun <T : AlgebraElement<T, S>, S : Space<T>> T.div(k: Number): T

Divides this element by number.

exp

common

fun <T : AlgebraElement<T, out ExponentialOperations<T>>> exp(arg: T): T

The identifier of exponential function.

invoke

common

inline operator fun <A : Algebra<*>, R> A.invoke(block: A.() -> R): R

Call a block with an Algebra as receiver.

common

fun <T : AlgebraElement<T, out ExponentialOperations<T>>> ln(arg: T): T

The identifier of natural logarithm.

minus

common

operator fun <T : AlgebraElement<T, S>, S : Space<T>> T.minus(b: T): T

Subtracts element from this one.

norm

common

fun <T : AlgebraElement<T, out Norm<T, R>>, R> norm(arg: T): R

Computes the norm of arg (i.e.

parseBigInteger

common

fun String.parseBigInteger(): BigInt?

Returns null if a valid number can not be read from a string

plus

common

operator fun <T : AlgebraElement<T, S>, S : Space<T>> T.plus(b: T): T

Adds element to this one.

pow

common

infix fun <T : AlgebraElement<T, out PowerOperations<T>>> T.pow(power: Double): T

Raises this element to the power pow.

power

common

fun <T> Field<T>.power(arg: T, power: Int): T

Raises arg to the integer power power.

fun <T> Ring<T>.power(arg: T, power: Int): T

Raises arg to the natural power power.

sin

common

fun <T : AlgebraElement<T, out TrigonometricOperations<T>>> sin(arg: T): T

Computes the sine of arg.

sinh

common

fun <T : AlgebraElement<T, out HyperbolicOperations<T>>> sinh(arg: T): T

Computes the hyperbolic sine of arg.

sqr

common

fun <T : AlgebraElement<T, out PowerOperations<T>>> sqr(arg: T): T

Computes the square of the value arg.

sqrt

common

fun <T : AlgebraElement<T, out PowerOperations<T>>> sqrt(arg: T): T

Computes the square root of the value arg.

sum

common

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

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

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

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

sumWith

common

fun <T> Iterable<T>.sumWith(space: Space<T>): T

Returns the sum of all elements in the iterable in provided space.

fun <T> Sequence<T>.sumWith(space: Space<T>): T

Returns the sum of all elements in the sequence in provided space.

tan

common

fun <T : AlgebraElement<T, out TrigonometricOperations<T>>> tan(arg: T): T

Computes the tangent of arg.

tanh

common

fun <T : AlgebraElement<T, out HyperbolicOperations<T>>> tanh(arg: T): T

Computes the hyperbolic tangent of arg.

times

common

operator fun <T : AlgebraElement<T, R>, R : Ring<T>> T.times(b: T): T

Multiplies this element by another one.

operator fun <T : AlgebraElement<T, S>, S : Space<T>> T.times(k: Number): T

Multiplies this element by number.

operator fun <T : AlgebraElement<T, S>, S : Space<T>> Number.times(element: T): T

Number times element

toBigInt

common

fun Int.toBigInt(): BigInt

Convert this Int to BigInt

fun Long.toBigInt(): BigInt

Convert this Long to BigInt

fun UInt.toBigInt(): BigInt

Convert UInt to BigInt

fun ULong.toBigInt(): BigInt

Convert ULong to BigInt

fun UIntArray.toBigInt(sign: Byte): BigInt

Create a BigInt with this array of magnitudes with protective copy