com.eignex.kumulant/schema/expr/VIndex

VIndex

@Serializable

@SerialName(value = "VIndex")

In element-wise feedback contexts (vector / regression / paired), returns the coordinate index of the currently evaluating element as a Double. Outside such contexts (primary is not an IndexedResult), raises IllegalStateException.

Branch on this with IfExpr/Eq to apply different sub-expressions per coordinate: IfExpr(VIndex eq 0.0, (X - Center) / Scale, X).

Functions

eval

open override 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.

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).

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.

plus

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

Build Add of two expressions.

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

Add a literal rhs to this expression.

pow

fun ScalarExpr.pow(exponent: ScalarExpr): ScalarExpr

This expression raised to exponent.

fun ScalarExpr.pow(exponent: Double): ScalarExpr

This expression raised to a constant exponent.

sqrt

fun ScalarExpr.sqrt(): ScalarExpr

Square root of this expression. A negative input gives NaN.

times

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

Build Mul of two expressions.

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

Multiply this expression by a literal rhs.

unaryMinus

operator fun ScalarExpr.unaryMinus(): ScalarExpr

Unary minus: wraps in Neg.