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

JBigDecimalField

class JBigDecimalField(mathContext: MathContext) : JBigDecimalFieldBase

A field over BigDecimal.

Constructors

JBigDecimalField

fun JBigDecimalField(mathContext: MathContext = MathContext.DECIMAL64)

Types

object Companion : JBigDecimalFieldBase

Functions

open override fun add(left: BigDecimal, right: BigDecimal): BigDecimal

Addition of two elements.

binaryOperation

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

Dynamically invokes a binary operation with the certain name.

binaryOperationFunction

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

Dynamically dispatches a binary operation with the certain name.

open fun bindSymbol(value: String): BigDecimal

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

bindSymbolOrNull

open fun bindSymbolOrNull(value: String): BigDecimal?

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

open operator fun BigDecimal.div(arg: BigDecimal): BigDecimal

Division of two elements.

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

Division of this element by scalar.

open override fun divide(left: BigDecimal, right: BigDecimal): BigDecimal

Division of two elements.

@UnstableKMathAPI

open fun export(arg: BigDecimal): BigDecimal

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

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

leftSideNumberOperationFunction

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

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

open operator override fun BigDecimal.minus(arg: BigDecimal): BigDecimal

Subtraction of two elements.

open override fun multiply(left: BigDecimal, right: BigDecimal): BigDecimal

Multiplies two elements.

open override fun number(value: Number): BigDecimal

Wraps a number to T object.

open operator fun BigDecimal.plus(arg: BigDecimal): BigDecimal

Addition of two elements.

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

Raises this value to the power pow.

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

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

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

Raises arg to the integer power pow.

rightSideNumberOperation

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

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

rightSideNumberOperationFunction

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

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

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

Scaling an element by a scalar.

open override fun sqrt(arg: BigDecimal): BigDecimal

Computes the square root of the value arg.

open operator fun BigDecimal.times(arg: BigDecimal): BigDecimal

Multiplies this element by scalar.

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

Multiplication of this element by a scalar.

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

Multiplication of this number by element.

open operator override fun BigDecimal.unaryMinus(): BigDecimal

The negation of this element.

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

Dynamically invokes a unary operation with the certain name.

unaryOperationFunction

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

Dynamically dispatches a unary operation with the certain name.

open operator fun BigDecimal.unaryPlus(): BigDecimal

Returns this value.

Properties

open override val one: BigDecimal

The neutral element of multiplication

open override val zero: BigDecimal

The neutral element of addition.

Sources