Pulse Documentation

name: op-agg-vec-sum
description: Per-member total of a vector — one sum per member, in member order.
kind: operator
category: AGG
operator: AGG_VEC_SUM
type: reference
applies_to: process, compose, predict
examples_tags: [multivariate, streaming-friendly]

Use when

Total of each item of a set of related fields, as one list per group.

Questions it answers:

• How many units of each of the six products did each store sell?
• What is the total spend per channel for every region, in one list?

Use something else:

• AGG_VEC_MEAN when you want each item’s average rather than its total.
• AGG_SUM when you want the total of a single field.

Params

• labels — inline fields only: one display label per member (default the member names).
• expand — true: one scalar column per member, <label>[<element label>], instead of the array (grouped: per row); the label is absent. Predict lists them (aggregations[i].columns). Element labels must be distinct.

Slot: exactly one of vector (a vectors entry, its labels kept) / fields; no field. Default label AGG_VEC_SUM_<vector>. Weight-aware: Σw·x per member.

Inputs

Members: u4…u64, f32/f64; source columns only.

Output

Rich []float64, one total per member; per-element missing data (a null member skips only that element). An element no row answered totals 0.

Components

Floor {n, n_null} — a row is present when ANY member answered (weighted adds sum_weights, n_eff, n_weight_invalid). Plus labels, element_n (raw per member), element_sum, element_sum_weights (weighted). Mergeable; streams; bit-identical for any worker count or shard split.

Gotchas

• Array-valued: refused (PROCESSING_CONFIG, reason array_valued) as a crosstab cell, a Sort key, a window or post-test input, an overlay host (request, Compose, whole-chain) and a chain stage feeding another.
• Expanded columns are presentation only — refused in the same places. A return path cannot name a bracketed column: keep them with data[*].<label>*.

See

• pulse_examples_search tags=[multivariate, streaming-friendly]
• Skills: op-agg-vec-mean, multivariate-design