kmath-kotlingrad/space.kscience.kmath.kotlingrad/KMathNumber

KMathNumber

class KMathNumber<T : Number, A : NumericAlgebra<T>>(val algebra: A, val value: T) : SConst<KMathNumber<T, A>> (source)

Implements SConst by delegating its functionality to NumericAlgebra.

Parameters

The type of number.

The NumericAlgebra over T.

Constructors

KMathNumber

constructor(algebra: A, value: T)

Functions

apply

fun apply(op: Op): (SFun<KMathNumber<T, A>>) -> SFun<KMathNumber<T, A>>

fun apply(vararg xs: Fun<KMathNumber<T, A>>): SFun<KMathNumber<T, A>>

asString

open fun asString(): String

bind

open fun List<FunToAny<KMathNumber<T, A>>>.bind(): Bindings<KMathNumber<T, A>>

cos

open override fun cos(): SConst<KMathNumber<T, A>>

open fun <R : D1, C : D1> d(mVar: MVar<KMathNumber<T, A>, R, C>): MFun<KMathNumber<T, A>, R, C>

open fun d(v1: SVar<KMathNumber<T, A>>): SFun<KMathNumber<T, A>>

open fun <L : D1> d(vVar: VVar<KMathNumber<T, A>, L>): VFun<KMathNumber<T, A>, L>

div

open operator override fun div(divisor: SFun<KMathNumber<T, A>>): SFun<KMathNumber<T, A>>

operator fun div(divisor: Number): SFun<KMathNumber<T, A>>

equals

open operator override fun equals(other: Any?): Boolean

exp

fun exp(): SFun<KMathNumber<T, A>>

grad

open fun grad(): Map<SVar<KMathNumber<T, A>>, SFun<KMathNumber<T, A>>>

hashCode

open override fun hashCode(): Int

invoke

open operator override fun invoke(): SFun<KMathNumber<T, A>>

open operator override fun invoke(newBindings: Bindings<KMathNumber<T, A>>): SFun<KMathNumber<T, A>>

open operator override fun invoke(vararg funs: Fun<KMathNumber<T, A>>): SFun<KMathNumber<T, A>>

open operator override fun invoke(vararg numbers: Number): SFun<KMathNumber<T, A>>

open operator override fun invoke(vararg ps: FunToAny<KMathNumber<T, A>>): SFun<KMathNumber<T, A>>

isConstant

open fun isConstant(): Boolean

fun ln(): SFun<KMathNumber<T, A>>

log

open override fun log(base: SFun<KMathNumber<T, A>>): SFun<KMathNumber<T, A>>

minus

open operator fun minus(subtrahend: SFun<KMathNumber<T, A>>): SFun<KMathNumber<T, A>>

operator fun minus(subtrahend: Number): SFun<KMathNumber<T, A>>

plus

open operator override fun plus(addend: SFun<KMathNumber<T, A>>): SFun<KMathNumber<T, A>>

operator fun plus(addend: Number): SFun<KMathNumber<T, A>>

pow

open infix override fun pow(exponent: SFun<KMathNumber<T, A>>): SFun<KMathNumber<T, A>>

infix fun pow(exp: Number): SFun<KMathNumber<T, A>>

sin

open override fun sin(): SConst<KMathNumber<T, A>>

sqrt

open override fun sqrt(): SConst<KMathNumber<T, A>>

tan

open override fun tan(): SConst<KMathNumber<T, A>>

times

open operator override fun <R : D1, C : D1> times(multiplicand: MFun<KMathNumber<T, A>, R, C>): MFun<KMathNumber<T, A>, R, C>

open operator override fun times(multiplicand: SFun<KMathNumber<T, A>>): SFun<KMathNumber<T, A>>

open operator override fun <E : D1> times(multiplicand: VFun<KMathNumber<T, A>, E>): VFun<KMathNumber<T, A>, E>

operator fun times(multiplicand: Number): SFun<KMathNumber<T, A>>

toGate

open fun toGate(): Gate

toGraph

open fun toGraph(): ComputationGraph

toMst

fun <X : SFun<X>> SConst<X>.toMst(): MST.Numeric

Maps SVar to MST.Numeric directly.

fun <X : SFun<X>> SFun<X>.toMst(): MST

Maps SFun objects to MST. Some unsupported operations like Derivative are bound and converted then. Power operation is limited to constant right-hand side arguments.

toString

open override fun toString(): String

Returns a string representation of the value.

unaryMinus

open operator override fun unaryMinus(): SConst<KMathNumber<T, A>>

unaryPlus

open operator override fun unaryPlus(): SFun<KMathNumber<T, A>>

wrap

open override fun wrap(number: Number): KMathNumber<T, A>

Wraps Number to KMathNumber.

wrapOrError

open fun wrapOrError(any: Any): Fun<KMathNumber<T, A>>

Properties

algebra

val algebra: A

The algebra.

bindings

open val bindings: Bindings<KMathNumber<T, A>>

doubleValue

open val doubleValue: Double

val E: Special<KMathNumber<T, A>>

inputs

open override val inputs: Array<out Fun<KMathNumber<T, A>>>

ONE

val ONE: Special<KMathNumber<T, A>>

open override val op: Op

TWO

val TWO: Special<KMathNumber<T, A>>

value

open override val value: T

The value of this number.

ZERO

val ZERO: Special<KMathNumber<T, A>>