stream-charts 1.2.0 → 2.0.0

package/dist/app/charts/series/baseSeries.js

@@ -1,36 +1,81 @@
 import { failureResult, successResult } from "result-fn";
+import { FastShiftArray } from "fast-shift-array";
+/**
+ * Default number of shifts a series' backing `FastShiftArray` accumulates before it's compacted,
+ * used whenever a caller doesn't specify one explicitly. This is deliberately much lower than
+ * `FastShiftArray`'s own default of 100,000: compaction is a single, blocking O(n) operation (it
+ * splices out all the accumulated dead slots in one call), so with the default threshold, a
+ * long-running streaming chart hits one large, very perceptible stutter once cumulative shifts
+ * cross 100,000 -- visible as a sudden jump/lag rather than a gradual slowdown. Compacting more
+ * often, on a much smaller batch each time, trades that one large pause for many much smaller
+ * (and much less noticeable) ones spread across the session.
+ *
+ * If a particular use case genuinely prefers fewer, larger pauses (e.g. a non-interactive/batch
+ * context where per-call overhead matters more than pause smoothness), pass a larger
+ * `compactingSize` explicitly to `seriesFrom`/`emptySeries`/`emptySeriesFor`.
+ */
+export const DEFAULT_COMPACTING_SIZE = 10000;
 /**
  * Creates a series from the name and the optional array of `Datum`.
+ *
+ * **Ownership warning:** when `data` is a plain array (or already a {@link FastShiftArray}), it is
+ * wrapped **by reference**, not copied -- the returned series' backing storage *is* that same
+ * array/`FastShiftArray`. As the chart streams in new data and ages old data out, the library calls
+ * `shift()` on it (clearing the head slot, and periodically `splice`-ing it during compaction),
+ * mutating it in place. If you keep your own reference to the array you pass in (to reuse,
+ * snapshot, or compare later), you will see it change out from under you. If you need an
+ * independent copy, pass `data.slice()` instead -- see e.g. `StreamingBarChart.tsx`,
+ * `StreamingRasterChart.tsx`, and `StreamingPoincareChart.tsx`, which all do this when re-deriving
+ * initial series from data they still hold a reference to elsewhere.
  * @param name The name of the series (i.e. neuron)
  * @param data The array of datum, which could be `(t, f(t))`, or `(f[n](x), f[n+1](x))`
- * @return A {@link BaseSeries} for object that can be used by in {@link Chart}s
+ * @param compactingSize The number of shifts the series' backing array accumulates before it's
+ * compacted (see {@link DEFAULT_COMPACTING_SIZE}). Only applies when `data` is a plain array (and
+ * so a new `FastShiftArray` is created for it) -- ignored when `data` is already a `FastShiftArray`,
+ * since compaction size is fixed at that instance's own construction time.
+ * @return A {@link BaseSeries} that can be used in {@link Chart}s
  * @see seriesFromTuples
  * @see emptySeries
  */
-export function seriesFrom(name, data = []) {
+export function seriesFrom(name, data = [], compactingSize = DEFAULT_COMPACTING_SIZE) {
+    // `backing` is the single source of truth stored in `.data` below -- `last`/`length`/`isEmpty`
+    // must close over this (not the original `data` param) so they go through FastShiftArray's own
+    // headIndex-aware accessors. When `data` is a plain array, `FastShiftArray.fromArray` wraps it
+    // by reference rather than copying, so reading `data.length` directly (the old behavior) read
+    // the raw backing array's physical length, which `shift()` never shrinks -- it only advances
+    // an internal headIndex.
+    const backing = data instanceof Array ?
+        FastShiftArray.fromArray(data, true, compactingSize) :
+        data;
     return {
         name: name,
-        data: data,
-        last: () => data ? (data.length > 0 ? successResult(data[data.length - 1]) : failureResult("Data is empty")) : failureResult("Data is not defined"),
-        length: () => data ? data.length : 0,
-        isEmpty: () => data ? data.length === 0 : true
+        data: backing,
+        last: () => backing.length > 0 ?
+            successResult(backing[backing.length - 1]) :
+            failureResult("Data is empty"),
+        length: () => backing.length,
+        isEmpty: () => backing.length === 0
     };
 }
 /**
  * Returns an empty series with the specified name
  * @param name The name of the series
+ * @param compactingSize The number of shifts the series' backing array accumulates before it's
+ * compacted (see {@link DEFAULT_COMPACTING_SIZE})
  * @return The empty series
  * @see seriesFrom
  * @see seriesFromTuples
  */
-export const emptySeries = (name) => seriesFrom(name);
+export const emptySeries = (name, compactingSize = DEFAULT_COMPACTING_SIZE) => seriesFrom(name, [], compactingSize);
 /**
  * Creates an array of empty series, one for each specified name
  * @param names The names for each of the empty series
+ * @param compactingSize The number of shifts each series' backing array accumulates before it's
+ * compacted (see {@link DEFAULT_COMPACTING_SIZE})
  * @return An array of empty series with the specified names
  * @see emptySeries
  * @see seriesFrom
  * @see seriesFromTuples
  */
-export const emptySeriesFor = (names) => names.map(name => seriesFrom(name));
+export const emptySeriesFor = (names, compactingSize = DEFAULT_COMPACTING_SIZE) => names.map(name => seriesFrom(name, [], compactingSize));
 //# sourceMappingURL=baseSeries.js.map

package/dist/app/charts/series/baseSeries.js.map

@@ -1 +1 @@
-{"version":3,"file":"baseSeries.js","sourceRoot":"","sources":["../../../../src/app/charts/series/baseSeries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAU,aAAa,EAAC,MAAM,WAAW,CAAC;AAc/D;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CAAI,IAAY,EAAE,OAAiB,EAAE;IAC3D,OAAO;QACH,IAAI,EAAE,IAAI;QACV,IAAI,EAAE,IAAI;QACV,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAY,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAY,eAAe,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,CAAY,qBAAqB,CAAC;QACpL,MAAM,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;QACpC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI;KACjD,CAAA;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAI,IAAY,EAAiB,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AAEhF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAI,KAAoB,EAAwB,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAA"}
+{"version":3,"file":"baseSeries.js","sourceRoot":"","sources":["../../../../src/app/charts/series/baseSeries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,aAAa,EAAe,aAAa,EAAC,MAAM,WAAW,CAAC;AACpE,OAAO,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAC;AA+BhD;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAM,CAAA;AAE7C;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,UAAU,CACtB,IAAY,EACZ,OAAqC,EAAE,EACvC,iBAAyB,uBAAuB;IAEhD,+FAA+F;IAC/F,+FAA+F;IAC/F,+FAA+F;IAC/F,8FAA8F;IAC9F,6FAA6F;IAC7F,yBAAyB;IACzB,MAAM,OAAO,GAAsB,IAAI,YAAY,KAAK,CAAC,CAAC;QACtD,cAAc,CAAC,SAAS,CAAI,IAAI,EAAE,IAAI,EAAE,cAAc,CAAC,CAAC,CAAC;QACzD,IAAI,CAAA;IACR,OAAO;QACH,IAAI,EAAE,IAAI;QACV,IAAI,EAAE,OAAO;QACb,IAAI,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;YAC5B,aAAa,CAAY,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;YACvD,aAAa,CAAY,eAAe,CAAC;QAC7C,MAAM,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM;QAC5B,OAAO,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC;KACtC,CAAA;AACL,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAI,IAAY,EAAE,iBAAyB,uBAAuB,EAAiB,EAAE,CAC5G,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC;AAEzC;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAI,KAAoB,EAAE,iBAAyB,uBAAuB,EAAwB,EAAE,CAC9H,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,EAAE,EAAE,EAAE,cAAc,CAAC,CAAC,CAAA"}

package/dist/app/charts/series/iterateSeries.d.ts

@@ -1,4 +1,4 @@
-import { BaseSeries } from "./baseSeries";
+import { type BaseSeries } from "./baseSeries";
 /**
  * An immutable datum object that holds the iterate `(f[n](x), f[n+1](x))` with an
  * informational time
@@ -9,7 +9,7 @@ export interface IterateDatum {
     readonly iterateN_1: number;
 }
 /**
- * Creates an empty iterate datum
+ * An empty iterate datum (its time and iterates are all `NaN`)
  */
 export declare const emptyIterateDatum: IterateDatum;
 /**
@@ -21,10 +21,10 @@ export declare const emptyIterateDatum: IterateDatum;
  */
 export declare const iterateDatumOf: (time: number, iterateN: number, iterateN_1: number) => IterateDatum;
 /**
- * Returns whether the iterate datum is considered empty. An iterate datum is considered
- * empty when the time, `f[n](x)`, `f[n+1](x)` values are all `NaN`
+ * Returns whether the iterate datum is non-empty. An iterate datum is considered empty when any
+ * of its time, `f[n](x)`, and `f[n+1](x)` values is `NaN`
  * @param datum The iterate datum to test
- * @return `true` if the iterate datum is empty; `false` otherwise
+ * @return `true` if the iterate datum is non-empty (none of its values is `NaN`); `false` otherwise
  */
 export declare const nonEmptyIterateDatum: (datum: IterateDatum) => boolean;
 /**
@@ -32,11 +32,12 @@ export declare const nonEmptyIterateDatum: (datum: IterateDatum) => boolean;
  */
 export type IterateSeries = BaseSeries<IterateDatum>;
 /**
- * Creates a series from the name and the optional array of (x, y) pairs (tuples)
+ * Creates a series from the name and the optional array of `(time, f[n](x), f[n+1](x))` tuples
  * @param name The name of the series
- * @param data The optional array of (x, y) pairs (tuples)
- * @return A `Series` for object that can be used by the `PoincarePlot`
+ * @param data The optional array of `(time, f[n](x), f[n+1](x))` tuples
+ * @return An {@link IterateSeries} that can be used by the `PoincarePlot`
  * @see seriesFrom
  * @see emptySeries
  */
 export declare const iterateSeriesFromTuples: (name: string, data?: Array<[number, number, number]>) => IterateSeries;
+//# sourceMappingURL=iterateSeries.d.ts.map

package/dist/app/charts/series/iterateSeries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iterateSeries.d.ts","sourceRoot":"","sources":["../../../../src/app/charts/series/iterateSeries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,UAAU,EAAa,MAAM,cAAc,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;CAC9B;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,YAA0D,CAAA;AAE1F;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,MAAM,MAAM,EAAE,UAAU,MAAM,EAAE,YAAY,MAAM,KAAG,YAIlF,CAAA;AAEF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAAI,OAAO,YAAY,KAAG,OACiB,CAAA;AAE5E;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,YAAY,CAAC,CAAA;AAEpD;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,GAAI,MAAM,MAAM,EAAE,OAAM,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAM,KAAG,aACrB,CAAA"}

package/dist/app/charts/series/iterateSeries.js

@@ -1,6 +1,6 @@
 import { seriesFrom } from "./baseSeries";
 /**
- * Creates an empty iterate datum
+ * An empty iterate datum (its time and iterates are all `NaN`)
  */
 export const emptyIterateDatum = { time: NaN, iterateN: NaN, iterateN_1: NaN };
 /**
@@ -16,17 +16,17 @@ export const iterateDatumOf = (time, iterateN, iterateN_1) => ({
     iterateN_1
 });
 /**
- * Returns whether the iterate datum is considered empty. An iterate datum is considered
- * empty when the time, `f[n](x)`, `f[n+1](x)` values are all `NaN`
+ * Returns whether the iterate datum is non-empty. An iterate datum is considered empty when any
+ * of its time, `f[n](x)`, and `f[n+1](x)` values is `NaN`
  * @param datum The iterate datum to test
- * @return `true` if the iterate datum is empty; `false` otherwise
+ * @return `true` if the iterate datum is non-empty (none of its values is `NaN`); `false` otherwise
  */
 export const nonEmptyIterateDatum = (datum) => !isNaN(datum.time) && !isNaN(datum.iterateN) && !isNaN(datum.iterateN_1);
 /**
- * Creates a series from the name and the optional array of (x, y) pairs (tuples)
+ * Creates a series from the name and the optional array of `(time, f[n](x), f[n+1](x))` tuples
  * @param name The name of the series
- * @param data The optional array of (x, y) pairs (tuples)
- * @return A `Series` for object that can be used by the `PoincarePlot`
+ * @param data The optional array of `(time, f[n](x), f[n+1](x))` tuples
+ * @return An {@link IterateSeries} that can be used by the `PoincarePlot`
  * @see seriesFrom
  * @see emptySeries
  */

package/dist/app/charts/series/iterateSeries.js.map

@@ -1 +1 @@
-{"version":3,"file":"iterateSeries.js","sourceRoot":"","sources":["../../../../src/app/charts/series/iterateSeries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAC,MAAM,cAAc,CAAC;AAYpD;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAiB,EAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAC,CAAA;AAE1F;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,QAAgB,EAAE,UAAkB,EAAgB,EAAE,CAAC,CAAC;IACjG,IAAI;IACJ,QAAQ;IACR,UAAU;CACb,CAAC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAmB,EAAW,EAAE,CACjE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;AAO5E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,IAAY,EAAE,OAAwC,EAAE,EAAiB,EAAE,CAC/G,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA"}
+{"version":3,"file":"iterateSeries.js","sourceRoot":"","sources":["../../../../src/app/charts/series/iterateSeries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,UAAU,EAAC,MAAM,cAAc,CAAC;AAYzD;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAiB,EAAC,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,EAAC,CAAA;AAE1F;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,QAAgB,EAAE,UAAkB,EAAgB,EAAE,CAAC,CAAC;IACjG,IAAI;IACJ,QAAQ;IACR,UAAU;CACb,CAAC,CAAA;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAmB,EAAW,EAAE,CACjE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;AAO5E;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,IAAY,EAAE,OAAwC,EAAE,EAAiB,EAAE,CAC/G,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,CAAA"}

package/dist/app/charts/series/ordinalSeries.d.ts

@@ -1,5 +1,5 @@
-import { BaseSeries } from "./baseSeries";
-import { OrdinalChartData, OrdinalStats } from "../observables/ordinals";
+import { type BaseSeries } from "./baseSeries";
+import { type OrdinalChartData, type OrdinalStats } from "../observables/ordinals";
 /**
  * An immutable datum object for series with a category and value.
  * This could be a series of (ordinal, value) where the category runs
@@ -12,24 +12,28 @@ export interface OrdinalDatum {
     readonly value: number;
 }
 /**
- * Creates an empty ordinal datum
+ * An empty ordinal datum (`NaN` time and value, and an empty ordinal)
  */
 export declare const emptyOrdinalDatum: OrdinalDatum;
+/**
+ * Copies an ordinal datum
+ * @param datum The datum to copy
+ * @return The copy
+ */
 export declare const copyOrdinalDatum: (datum: OrdinalDatum) => OrdinalDatum;
 /**
- * Creates an iterate datum
+ * Creates an ordinal datum
  * @param time The datum time, which is mostly informational
  * @param ordinal The category name or identifier
  * @param value The value
- * @return An iterate datum
+ * @return An ordinal datum
  */
 export declare const ordinalDatumOf: (time: number, ordinal: string, value: number) => OrdinalDatum;
 /**
- * Returns whether the ordinal datum is empty. An ordinal datum is considered empty
- * when the time is NaN, the ordinal is blank (empty or only whitespace), and the value
- * is NaN.
- * @param datum The iterate datum to test
- * @return `true` if the iterate datum is empty; `false` otherwise
+ * Returns whether the ordinal datum is non-empty. An ordinal datum is considered empty when its
+ * time is NaN, its ordinal is blank (empty or only whitespace), or its value is NaN.
+ * @param datum The ordinal datum to test
+ * @return `true` if the ordinal datum is non-empty; `false` otherwise
  */
 export declare const nonEmptyOrdinalDatum: (datum: OrdinalDatum) => boolean;
 /**
@@ -46,9 +50,19 @@ export type OrdinalSeries = BaseSeries<OrdinalDatum>;
  */
 export declare function ordinateSeriesFromTuples(name: string, data?: Array<[time: number, ordinal: string, value: number]>): OrdinalSeries;
 /**
- * Creates an empty chart data object with all the values set to 0
- * @param seriesList The list of series names (identifiers) to update
- * @return An empty chart data object
+ * Creates the ordinal chart data for the specified series: their names, the stats calculated over
+ * their data (see {@link calculateOrdinalStats}), and copies of all their data as the new points
+ * @param seriesList The series
+ * @return The ordinal chart data for the series
  */
 export declare function initialOrdinalChartData(seriesList: Array<OrdinalSeries>): OrdinalChartData;
+/**
+ * Calculates the stats of the specified series: the data with the min and max time, and with the
+ * min and max value, over all the series, and each series' value stats (its min, max, count, sum,
+ * sum of squares, and mean)
+ * @param seriesList The series
+ * @return The stats (when there's no data, the extremes are the initial ones that searches start
+ * from -- see e.g. `initialMinTimeDatum`)
+ */
 export declare function calculateOrdinalStats(seriesList: Array<OrdinalSeries>): OrdinalStats;
+//# sourceMappingURL=ordinalSeries.d.ts.map

package/dist/app/charts/series/ordinalSeries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ordinalSeries.d.ts","sourceRoot":"","sources":["../../../../src/app/charts/series/ordinalSeries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,UAAU,EAAa,MAAM,cAAc,CAAC;AACzD,OAAO,EAIH,KAAK,gBAAgB,EACrB,KAAK,YAAY,EAEpB,MAAM,yBAAyB,CAAC;AAGjC;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IACzB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACzB;AAGD;;GAEG;AACH,eAAO,MAAM,iBAAiB,EAAE,YAI/B,CAAA;AAED;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAAI,OAAO,YAAY,KAAG,YAIrD,CAAA;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,cAAc,GAAI,MAAM,MAAM,EAAE,SAAS,MAAM,EAAE,OAAO,MAAM,KAAG,YAI5E,CAAA;AAGF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,GAAI,OAAO,YAAY,KAAG,OACiC,CAAA;AAE5F;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,YAAY,CAAC,CAAA;AAEpD;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CACpC,IAAI,EAAE,MAAM,EACZ,IAAI,GAAE,KAAK,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAM,GACjE,aAAa,CAKf;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,gBAAgB,CAc1F;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CAAC,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,YAAY,CAyDpF"}

package/dist/app/charts/series/ordinalSeries.js

@@ -1,24 +1,29 @@
 import { seriesFrom } from "./baseSeries";
 import { initialMaxTimeDatum, initialMaxValueDatum, initialMinTimeDatum, initialMinValueDatum } from "../observables/ordinals";
 /**
- * Creates an empty ordinal datum
+ * An empty ordinal datum (`NaN` time and value, and an empty ordinal)
  */
 export const emptyOrdinalDatum = {
     time: NaN,
     ordinal: "",
     value: NaN,
 };
+/**
+ * Copies an ordinal datum
+ * @param datum The datum to copy
+ * @return The copy
+ */
 export const copyOrdinalDatum = (datum) => ({
     time: datum.time,
     ordinal: datum.ordinal,
     value: datum.value,
 });
 /**
- * Creates an iterate datum
+ * Creates an ordinal datum
  * @param time The datum time, which is mostly informational
  * @param ordinal The category name or identifier
  * @param value The value
- * @return An iterate datum
+ * @return An ordinal datum
  */
 export const ordinalDatumOf = (time, ordinal, value) => ({
     time,
@@ -26,11 +31,10 @@ export const ordinalDatumOf = (time, ordinal, value) => ({
     value,
 });
 /**
- * Returns whether the ordinal datum is empty. An ordinal datum is considered empty
- * when the time is NaN, the ordinal is blank (empty or only whitespace), and the value
- * is NaN.
- * @param datum The iterate datum to test
- * @return `true` if the iterate datum is empty; `false` otherwise
+ * Returns whether the ordinal datum is non-empty. An ordinal datum is considered empty when its
+ * time is NaN, its ordinal is blank (empty or only whitespace), or its value is NaN.
+ * @param datum The ordinal datum to test
+ * @return `true` if the ordinal datum is non-empty; `false` otherwise
  */
 export const nonEmptyOrdinalDatum = (datum) => !isNaN(datum.time) && datum.ordinal.replace(/\s/g, "").length > 0 && !isNaN(datum.value);
 /**
@@ -45,14 +49,16 @@ export function ordinateSeriesFromTuples(name, data = []) {
     return seriesFrom(name, data.map(([t, ordinal, value]) => ordinalDatumOf(t, ordinal, value)));
 }
 /**
- * Creates an empty chart data object with all the values set to 0
- * @param seriesList The list of series names (identifiers) to update
- * @return An empty chart data object
+ * Creates the ordinal chart data for the specified series: their names, the stats calculated over
+ * their data (see {@link calculateOrdinalStats}), and copies of all their data as the new points
+ * @param seriesList The series
+ * @return The ordinal chart data for the series
  */
 export function initialOrdinalChartData(seriesList) {
     return {
         seriesNames: new Set(seriesList.map(series => series.name)),
         stats: calculateOrdinalStats(seriesList),
+        // newPoints: new Map<string, Array<OrdinalDatum>>(seriesList.map(series => [
         newPoints: new Map(seriesList.map(series => [
             series.name,
             series.data.map(datum => ({
@@ -63,6 +69,14 @@ export function initialOrdinalChartData(seriesList) {
         ]))
     };
 }
+/**
+ * Calculates the stats of the specified series: the data with the min and max time, and with the
+ * min and max value, over all the series, and each series' value stats (its min, max, count, sum,
+ * sum of squares, and mean)
+ * @param seriesList The series
+ * @return The stats (when there's no data, the extremes are the initial ones that searches start
+ * from -- see e.g. `initialMinTimeDatum`)
+ */
 export function calculateOrdinalStats(seriesList) {
     const ordinalValueStats = new Map(seriesList.map((series) => {
         const seriesMin = series.data.reduce((min, datum) => datum.value < min.value ? datum : min, initialMinValueDatum());
@@ -82,12 +96,12 @@ export function calculateOrdinalStats(seriesList) {
     const minValueDatum = Array.from(ordinalValueStats.values()).reduce((min, value) => value.min.value < min.value ? value.min : min, initialMinValueDatum());
     const maxValueDatum = Array.from(ordinalValueStats.values()).reduce((max, value) => value.max.value > max.value ? value.max : max, initialMaxValueDatum());
     const minTimeDatum = seriesList.reduce((globalMin, series) => {
-        const seriesMin = series.data.reduce((min, datum) => datum.value < min.value ? datum : min, globalMin);
-        return seriesMin.value < globalMin.value ? seriesMin : globalMin;
+        const seriesMin = series.data.reduce((min, datum) => datum.time < min.time ? datum : min, globalMin);
+        return seriesMin.time < globalMin.time ? seriesMin : globalMin;
     }, initialMinTimeDatum());
     const maxTimeDatum = seriesList.reduce((globalMax, series) => {
-        const seriesMax = series.data.reduce((max, datum) => datum.value > max.value ? datum : max, globalMax);
-        return seriesMax.value > globalMax.value ? seriesMax : globalMax;
+        const seriesMax = series.data.reduce((max, datum) => datum.time > max.time ? datum : max, globalMax);
+        return seriesMax.time > globalMax.time ? seriesMax : globalMax;
     }, initialMaxTimeDatum());
     return {
         maxDatum: { time: maxTimeDatum, value: maxValueDatum },

package/dist/app/charts/series/ordinalSeries.js.map

@@ -1 +1 @@
-{"version":3,"file":"ordinalSeries.js","sourceRoot":"","sources":["../../../../src/app/charts/series/ordinalSeries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAa,UAAU,EAAC,MAAM,cAAc,CAAC;AACpD,OAAO,EACH,mBAAmB,EACnB,oBAAoB,EAAE,mBAAmB,EACzC,oBAAoB,EAIvB,MAAM,yBAAyB,CAAC;AAejC;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAiB;IAC3C,IAAI,EAAE,GAAG;IACT,OAAO,EAAE,EAAE;IACX,KAAK,EAAE,GAAG;CACb,CAAA;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAmB,EAAgB,EAAE,CAAC,CAAC;IACpE,IAAI,EAAE,KAAK,CAAC,IAAI;IAChB,OAAO,EAAE,KAAK,CAAC,OAAO;IACtB,KAAK,EAAE,KAAK,CAAC,KAAK;CACrB,CAAC,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,OAAe,EAAE,KAAa,EAAgB,EAAE,CAAC,CAAC;IAC3F,IAAI;IACJ,OAAO;IACP,KAAK;CACR,CAAC,CAAA;AAGF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAmB,EAAW,EAAE,CACjE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AAO5F;;;;;;;GAOG;AACH,MAAM,UAAU,wBAAwB,CACpC,IAAY,EACZ,OAA8D,EAAE;IAEhE,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CACvE,CAAA;AACL,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,UAAgC;IACpE,OAAO;QACH,WAAW,EAAE,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3D,KAAK,EAAE,qBAAqB,CAAC,UAAU,CAAC;QACxC,SAAS,EAAE,IAAI,GAAG,CAA8B,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YACrE,MAAM,CAAC,IAAI;YACX,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACtB,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,KAAK,EAAE,KAAK,CAAC,KAAK;aACrB,CAAC,CAAC;SACN,CAAC,CAAC;KACN,CAAA;AACL,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,UAAgC;IAClE,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAA4B,UAAU,CAAC,GAAG,CACvE,CAAC,MAAqB,EAAE,EAAE;QACtB,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAChC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EACrD,oBAAoB,EAAE,CACzB,CAAA;QACD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAChC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EACrD,oBAAoB,EAAE,CACzB,CAAA;QACD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QAC1E,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QAC7G,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAA;QAChF,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE;gBACjB,GAAG,EAAE,SAAS;gBACd,GAAG,EAAE,SAAS;gBACd,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM;gBACzB,GAAG,EAAE,SAAS;gBACd,UAAU,EAAE,gBAAgB;gBAC5B,IAAI,EAAE,UAAU;aACnB,CAAC,CAAA;IACN,CAAC,CACJ,CAAC,CAAA;IACF,MAAM,aAAa,GAAiB,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAC7E,CAAC,GAAiB,EAAE,KAAwB,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAC9F,oBAAoB,EAAE,CACzB,CAAA;IACD,MAAM,aAAa,GAAiB,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAC7E,CAAC,GAAiB,EAAE,KAAwB,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAC9F,oBAAoB,EAAE,CACzB,CAAA;IACD,MAAM,YAAY,GAAiB,UAAU,CAAC,MAAM,CAChD,CAAC,SAAuB,EAAE,MAAqB,EAAE,EAAE;QAC/C,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAChC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAE,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EACtD,SAAS,CACZ,CAAA;QACD,OAAO,SAAS,CAAC,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAA;IACpE,CAAC,EACD,mBAAmB,EAAE,CACxB,CAAA;IACD,MAAM,YAAY,GAAiB,UAAU,CAAC,MAAM,CAChD,CAAC,SAAuB,EAAE,MAAqB,EAAE,EAAE;QAC/C,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAChC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAE,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EACtD,SAAS,CACZ,CAAA;QACD,OAAO,SAAS,CAAC,KAAK,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAA;IACpE,CAAC,EACD,mBAAmB,EAAE,CACxB,CAAA;IACD,OAAO;QACH,QAAQ,EAAE,EAAC,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAC;QACpD,QAAQ,EAAE,EAAC,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAC;QACpD,mBAAmB,EAAE,iBAAiB;KACzC,CAAA;AACL,CAAC"}
+{"version":3,"file":"ordinalSeries.js","sourceRoot":"","sources":["../../../../src/app/charts/series/ordinalSeries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,UAAU,EAAC,MAAM,cAAc,CAAC;AACzD,OAAO,EACH,mBAAmB,EACnB,oBAAoB,EAAE,mBAAmB,EACzC,oBAAoB,EAIvB,MAAM,yBAAyB,CAAC;AAgBjC;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAiB;IAC3C,IAAI,EAAE,GAAG;IACT,OAAO,EAAE,EAAE;IACX,KAAK,EAAE,GAAG;CACb,CAAA;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAmB,EAAgB,EAAE,CAAC,CAAC;IACpE,IAAI,EAAE,KAAK,CAAC,IAAI;IAChB,OAAO,EAAE,KAAK,CAAC,OAAO;IACtB,KAAK,EAAE,KAAK,CAAC,KAAK;CACrB,CAAC,CAAA;AAEF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,IAAY,EAAE,OAAe,EAAE,KAAa,EAAgB,EAAE,CAAC,CAAC;IAC3F,IAAI;IACJ,OAAO;IACP,KAAK;CACR,CAAC,CAAA;AAGF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,KAAmB,EAAW,EAAE,CACjE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;AAO5F;;;;;;;GAOG;AACH,MAAM,UAAU,wBAAwB,CACpC,IAAY,EACZ,OAA8D,EAAE;IAEhE,OAAO,UAAU,CACb,IAAI,EACJ,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,cAAc,CAAC,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CACvE,CAAA;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,UAAgC;IACpE,OAAO;QACH,WAAW,EAAE,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3D,KAAK,EAAE,qBAAqB,CAAC,UAAU,CAAC;QACxC,6EAA6E;QAC7E,SAAS,EAAE,IAAI,GAAG,CAAuC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;YAC9E,MAAM,CAAC,IAAI;YACX,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACtB,IAAI,EAAE,KAAK,CAAC,IAAI;gBAChB,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,KAAK,EAAE,KAAK,CAAC,KAAK;aACrB,CAAC,CAAC;SACN,CAAC,CAAC;KACN,CAAA;AACL,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CAAC,UAAgC;IAClE,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAA4B,UAAU,CAAC,GAAG,CACvE,CAAC,MAAqB,EAAE,EAAE;QACtB,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAChC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EACrD,oBAAoB,EAAE,CACzB,CAAA;QACD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAChC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EACrD,oBAAoB,EAAE,CACzB,CAAA;QACD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QAC1E,MAAM,gBAAgB,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE,CAAC,UAAU,GAAG,KAAK,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAA;QAC7G,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAA;QAChF,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE;gBACjB,GAAG,EAAE,SAAS;gBACd,GAAG,EAAE,SAAS;gBACd,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM;gBACzB,GAAG,EAAE,SAAS;gBACd,UAAU,EAAE,gBAAgB;gBAC5B,IAAI,EAAE,UAAU;aACnB,CAAC,CAAA;IACN,CAAC,CACJ,CAAC,CAAA;IACF,MAAM,aAAa,GAAiB,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAC7E,CAAC,GAAiB,EAAE,KAAwB,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAC9F,oBAAoB,EAAE,CACzB,CAAA;IACD,MAAM,aAAa,GAAiB,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAC7E,CAAC,GAAiB,EAAE,KAAwB,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAC9F,oBAAoB,EAAE,CACzB,CAAA;IACD,MAAM,YAAY,GAAiB,UAAU,CAAC,MAAM,CAChD,CAAC,SAAuB,EAAE,MAAqB,EAAE,EAAE;QAC/C,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAChC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAE,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EACpD,SAAS,CACZ,CAAA;QACD,OAAO,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAA;IAClE,CAAC,EACD,mBAAmB,EAAE,CACxB,CAAA;IACD,MAAM,YAAY,GAAiB,UAAU,CAAC,MAAM,CAChD,CAAC,SAAuB,EAAE,MAAqB,EAAE,EAAE;QAC/C,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAChC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE,CAAE,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,EACpD,SAAS,CACZ,CAAA;QACD,OAAO,SAAS,CAAC,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAA;IAClE,CAAC,EACD,mBAAmB,EAAE,CACxB,CAAA;IACD,OAAO;QACH,QAAQ,EAAE,EAAC,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAC;QACpD,QAAQ,EAAE,EAAC,IAAI,EAAE,YAAY,EAAE,KAAK,EAAE,aAAa,EAAC;QACpD,mBAAmB,EAAE,iBAAiB;KACzC,CAAA;AACL,CAAC"}

package/dist/app/charts/series/outlierSeries.d.ts

@@ -0,0 +1,142 @@
+import type { Datum } from "./timeSeries";
+import { type BaseSeries } from "./baseSeries";
+import { type Result } from "result-fn";
+import type { FastShiftArray } from "fast-shift-array";
+/**
+ * A series of {@link OutlierDatum}s, along with the measures that the data's bounds are for
+ * @template M The type of the measures that is expressed as a tuple of numbers.
+ */
+export interface OutlierSeries<M extends readonly number[]> extends BaseSeries<OutlierDatum<M>> {
+    /**
+     * The measures of the datum. For example, this could be a series of probabilities of
+     * the point being an outlier.
+     */
+    readonly measures: readonly [...M];
+    /**
+     * The descriptions of the measures. For example, this could be a series of descriptions
+     * of the probabilities of the point being an outlier.
+     */
+    readonly measureDescriptions?: {
+        readonly [K in keyof M]: string;
+    };
+}
+/**
+ * The bounds of a datum.
+ */
+export interface OutlierBounds {
+    /**
+     * The lower bound of the datum
+     */
+    readonly lower: number;
+    /**
+     * The upper bound of the datum
+     */
+    readonly upper: number;
+}
+/**
+ * A datum with an upper and lower bounds B(L, U) associated with each measure. The idea is the
+ * following. We have a datum (x, y) value. The bounds determine whether the datum is
+ * within the range associated with the measure. For example, the measure could be the
+ * 0.95 probability that the datum falls within that bound. And if the (x, y) value falls
+ * outside the bounds B(L, U), the datum could be considered an "outlier".
+ *
+ * Often we would like to have a set of measures that mean different things. For example, if
+ * the datum falls outside the bounds B1(L, U) representing the range in which we expect
+ * the datum to fall with a 0.95 probability, then we could consider the datum an "outlier". We
+ * may also want to consider the datum an "outlier" if it falls outside the bounds B2(L, U)
+ * representing the range in which we expect the datum to fall with a 0.75 probability. If the
+ * datum falls outside B2(L, U), then we could consider the datum a "possible outlier" and
+ * treat it differently from an "outlier".
+ *
+ * Note that there are constraints.
+ * 1. The cardinality of the measures and the bounds must be the same.
+ * 2. The i-th bound is associated with the i-th measure.
+ *
+ * @template M The type of the measures that is expressed as a tuple of numbers.
+ * @see OutlierBounds
+ * @see outlierBoundsFor
+ * @see outlierDatumFor
+ * @see outlierSeriesFor
+ *
+ * @example
+ * // possible-outlier = 0.75, outlier = 0.95
+ * const Measures = [0.75, 0.95] as const;
+ * const value: Datum = datumOf(1, 10);
+ * const bounds = [
+ *     outlierBoundsFor(21, 121),
+ *     outlierBoundsFor(2, 52)
+ * ] as const;
+ * const datum = outlierDatumFor<typeof Measures>(value, Measures, bounds);
+ */
+export interface OutlierDatum<M extends readonly number[]> {
+    /**
+     * The datum with the x and y values
+     */
+    readonly datum: Datum;
+    /**
+     * The bounds of the measures. For example, if the measures are probabilities, then
+     * the bounds are a series that hold the lower and upper bounds for each probability
+     * in the measures.
+     */
+    readonly bounds: {
+        readonly [K in keyof M]: OutlierBounds;
+    };
+}
+/**
+ * Convenience function to create an outlier bounds object.
+ * @param lower The lower bound of the measure
+ * @param upper The upper bound of the measure
+ * @return An outlier bounds object
+ */
+export declare function outlierBoundsFor(lower: number, upper: number): OutlierBounds;
+/**
+ * Creates an outlier datum from the (x, y) value and the bounds associated with each measure. Because
+ * the length of the bounds-array must be the same as the length of the measures-array, this returns
+ * a {@link Result} object with the outcome of the operation.
+ * @param datum The (x, y) value
+ * @param measures The measures array where each measure is associated with a bound of the same index
+ * @param bounds The bounds array where each bound is associated with a measure of the same index
+ * @return A {@link Result} object with the outcome of the operation. If the operation is successful,
+ * then the result is an {@link OutlierDatum} object. If the operation is not successful, then
+ * the result is a `string` with the error message.
+ * @template M The type of the measures that is expressed as a tuple of numbers.
+ */
+export declare function outlierDatumFor<M extends readonly number[]>(datum: Datum, measures: readonly [...M], bounds: {
+    readonly [K in keyof M]: OutlierBounds;
+}): Result<OutlierDatum<M>, string>;
+/**
+ * Creates an outlier series from the name and the array of (x, y, bounds) tuples. If any of the
+ * datum have bounds that do not have the same length as the measures, then this function will fail and
+ * return a failure result. Otherwise, it will return a success result with the outlier series.
+ * @param name The name of the series
+ * @param measures The measures that are associated with the series
+ * @param data The array of (x, y, bounds) tuples that define the series
+ * @param [measureDescriptions=undefined] The descriptions of the measures
+ * @return A {@link Result} object with the outcome of the operation. If the operation is successful,
+ * then the result is an {@link OutlierSeries} object. If the operation is not successful, then
+ * the result is an array of error messages.
+ * @template M The type of the measures that is expressed as a tuple of numbers.
+ */
+export declare function outlierSeriesFor<M extends readonly number[]>(name: string, measures: readonly [...M], data: Array<[time: number, value: number, bounds: {
+    readonly [K in keyof M]: OutlierBounds;
+}]>, measureDescriptions?: {
+    readonly [K in keyof M]: string;
+}): Result<OutlierSeries<M>, Array<string>>;
+/**
+ * Creates an outlier series for the data and measures
+ *
+ * **Ownership warning:** `outlierData` is forwarded directly to {@link seriesFrom}, which wraps a
+ * plain array (or `FastShiftArray`) **by reference**, not a copy -- see {@link seriesFrom}'s own
+ * ownership warning for the full explanation. If you keep your own reference to `outlierData`,
+ * pass `outlierData.slice()` instead if you need an independent copy.
+ * @param name The name of the series
+ * @param outlierData The data for the series
+ * @param measures The measure defining the outlier bands
+ * @param measureDescriptions The (optional) meaning of each band
+ * @return An outlier series
+ * @template M The type of the measures that is expressed as a tuple of numbers.
+ */
+export declare function outlierSeriesFrom<M extends readonly number[]>(name: string, outlierData: Array<OutlierDatum<M>> | FastShiftArray<OutlierDatum<M>>, measures: readonly [...M], measureDescriptions?: {
+    readonly [K in keyof M]: string;
+}): OutlierSeries<M>;
+//# sourceMappingURL=outlierSeries.d.ts.map

package/dist/app/charts/series/outlierSeries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"outlierSeries.d.ts","sourceRoot":"","sources":["../../../../src/app/charts/series/outlierSeries.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,cAAc,CAAC;AACxC,OAAO,EAAC,KAAK,UAAU,EAAa,MAAM,cAAc,CAAC;AACzD,OAAO,EAAgB,KAAK,MAAM,EAA+B,MAAM,WAAW,CAAC;AACnF,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,kBAAkB,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,SAAS,MAAM,EAAE,CAAE,SAAQ,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAC3F;;;OAGG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,CAAA;IAClC;;;OAGG;IACH,QAAQ,CAAC,mBAAmB,CAAC,EAAE;QAAC,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM;KAAC,CAAA;CACnE;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC1B;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACzB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC,SAAS,SAAS,MAAM,EAAE;IACrD;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAA;IACrB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE;QAAC,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,aAAa;KAAC,CAAA;CAC5D;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,aAAa,CAE5E;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,eAAe,CAAC,CAAC,SAAS,SAAS,MAAM,EAAE,EACvD,KAAK,EAAE,KAAK,EACZ,QAAQ,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,EACzB,MAAM,EAAE;IAAC,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,aAAa;CAAC,GACjD,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAYjC;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,gBAAgB,CAAC,CAAC,SAAS,SAAS,MAAM,EAAE,EACxD,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,EACzB,IAAI,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE;IAAE,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,aAAa;CAAC,CAAC,CAAC,EAC7F,mBAAmB,CAAC,EAAE;IAAC,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM;CAAC,GACxD,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAsBzC;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,SAAS,MAAM,EAAE,EACzD,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,EACrE,QAAQ,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,EACzB,mBAAmB,CAAC,EAAE;IAAC,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM;CAAC,GACxD,aAAa,CAAC,CAAC,CAAC,CAElB"}

package/dist/app/charts/series/outlierSeries.js

@@ -0,0 +1,82 @@
+import { seriesFrom } from "./baseSeries";
+import { failureResult, resultFromAll, successResult } from "result-fn";
+/**
+ * Convenience function to create an outlier bounds object.
+ * @param lower The lower bound of the measure
+ * @param upper The upper bound of the measure
+ * @return An outlier bounds object
+ */
+export function outlierBoundsFor(lower, upper) {
+    return { lower, upper };
+}
+/**
+ * Creates an outlier datum from the (x, y) value and the bounds associated with each measure. Because
+ * the length of the bounds-array must be the same as the length of the measures-array, this returns
+ * a {@link Result} object with the outcome of the operation.
+ * @param datum The (x, y) value
+ * @param measures The measures array where each measure is associated with a bound of the same index
+ * @param bounds The bounds array where each bound is associated with a measure of the same index
+ * @return A {@link Result} object with the outcome of the operation. If the operation is successful,
+ * then the result is an {@link OutlierDatum} object. If the operation is not successful, then
+ * the result is a `string` with the error message.
+ * @template M The type of the measures that is expressed as a tuple of numbers.
+ */
+export function outlierDatumFor(datum, measures, bounds) {
+    if (measures.length !== bounds.length) {
+        return failureResult(`The number of measures and bounds must be the same; ` +
+            `datum: (${datum.x}, ${datum.y}); ` +
+            `measures_length: ${measures.length}; ` +
+            `bounds_length: ${bounds.length}; ` +
+            `measures: [${measures.join(", ")}]; ` +
+            `bounds: [${Object.values(bounds).map(b => `(${b.lower}, ${b.upper})`).join(", ")}]`);
+    }
+    return successResult({ datum, bounds });
+}
+/**
+ * Creates an outlier series from the name and the array of (x, y, bounds) tuples. If any of the
+ * datum have bounds that do not have the same length as the measures, then this function will fail and
+ * return a failure result. Otherwise, it will return a success result with the outlier series.
+ * @param name The name of the series
+ * @param measures The measures that are associated with the series
+ * @param data The array of (x, y, bounds) tuples that define the series
+ * @param [measureDescriptions=undefined] The descriptions of the measures
+ * @return A {@link Result} object with the outcome of the operation. If the operation is successful,
+ * then the result is an {@link OutlierSeries} object. If the operation is not successful, then
+ * the result is an array of error messages.
+ * @template M The type of the measures that is expressed as a tuple of numbers.
+ */
+export function outlierSeriesFor(name, measures, data, measureDescriptions) {
+    // enrich each datum in the data array with the measures
+    const outlierData = data.map(([time, value, bounds]) => outlierDatumFor({ x: time, y: value }, measures, bounds));
+    // if all data has bounds-dimensions that match the measures-dimensions, then we can safely
+    // create the outlier series, otherwise we must report the errors
+    if (outlierData.filter(datum => datum.succeeded).length === data.length) {
+        // convert the Array<Result<OutlierDatum<M>, string>> to Result<Array<OutlierDatum<M>>, Array<string>>
+        return resultFromAll(outlierData)
+            .map(data => outlierSeriesFrom(name, data, measures, measureDescriptions))
+            .mapFailure(failure => [failure]);
+    }
+    // collect all the errors for datum whose bounds and measures dimensions did not
+    // match and report each error
+    return failureResult(outlierData
+        .filter(result => result.failed)
+        .map(result => result.error));
+}
+/**
+ * Creates an outlier series for the data and measures
+ *
+ * **Ownership warning:** `outlierData` is forwarded directly to {@link seriesFrom}, which wraps a
+ * plain array (or `FastShiftArray`) **by reference**, not a copy -- see {@link seriesFrom}'s own
+ * ownership warning for the full explanation. If you keep your own reference to `outlierData`,
+ * pass `outlierData.slice()` instead if you need an independent copy.
+ * @param name The name of the series
+ * @param outlierData The data for the series
+ * @param measures The measure defining the outlier bands
+ * @param measureDescriptions The (optional) meaning of each band
+ * @return An outlier series
+ * @template M The type of the measures that is expressed as a tuple of numbers.
+ */
+export function outlierSeriesFrom(name, outlierData, measures, measureDescriptions) {
+    return { ...seriesFrom(name, outlierData), measures, measureDescriptions };
+}
+//# sourceMappingURL=outlierSeries.js.map

package/dist/app/charts/series/outlierSeries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"outlierSeries.js","sourceRoot":"","sources":["../../../../src/app/charts/series/outlierSeries.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,UAAU,EAAC,MAAM,cAAc,CAAC;AACzD,OAAO,EAAC,aAAa,EAAe,aAAa,EAAE,aAAa,EAAC,MAAM,WAAW,CAAC;AAkFnF;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAa,EAAE,KAAa;IACzD,OAAO,EAAC,KAAK,EAAE,KAAK,EAAC,CAAA;AACzB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAC3B,KAAY,EACZ,QAAyB,EACzB,MAAgD;IAEhD,IAAI,QAAQ,CAAC,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;QACpC,OAAO,aAAa,CAChB,sDAAsD;YACtD,WAAW,KAAK,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK;YACnC,oBAAoB,QAAQ,CAAC,MAAM,IAAI;YACvC,kBAAkB,MAAM,CAAC,MAAM,IAAI;YACnC,cAAc,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK;YACtC,YAAY,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CACvF,CAAA;IACL,CAAC;IACD,OAAO,aAAa,CAAC,EAAC,KAAK,EAAE,MAAM,EAAC,CAAC,CAAA;AACzC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,gBAAgB,CAC5B,IAAY,EACZ,QAAyB,EACzB,IAA6F,EAC7F,mBAAuD;IAEvD,wDAAwD;IACxD,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CACxB,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,EAAE,EAAE,CACtB,eAAe,CAAC,EAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,CAC7D,CAAA;IAED,2FAA2F;IAC3F,iEAAiE;IACjE,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE,CAAC;QACtE,sGAAsG;QACtG,OAAO,aAAa,CAAC,WAAW,CAAC;aAC5B,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,mBAAmB,CAAC,CAAC;aACzE,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,CAAA;IACzC,CAAC;IAED,gFAAgF;IAChF,8BAA8B;IAC9B,OAAO,aAAa,CAAC,WAAW;SAC3B,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC;SAC/B,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAM,CAAC,CAChC,CAAA;AACL,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,iBAAiB,CAC7B,IAAY,EACZ,WAAqE,EACrE,QAAyB,EACzB,mBAAuD;IAEvD,OAAO,EAAC,GAAG,UAAU,CAAC,IAAI,EAAE,WAAW,CAAC,EAAE,QAAQ,EAAE,mBAAmB,EAAC,CAAA;AAC5E,CAAC"}