kumulant/com.eignex.kumulant.schema/VFoldOp

VFoldOp

@Serializable

Reduction over the entire vector input. Distinct from element-level arithmetic (Add, Mul) - this collapses a DoubleArray of arbitrary length to a single scalar via the chosen operation.

Entries

Sum

Sum v[i].

Product

Product v[i].

Mean

Arithmetic mean of the vector entries. Empty input throws.

Min

Minimum entry. Empty input throws.

Max

Maximum entry. Empty input throws.

Norm2

Euclidean (L2) norm sqrt(Sum v[i]^2).

Properties

entries

val entries: EnumEntries<VFoldOp>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

expect val name: String

ordinal

expect val ordinal: Int

Functions

valueOf

fun valueOf(value: String): VFoldOp

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<VFoldOp>

Returns an array containing the constants of this enum type, in the order they're declared.

entries

val entries: EnumEntries<VFoldOp>(source)

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.

valueOf

fun valueOf(value: String): VFoldOp(source)

Throws

kotlin.IllegalArgumentException

if this enum type has no constant with the specified name

values

fun values(): Array<VFoldOp>(source)

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.