com.eignex.kumulant/schema/expr/ScalarExpr

ScalarExpr

@Serializable(with = ScalarExprSerializer::class)

Wire-serialisable scalar expression over per-update inputs:

x: series value or paired x-axis; unused for regression.
y: paired y-axis or regression response.
v: vector input or regression features.
primary: feedback snapshot; Center, Scale, Low, and High read its traits. Per-coordinate feedback uses IndexedResult to carry the coordinate index.

Unused inputs default to 0.0, an empty array, or null. Compose with DSL operators such as X * 2.0, X gt 0.0, and ifThenElse.

JSON uses operator keys, numeric literals, and named references: {"add":[{"ref":"value"},1]}. Resolve Ref nodes with bind and serialize through ScalarExpr, BoolExpr, or VectorExpr. Other formats use sealed-class tags.

Inheritors

Functions

eval

open fun eval(x: Double, y: Double = 0.0, v: DoubleArray = EMPTY_VECTOR, primary: Result? = null): Double(source)

Evaluate this expression against the per-update inputs. See the class KDoc for the input-environment convention.

abs

fun ScalarExpr.abs(): ScalarExpr

Absolute value of this expression.

bind

fun ScalarExpr.bind(bindings: Map<String, ScalarExpr>): ScalarExpr

Bind every reference eagerly, preserving the tree's grouping and retaining the scope on the wire.

div

operator fun ScalarExpr.div(rhs: ScalarExpr): ScalarExpr

Build Div of two expressions.

operator fun ScalarExpr.div(rhs: Double): ScalarExpr

Divide this expression by a literal rhs.

infix fun ScalarExpr.eq(rhs: ScalarExpr): BoolExpr

Exact equality (no tolerance).

infix fun ScalarExpr.eq(rhs: Double): BoolExpr

Exact equality against a literal (no tolerance).

eval

fun ScalarExpr.eval(x: Double = 0.0, y: Double = 0.0, v: Vector, primary: Result? = null): Double

Evaluate this scalar expression against a borrowed KoBLAS vector without materialising it.

exp

fun ScalarExpr.exp(): ScalarExpr

e raised to this expression. Overflows to +Infinity well before Double runs out of range.

infix fun ScalarExpr.ge(rhs: ScalarExpr): BoolExpr

Greater-or-equal comparison.

infix fun ScalarExpr.ge(rhs: Double): BoolExpr

Greater-or-equal against a literal.

infix fun ScalarExpr.gt(rhs: ScalarExpr): BoolExpr

Strictly-greater-than comparison.

infix fun ScalarExpr.gt(rhs: Double): BoolExpr

Strictly-greater-than against a literal.

inRange

fun ScalarExpr.inRange(min: Double, max: Double): BoolExpr

True when this expression falls within [min, max], both ends inclusive.

isFinite

fun ScalarExpr.isFinite(): BoolExpr

True when this expression evaluates to a finite number: not NaN, and not an infinity.

isNaN

fun ScalarExpr.isNaN(): BoolExpr

True when this expression evaluates to NaN.

infix fun ScalarExpr.le(rhs: ScalarExpr): BoolExpr

Less-or-equal comparison.

infix fun ScalarExpr.le(rhs: Double): BoolExpr

Less-or-equal against a literal.

fun ScalarExpr.ln(): ScalarExpr

Natural logarithm of this expression. ln(0) is -Infinity and a negative input gives NaN.

infix fun ScalarExpr.lt(rhs: ScalarExpr): BoolExpr

Strictly-less-than comparison.

infix fun ScalarExpr.lt(rhs: Double): BoolExpr

Strictly-less-than against a literal.

max

fun ScalarExpr.max(other: ScalarExpr): ScalarExpr

The larger of this expression and other.

fun ScalarExpr.max(other: Double): ScalarExpr

The larger of this expression and a constant other.

min

fun ScalarExpr.min(other: ScalarExpr): ScalarExpr

The smaller of this expression and other.

fun ScalarExpr.min(other: Double): ScalarExpr

The smaller of this expression and a constant other.

minus

operator fun ScalarExpr.minus(rhs: ScalarExpr): ScalarExpr

Build Sub of two expressions.

operator fun ScalarExpr.minus(rhs: Double): ScalarExpr

Subtract a literal rhs from this expression.

infix fun ScalarExpr.ne(rhs: ScalarExpr): BoolExpr

Exact inequality, the negation of eq under IEEE 754: true when either side is NaN, and false for 0.0 against -0.0. It builds !(this eq rhs), which encodes with the portable not and eq.