openalgo-script 0.1.0-alpha.1 → 0.4.0

package/dist/core/stdlib/volatility/bands.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bands.js","sourceRoot":"","sources":["../../../../src/core/stdlib/volatility/bands.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE/E,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAE5C,oFAAoF;AACpF,MAAM,UAAU,aAAa,CAC3B,KAAkB,EAClB,GAAW,EACX,KAAY,EACZ,GAAkB,EAClB,IAAmB;IAEnB,MAAM,MAAM,GAAG,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IACrD,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IACjE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9F,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC;AACxF,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,aAAa,CAAC,GAAG,GAAG,EAAE,EAAE,IAAI,GAAG,CAAC;IAC9C,OAAO,MAAM,CAAC,CAAC,KAAK,EAAE,KAAY,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;AACrF,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,SAAS,CAAC,GAAW,EAAE,GAAG,GAAG,EAAE,EAAE,IAAI,GAAG,CAAC;IACvD,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;AAC7C,CAAC;AAED,gFAAgF;AAChF,MAAM,UAAU,WAAW,CACzB,KAAkB,EAClB,GAAW,EACX,KAAY,EACZ,GAAkB,EAClB,IAAmB;IAEnB,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IACzD,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC1B,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC1B,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC1B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAC7E,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAC7B,OAAO,MAAM,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC;AACzC,CAAC;AAED,2CAA2C;AAC3C,MAAM,UAAU,WAAW,CAAC,GAAG,GAAG,EAAE,EAAE,IAAI,GAAG,CAAC;IAC5C,OAAO,MAAM,CAAC,CAAC,KAAK,EAAE,KAAY,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;AACnF,CAAC;AAED,qDAAqD;AACrD,MAAM,UAAU,OAAO,CAAC,GAAW,EAAE,GAAG,GAAG,EAAE,EAAE,IAAI,GAAG,CAAC;IACrD,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;AAC3C,CAAC;AAED,2FAA2F;AAC3F,MAAM,UAAU,aAAa,CAC3B,KAAkB,EAClB,GAAW,EACX,KAAY,EACZ,GAAkB,EAClB,IAAmB;IAEnB,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;IACzD,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC1B,MAAM,KAAK,GAAG,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IAC1B,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAC7E,MAAM,IAAI,GAAG,KAAK,GAAG,KAAK,CAAC;IAC3B,IAAI,IAAI,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAC5B,OAAO,MAAM,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;AACxC,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,aAAa,CAAC,GAAG,GAAG,EAAE,EAAE,IAAI,GAAG,CAAC;IAC9C,OAAO,MAAM,CAAC,CAAC,KAAK,EAAE,KAAY,EAAE,EAAE,CAAC,aAAa,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;AACrF,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,SAAS,CAAC,GAAW,EAAE,GAAG,GAAG,EAAE,EAAE,IAAI,GAAG,CAAC;IACvD,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,WAAW,CACzB,KAAkB,EAClB,GAAW,EACX,GAAQ,EACR,KAAY,EACZ,MAAa,EACb,GAAkB,EAClB,IAAmB,EACnB,MAAqB,EACrB,MAAqB;IAErB,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IAC7E,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IACrD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,IAAI,KAAK,IAAI;QAAE,OAAO,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC1F,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,IAAI,GAAG,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC;AAChF,CAAC;AAED,sDAAsD;AACtD,MAAM,UAAU,WAAW,CACzB,GAAG,GAAG,EAAE,EACR,IAAI,GAAG,CAAC,EACR,MAAM,GAAG,EAAE,EACX,SAAiB,KAAK;IAEtB,OAAO,MAAM,CAAC,CAAC,KAAK,EAAE,GAAQ,EAAE,EAAE,CAChC,WAAW,CACT,KAAK,EACL,EAAE,EACF,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EACtB,GAAG,CAAC,KAAK,EACT,GAAG,CAAC,MAAM,EACV,GAAG,EACH,IAAI,EACJ,MAAM,EACN,MAAM,CACP,CACF,CAAC;AACJ,CAAC;AAED,+DAA+D;AAC/D,MAAM,UAAU,OAAO,CACrB,IAAoB,EACpB,GAAG,GAAG,EAAE,EACR,IAAI,GAAG,CAAC,EACR,MAAM,GAAG,EAAE,EACX,SAAiB,KAAK;IAEtB,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,CAAC;AAC5D,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,YAAY,CAC1B,KAAkB,EAClB,GAAW,EACX,IAAW,EACX,GAAU,EACV,GAAkB;IAElB,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACpE,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACpE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACxE,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;AACrD,CAAC;AAED,iCAAiC;AACjC,MAAM,UAAU,YAAY,CAAC,GAAG,GAAG,EAAE;IACnC,OAAO,MAAM,CAAC,CAAC,KAAK,EAAE,GAAQ,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AACtF,CAAC;AAED,0CAA0C;AAC1C,MAAM,UAAU,QAAQ,CAAC,IAAoB,EAAE,GAAG,GAAG,EAAE;IACrD,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;AACvC,CAAC"}

package/dist/core/stdlib/volatility/deviation.d.ts

@@ -0,0 +1,43 @@
+/**
+ * `variance` and `stdev`.
+ *
+ * **Population by default, the `len` divisor.** `stdlib.md` section 6 fixes it
+ * and gives the reason: that is what the band studies a chart has to reproduce
+ * use. `sample = true` switches to the `len - 1` divisor, so neither camp has
+ * to write the correction by hand and neither has to guess which one a chart
+ * drew.
+ *
+ * Two passes: the mean of the lookback first, then the deviations from it. The
+ * one pass arrangement that subtracts the square of the mean from the mean of
+ * the squares loses most of its significant digits on a price series, where the
+ * values are large and their spread is small, and can even produce a negative
+ * variance that then has to be floored at zero. A study whose implementation
+ * needs a floor to stay real is a study computing the wrong quantity.
+ */
+import type { Series, StateRecord, Tail, Value } from '../values/index.js';
+/** `variance(src, len, sample)`: the squared deviation over the lookback, from bar `len - 1`. */
+export declare function varianceStep(state: StateRecord, key: string, value: Value, len: number | null, sample: boolean): Value;
+/** `variance(src, len, sample)` as a tail. */
+export declare function varianceTail(len: number, sample?: boolean): Tail<Value, Value>;
+/** `variance(src, len, sample)` over a whole series. */
+export declare function variance(src: Series, len: number, sample?: boolean): Value[];
+/** `stdev(src, len, sample)`: the square root of the same, from bar `len - 1`. */
+export declare function stdevStep(state: StateRecord, key: string, value: Value, len: number | null, sample: boolean): Value;
+/** `stdev(src, len, sample)` as a tail. */
+export declare function stdevTail(len: number, sample?: boolean): Tail<Value, Value>;
+/** `stdev(src, len, sample)` over a whole series. */
+export declare function stdev(src: Series, len: number, sample?: boolean): Value[];
+/**
+ * The mean absolute deviation from the lookback's mean.
+ *
+ * Not a call of its own in `stdlib.md`, and here because `cci` is defined
+ * against it rather than against `stdev`: the 0.015 constant in that study is
+ * calibrated for this quantity, and substituting a standard deviation changes
+ * every reading.
+ */
+export declare function meanDeviationStep(state: StateRecord, key: string, value: Value, len: number | null): Value;
+/** The mean absolute deviation as a tail. */
+export declare function meanDeviationTail(len: number): Tail<Value, Value>;
+/** The mean absolute deviation over a whole series. */
+export declare function meanDeviation(src: Series, len: number): Value[];
+//# sourceMappingURL=deviation.d.ts.map

package/dist/core/stdlib/volatility/deviation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviation.d.ts","sourceRoot":"","sources":["../../../../src/core/stdlib/volatility/deviation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AACH,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAG3E,iGAAiG;AACjG,wBAAgB,YAAY,CAC1B,KAAK,EAAE,WAAW,EAClB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,KAAK,EACZ,GAAG,EAAE,MAAM,GAAG,IAAI,EAClB,MAAM,EAAE,OAAO,GACd,KAAK,CAeP;AAED,8CAA8C;AAC9C,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,UAAQ,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAE5E;AAED,wDAAwD;AACxD,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,UAAQ,GAAG,KAAK,EAAE,CAE1E;AAED,kFAAkF;AAClF,wBAAgB,SAAS,CACvB,KAAK,EAAE,WAAW,EAClB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,KAAK,EACZ,GAAG,EAAE,MAAM,GAAG,IAAI,EAClB,MAAM,EAAE,OAAO,GACd,KAAK,CAIP;AAED,2CAA2C;AAC3C,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,UAAQ,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAEzE;AAED,qDAAqD;AACrD,wBAAgB,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,UAAQ,GAAG,KAAK,EAAE,CAEvE;AAED;;;;;;;GAOG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,WAAW,EAClB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,KAAK,EACZ,GAAG,EAAE,MAAM,GAAG,IAAI,GACjB,KAAK,CAWP;AAED,6CAA6C;AAC7C,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAEjE;AAED,uDAAuD;AACvD,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,KAAK,EAAE,CAE/D"}

package/dist/core/stdlib/volatility/deviation.js

@@ -0,0 +1,75 @@
+import { NONE, fold, isPresent, result, ring, tailOf } from '../values/index.js';
+/** `variance(src, len, sample)`: the squared deviation over the lookback, from bar `len - 1`. */
+export function varianceStep(state, key, value, len, sample) {
+    const lookback = ring(state, key, len);
+    lookback.push(value);
+    if (len === null)
+        return NONE;
+    const divisor = sample ? len - 1 : len;
+    if (!lookback.complete() || divisor <= 0)
+        return NONE;
+    const mean = lookback.mean();
+    if (!isPresent(mean))
+        return NONE;
+    let squares = 0;
+    // Oldest bar first, the order of `lookback.ts`.
+    for (let back = len - 1; back >= 0; back -= 1) {
+        const deviation = lookback.at(back) - mean;
+        squares += deviation * deviation;
+    }
+    return result(squares / divisor);
+}
+/** `variance(src, len, sample)` as a tail. */
+export function varianceTail(len, sample = false) {
+    return tailOf((state, value) => varianceStep(state, 'q', value, len, sample));
+}
+/** `variance(src, len, sample)` over a whole series. */
+export function variance(src, len, sample = false) {
+    return fold(varianceTail(len, sample), src);
+}
+/** `stdev(src, len, sample)`: the square root of the same, from bar `len - 1`. */
+export function stdevStep(state, key, value, len, sample) {
+    const squared = varianceStep(state, key, value, len, sample);
+    if (!isPresent(squared) || squared < 0)
+        return NONE;
+    return result(Math.sqrt(squared));
+}
+/** `stdev(src, len, sample)` as a tail. */
+export function stdevTail(len, sample = false) {
+    return tailOf((state, value) => stdevStep(state, 'q', value, len, sample));
+}
+/** `stdev(src, len, sample)` over a whole series. */
+export function stdev(src, len, sample = false) {
+    return fold(stdevTail(len, sample), src);
+}
+/**
+ * The mean absolute deviation from the lookback's mean.
+ *
+ * Not a call of its own in `stdlib.md`, and here because `cci` is defined
+ * against it rather than against `stdev`: the 0.015 constant in that study is
+ * calibrated for this quantity, and substituting a standard deviation changes
+ * every reading.
+ */
+export function meanDeviationStep(state, key, value, len) {
+    const lookback = ring(state, key, len);
+    lookback.push(value);
+    if (len === null || !lookback.complete())
+        return NONE;
+    const mean = lookback.mean();
+    if (!isPresent(mean))
+        return NONE;
+    let total = 0;
+    for (let back = len - 1; back >= 0; back -= 1) {
+        total += Math.abs(lookback.at(back) - mean);
+    }
+    return result(total / len);
+}
+/** The mean absolute deviation as a tail. */
+export function meanDeviationTail(len) {
+    return tailOf((state, value) => meanDeviationStep(state, 'q', value, len));
+}
+/** The mean absolute deviation over a whole series. */
+export function meanDeviation(src, len) {
+    return fold(meanDeviationTail(len), src);
+}
+//# sourceMappingURL=deviation.js.map

package/dist/core/stdlib/volatility/deviation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deviation.js","sourceRoot":"","sources":["../../../../src/core/stdlib/volatility/deviation.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAEjF,iGAAiG;AACjG,MAAM,UAAU,YAAY,CAC1B,KAAkB,EAClB,GAAW,EACX,KAAY,EACZ,GAAkB,EAClB,MAAe;IAEf,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IACvC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAC9B,MAAM,OAAO,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IACvC,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,IAAI,OAAO,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IACtD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC7B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAClC,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,gDAAgD;IAChD,KAAK,IAAI,IAAI,GAAG,GAAG,GAAG,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,CAAC;QAC9C,MAAM,SAAS,GAAI,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAY,GAAG,IAAI,CAAC;QACvD,OAAO,IAAI,SAAS,GAAG,SAAS,CAAC;IACnC,CAAC;IACD,OAAO,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC,CAAC;AACnC,CAAC;AAED,8CAA8C;AAC9C,MAAM,UAAU,YAAY,CAAC,GAAW,EAAE,MAAM,GAAG,KAAK;IACtD,OAAO,MAAM,CAAC,CAAC,KAAK,EAAE,KAAY,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC;AACvF,CAAC;AAED,wDAAwD;AACxD,MAAM,UAAU,QAAQ,CAAC,GAAW,EAAE,GAAW,EAAE,MAAM,GAAG,KAAK;IAC/D,OAAO,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC;AAC9C,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,SAAS,CACvB,KAAkB,EAClB,GAAW,EACX,KAAY,EACZ,GAAkB,EAClB,MAAe;IAEf,MAAM,OAAO,GAAG,YAAY,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;IAC7D,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,OAAO,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACpD,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AACpC,CAAC;AAED,2CAA2C;AAC3C,MAAM,UAAU,SAAS,CAAC,GAAW,EAAE,MAAM,GAAG,KAAK;IACnD,OAAO,MAAM,CAAC,CAAC,KAAK,EAAE,KAAY,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC;AACpF,CAAC;AAED,qDAAqD;AACrD,MAAM,UAAU,KAAK,CAAC,GAAW,EAAE,GAAW,EAAE,MAAM,GAAG,KAAK;IAC5D,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC,EAAE,GAAG,CAAC,CAAC;AAC3C,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAkB,EAClB,GAAW,EACX,KAAY,EACZ,GAAkB;IAElB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IACvC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACrB,IAAI,GAAG,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;QAAE,OAAO,IAAI,CAAC;IACtD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC;IAC7B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAClC,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,IAAI,IAAI,GAAG,GAAG,GAAG,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,IAAI,IAAI,CAAC,EAAE,CAAC;QAC9C,KAAK,IAAI,IAAI,CAAC,GAAG,CAAE,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAY,GAAG,IAAI,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC;AAC7B,CAAC;AAED,6CAA6C;AAC7C,MAAM,UAAU,iBAAiB,CAAC,GAAW;IAC3C,OAAO,MAAM,CAAC,CAAC,KAAK,EAAE,KAAY,EAAE,EAAE,CAAC,iBAAiB,CAAC,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;AACpF,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,aAAa,CAAC,GAAW,EAAE,GAAW;IACpD,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;AAC3C,CAAC"}

package/dist/core/stdlib/volatility/index.d.ts

@@ -0,0 +1,6 @@
+export type { Gap } from './range.js';
+export { atr, atrStep, atrTail, gapOf, gapTrueRange, gapTrueRangeStep, gapTrueRangeTail, natr, natrStep, natrTail, trueRange, trueRangeOf, trueRangeTail, } from './range.js';
+export { meanDeviation, meanDeviationStep, meanDeviationTail, stdev, stdevStep, stdevTail, variance, varianceStep, varianceTail, } from './deviation.js';
+export { bbPercent, bbPercentStep, bbPercentTail, bbWidth, bbWidthStep, bbWidthTail, bollinger, bollingerStep, bollingerTail, donchian, donchianStep, donchianTail, keltner, keltnerStep, keltnerTail, } from './bands.js';
+export { chop, chopStep, chopTail, hv, hvStep, hvTail } from './measures.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/core/stdlib/volatility/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/core/stdlib/volatility/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EACL,GAAG,EACH,OAAO,EACP,OAAO,EACP,KAAK,EACL,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,IAAI,EACJ,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,WAAW,EACX,aAAa,GACd,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,KAAK,EACL,SAAS,EACT,SAAS,EACT,QAAQ,EACR,YAAY,EACZ,YAAY,GACb,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACL,SAAS,EACT,aAAa,EACb,aAAa,EACb,OAAO,EACP,WAAW,EACX,WAAW,EACX,SAAS,EACT,aAAa,EACb,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,WAAW,EACX,WAAW,GACZ,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC"}

package/dist/core/stdlib/volatility/index.js

@@ -0,0 +1,5 @@
+export { atr, atrStep, atrTail, gapOf, gapTrueRange, gapTrueRangeStep, gapTrueRangeTail, natr, natrStep, natrTail, trueRange, trueRangeOf, trueRangeTail, } from './range.js';
+export { meanDeviation, meanDeviationStep, meanDeviationTail, stdev, stdevStep, stdevTail, variance, varianceStep, varianceTail, } from './deviation.js';
+export { bbPercent, bbPercentStep, bbPercentTail, bbWidth, bbWidthStep, bbWidthTail, bollinger, bollingerStep, bollingerTail, donchian, donchianStep, donchianTail, keltner, keltnerStep, keltnerTail, } from './bands.js';
+export { chop, chopStep, chopTail, hv, hvStep, hvTail } from './measures.js';
+//# sourceMappingURL=index.js.map

package/dist/core/stdlib/volatility/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/core/stdlib/volatility/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,GAAG,EACH,OAAO,EACP,OAAO,EACP,KAAK,EACL,YAAY,EACZ,gBAAgB,EAChB,gBAAgB,EAChB,IAAI,EACJ,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,WAAW,EACX,aAAa,GACd,MAAM,YAAY,CAAC;AAEpB,OAAO,EACL,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,KAAK,EACL,SAAS,EACT,SAAS,EACT,QAAQ,EACR,YAAY,EACZ,YAAY,GACb,MAAM,gBAAgB,CAAC;AAExB,OAAO,EACL,SAAS,EACT,aAAa,EACb,aAAa,EACb,OAAO,EACP,WAAW,EACX,WAAW,EACX,SAAS,EACT,aAAa,EACb,aAAa,EACb,QAAQ,EACR,YAAY,EACZ,YAAY,EACZ,OAAO,EACP,WAAW,EACX,WAAW,GACZ,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC"}

package/dist/core/stdlib/volatility/measures.d.ts

@@ -0,0 +1,48 @@
+/**
+ * `chop` and `hv`, the two readings that say how the lookback behaved rather than
+ * how wide it was.
+ *
+ * Both are written as a step over a state region and both tails are that step
+ * over a region of their own, so a live chart and a fold over a run of bars
+ * cannot disagree.
+ */
+import type { Bar, Series, StateRecord, Tail, Value } from '../values/index.js';
+import type { Gap } from './range.js';
+/**
+ * `chop(len)`: a 0 to 100 reading of whether the lookback trended or chopped,
+ * from bar `len`.
+ *
+ * The distance price actually travelled over the lookback, against the outright
+ * range it covered. A market that went straight there travels its range and
+ * reads low; one that went back and forth travels several times its range and
+ * reads high.
+ *
+ * The travel is a sum of `len` true ranges, and a true range needs the bar
+ * before it, which is why the first reading is at bar `len` and not at bar
+ * `len - 1`: the gap-aware form of true range is the one used here, per the
+ * note in `range.ts`. The previous close arrives with the gap rather than being
+ * remembered here, for the reason the same note gives.
+ */
+export declare function chopStep(state: StateRecord, key: string, gap: Gap, len: number | null): Value;
+/** `chop(len)` as a tail. */
+export declare function chopTail(len?: number): Tail<Bar, Value>;
+/** `chop(len)` over a run of bars. */
+export declare function chop(bars: readonly Bar[], len?: number): Value[];
+/**
+ * `hv(src, len, periodsPerYear)`: the annualised standard deviation of log
+ * returns, from bar `len`.
+ *
+ * A log return needs the previous bar, so the deviation's lookback starts at bar
+ * 1 and its first value is at bar `len`, one later than a lookback over levels.
+ *
+ * The result is a proportion, not a percentage: `stdlib.md` section 6 says
+ * "annualised standard deviation of log returns" and nothing about scaling it
+ * by a hundred, so nothing here does. A study that wants a percentage axis
+ * multiplies at the plot, where a reader can see it happen.
+ */
+export declare function hvStep(state: StateRecord, key: string, value: Value, len: number | null, periodsPerYear: number | null): Value;
+/** `hv(src, len, periodsPerYear)` as a tail. */
+export declare function hvTail(len?: number, periodsPerYear?: number): Tail<Value, Value>;
+/** `hv(src, len, periodsPerYear)` over a whole series. */
+export declare function hv(src: Series, len?: number, periodsPerYear?: number): Value[];
+//# sourceMappingURL=measures.d.ts.map

package/dist/core/stdlib/volatility/measures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"measures.d.ts","sourceRoot":"","sources":["../../../../src/core/stdlib/volatility/measures.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAIhF,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAItC;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,WAAW,EAClB,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,GAAG,EACR,GAAG,EAAE,MAAM,GAAG,IAAI,GACjB,KAAK,CAUP;AAED,6BAA6B;AAC7B,wBAAgB,QAAQ,CAAC,GAAG,SAAK,GAAG,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAEnD;AAED,sCAAsC;AACtC,wBAAgB,IAAI,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,EAAE,GAAG,SAAK,GAAG,KAAK,EAAE,CAE5D;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,MAAM,CACpB,KAAK,EAAE,WAAW,EAClB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,KAAK,EACZ,GAAG,EAAE,MAAM,GAAG,IAAI,EAClB,cAAc,EAAE,MAAM,GAAG,IAAI,GAC5B,KAAK,CASP;AAED,gDAAgD;AAChD,wBAAgB,MAAM,CAAC,GAAG,SAAK,EAAE,cAAc,SAAM,GAAG,IAAI,CAAC,KAAK,EAAE,KAAK,CAAC,CAEzE;AAED,0DAA0D;AAC1D,wBAAgB,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,SAAK,EAAE,cAAc,SAAM,GAAG,KAAK,EAAE,CAEvE"}

package/dist/core/stdlib/volatility/measures.js

@@ -0,0 +1,73 @@
+import { NONE, fold, isPresent, result, tailOf } from '../values/index.js';
+import { extremeStep, historyStep, sumStep } from '../series/index.js';
+import { gapOf, trueRangeOf } from './range.js';
+import { stdevStep } from './deviation.js';
+/**
+ * `chop(len)`: a 0 to 100 reading of whether the lookback trended or chopped,
+ * from bar `len`.
+ *
+ * The distance price actually travelled over the lookback, against the outright
+ * range it covered. A market that went straight there travels its range and
+ * reads low; one that went back and forth travels several times its range and
+ * reads high.
+ *
+ * The travel is a sum of `len` true ranges, and a true range needs the bar
+ * before it, which is why the first reading is at bar `len` and not at bar
+ * `len - 1`: the gap-aware form of true range is the one used here, per the
+ * note in `range.ts`. The previous close arrives with the gap rather than being
+ * remembered here, for the reason the same note gives.
+ */
+export function chopStep(state, key, gap, len) {
+    const distance = sumStep(state, `${key}s`, trueRangeOf(gap, false), len);
+    const upper = extremeStep(state, `${key}h`, gap.high, len, true, false);
+    const lower = extremeStep(state, `${key}l`, gap.low, len, false, false);
+    if (len === null)
+        return NONE;
+    if (!isPresent(distance) || !isPresent(upper) || !isPresent(lower))
+        return NONE;
+    const span = upper - lower;
+    const scale = Math.log10(len);
+    if (!(span > 0) || !(distance > 0) || scale === 0)
+        return NONE;
+    return result((100 * Math.log10(distance / span)) / scale);
+}
+/** `chop(len)` as a tail. */
+export function chopTail(len = 14) {
+    return tailOf((state, bar) => chopStep(state, '', gapOf(state, 'g', bar), len));
+}
+/** `chop(len)` over a run of bars. */
+export function chop(bars, len = 14) {
+    return fold(chopTail(len), bars);
+}
+/**
+ * `hv(src, len, periodsPerYear)`: the annualised standard deviation of log
+ * returns, from bar `len`.
+ *
+ * A log return needs the previous bar, so the deviation's lookback starts at bar
+ * 1 and its first value is at bar `len`, one later than a lookback over levels.
+ *
+ * The result is a proportion, not a percentage: `stdlib.md` section 6 says
+ * "annualised standard deviation of log returns" and nothing about scaling it
+ * by a hundred, so nothing here does. A study that wants a percentage axis
+ * multiplies at the plot, where a reader can see it happen.
+ */
+export function hvStep(state, key, value, len, periodsPerYear) {
+    const previous = historyStep(state, `${key}h`, value, 1);
+    let logReturn = NONE;
+    if (isPresent(value) && isPresent(previous) && value > 0 && previous > 0) {
+        logReturn = result(Math.log(value / previous));
+    }
+    const deviation = stdevStep(state, `${key}q`, logReturn, len, false);
+    if (!isPresent(deviation) || periodsPerYear === null || !(periodsPerYear > 0))
+        return NONE;
+    return result(deviation * Math.sqrt(periodsPerYear));
+}
+/** `hv(src, len, periodsPerYear)` as a tail. */
+export function hvTail(len = 20, periodsPerYear = 252) {
+    return tailOf((state, value) => hvStep(state, '', value, len, periodsPerYear));
+}
+/** `hv(src, len, periodsPerYear)` over a whole series. */
+export function hv(src, len = 20, periodsPerYear = 252) {
+    return fold(hvTail(len, periodsPerYear), src);
+}
+//# sourceMappingURL=measures.js.map

package/dist/core/stdlib/volatility/measures.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"measures.js","sourceRoot":"","sources":["../../../../src/core/stdlib/volatility/measures.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAGvE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,QAAQ,CACtB,KAAkB,EAClB,GAAW,EACX,GAAQ,EACR,GAAkB;IAElB,MAAM,QAAQ,GAAG,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,WAAW,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC;IACzE,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,CAAC,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACxE,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACxE,IAAI,GAAG,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAC9B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAChF,MAAM,IAAI,GAAG,KAAK,GAAG,KAAK,CAAC;IAC3B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAC9B,IAAI,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAC/D,OAAO,MAAM,CAAC,CAAC,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC;AAC7D,CAAC;AAED,6BAA6B;AAC7B,MAAM,UAAU,QAAQ,CAAC,GAAG,GAAG,EAAE;IAC/B,OAAO,MAAM,CAAC,CAAC,KAAK,EAAE,GAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AACvF,CAAC;AAED,sCAAsC;AACtC,MAAM,UAAU,IAAI,CAAC,IAAoB,EAAE,GAAG,GAAG,EAAE;IACjD,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;AACnC,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,MAAM,CACpB,KAAkB,EAClB,GAAW,EACX,KAAY,EACZ,GAAkB,EAClB,cAA6B;IAE7B,MAAM,QAAQ,GAAG,WAAW,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;IACzD,IAAI,SAAS,GAAU,IAAI,CAAC;IAC5B,IAAI,SAAS,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QACzE,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC;IACjD,CAAC;IACD,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;IACrE,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,IAAI,cAAc,KAAK,IAAI,IAAI,CAAC,CAAC,cAAc,GAAG,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IAC3F,OAAO,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,CAAC;AACvD,CAAC;AAED,gDAAgD;AAChD,MAAM,UAAU,MAAM,CAAC,GAAG,GAAG,EAAE,EAAE,cAAc,GAAG,GAAG;IACnD,OAAO,MAAM,CAAC,CAAC,KAAK,EAAE,KAAY,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,cAAc,CAAC,CAAC,CAAC;AACxF,CAAC;AAED,0DAA0D;AAC1D,MAAM,UAAU,EAAE,CAAC,GAAW,EAAE,GAAG,GAAG,EAAE,EAAE,cAAc,GAAG,GAAG;IAC5D,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,cAAc,CAAC,EAAE,GAAG,CAAC,CAAC;AAChD,CAAC"}

package/dist/core/stdlib/volatility/range.d.ts

@@ -0,0 +1,69 @@
+/**
+ * True range, and the two averages of it.
+ *
+ * **Bar 0 is the one deliberate exception to absence propagation in this
+ * library**, and `stdlib.md` section 6 puts it there rather than leaving it to
+ * an engine. `trueRange()` on bar 0 is `high - low`: the other two terms need
+ * the previous close, which does not exist there, and propagating absence would
+ * start `atr` one bar later than every reference implementation while adding
+ * nothing, because the bar's own range is a true statement about that bar.
+ *
+ * The exception is granted to `trueRange` and therefore to `atr` and `natr`.
+ * It is not granted to every function that happens to use a range: where a
+ * function's declared warmup shows it counts changes rather than levels,
+ * `gapTrueRange` is the form it uses, and that one is absent on bar 0 like any
+ * other change. `chop` and `adx` are the two, and both of their warmups in
+ * `stdlib.md` are one bar later than the plain reading would give, which is how
+ * the specification says which form they take.
+ *
+ * **Where the previous close comes from is a host fact, not an arithmetic one.**
+ * A run of bars has it in the bar before; an engine is handed it with the bar,
+ * and that is the one it must use, because a call inside a branch does not see
+ * every bar and the close of the bar it last ran on is a different number. So
+ * the arithmetic below takes it as an argument and `gapOf` is the small piece
+ * that remembers it for a caller folding over a series.
+ */
+import type { Bar, StateRecord, Tail, Value } from '../values/index.js';
+/** A bar's two extremes and the close before it, which is what a range needs. */
+export interface Gap {
+    readonly high: Value;
+    readonly low: Value;
+    /** The close of the bar before this one, absent on the first bar. */
+    readonly previousClose: Value;
+    /** Whether this is the first bar of the run. */
+    readonly isFirstBar: boolean;
+}
+/** `trueRange()`: the bar's range including any gap from the previous close. */
+export declare function trueRangeOf(gap: Gap, allowFirstBar: boolean): Value;
+/**
+ * The previous close remembered in a region, for a caller folding over a run of
+ * bars rather than being handed one at a time.
+ */
+export declare function gapOf(state: StateRecord, key: string, bar: Bar): Gap;
+/** `trueRange()` as a tail. */
+export declare function trueRangeTail(): Tail<Bar, Value>;
+/**
+ * True range with no exception on bar 0, as a step: absent there, like any
+ * other quantity that needs the bar before it. Not a call a script can make;
+ * see this file's opening note for which functions use it and why.
+ */
+export declare function gapTrueRangeStep(state: StateRecord, key: string, bar: Bar): Value;
+/** `trueRange()` over a run of bars. */
+export declare function trueRange(bars: readonly Bar[]): Value[];
+/** The gap-aware true range as a tail. */
+export declare function gapTrueRangeTail(): Tail<Bar, Value>;
+/** The gap-aware true range over a run of bars. */
+export declare function gapTrueRange(bars: readonly Bar[]): Value[];
+/** `atr(len)`: the smoothed mean of true range, from bar `len - 1`. */
+export declare function atrStep(state: StateRecord, key: string, gap: Gap, len: number | null): Value;
+/** `atr(len)` as a tail. */
+export declare function atrTail(len: number): Tail<Bar, Value>;
+/** `atr(len)` over a run of bars. */
+export declare function atr(bars: readonly Bar[], len?: number): Value[];
+/** `natr(len)`: `atr` as a percentage of close, from bar `len - 1`. */
+export declare function natrStep(state: StateRecord, key: string, gap: Gap, close: Value, len: number | null): Value;
+/** `natr(len)` as a tail. */
+export declare function natrTail(len: number): Tail<Bar, Value>;
+/** `natr(len)` over a run of bars. */
+export declare function natr(bars: readonly Bar[], len?: number): Value[];
+//# sourceMappingURL=range.d.ts.map

package/dist/core/stdlib/volatility/range.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"range.d.ts","sourceRoot":"","sources":["../../../../src/core/stdlib/volatility/range.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,OAAO,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAIxE,iFAAiF;AACjF,MAAM,WAAW,GAAG;IAClB,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC;IACpB,qEAAqE;IACrE,QAAQ,CAAC,aAAa,EAAE,KAAK,CAAC;IAC9B,gDAAgD;IAChD,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;CAC9B;AAED,gFAAgF;AAChF,wBAAgB,WAAW,CAAC,GAAG,EAAE,GAAG,EAAE,aAAa,EAAE,OAAO,GAAG,KAAK,CAWnE;AAED;;;GAGG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,GAAG,CAapE;AAED,+BAA+B;AAC/B,wBAAgB,aAAa,IAAI,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAEhD;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,KAAK,CAEjF;AAED,wCAAwC;AACxC,wBAAgB,SAAS,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,GAAG,KAAK,EAAE,CAEvD;AAED,0CAA0C;AAC1C,wBAAgB,gBAAgB,IAAI,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAEnD;AAED,mDAAmD;AACnD,wBAAgB,YAAY,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,GAAG,KAAK,EAAE,CAE1D;AAED,uEAAuE;AACvE,wBAAgB,OAAO,CACrB,KAAK,EAAE,WAAW,EAClB,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,GAAG,EACR,GAAG,EAAE,MAAM,GAAG,IAAI,GACjB,KAAK,CAEP;AAED,4BAA4B;AAC5B,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAErD;AAED,qCAAqC;AACrC,wBAAgB,GAAG,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,EAAE,GAAG,SAAK,GAAG,KAAK,EAAE,CAE3D;AAED,uEAAuE;AACvE,wBAAgB,QAAQ,CACtB,KAAK,EAAE,WAAW,EAClB,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,KAAK,EACZ,GAAG,EAAE,MAAM,GAAG,IAAI,GACjB,KAAK,CAIP;AAED,6BAA6B;AAC7B,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAEtD;AAED,sCAAsC;AACtC,wBAAgB,IAAI,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,EAAE,GAAG,SAAK,GAAG,KAAK,EAAE,CAE5D"}

package/dist/core/stdlib/volatility/range.js

@@ -0,0 +1,86 @@
+import { NONE, fold, isPresent, result, tailOf } from '../values/index.js';
+import { rmaStep } from '../averages/index.js';
+/** `trueRange()`: the bar's range including any gap from the previous close. */
+export function trueRangeOf(gap, allowFirstBar) {
+    if (gap.isFirstBar) {
+        return allowFirstBar && isPresent(gap.high) && isPresent(gap.low)
+            ? result(gap.high - gap.low)
+            : NONE;
+    }
+    if (!isPresent(gap.high) || !isPresent(gap.low) || !isPresent(gap.previousClose))
+        return NONE;
+    const within = gap.high - gap.low;
+    const upGap = Math.abs(gap.high - gap.previousClose);
+    const downGap = Math.abs(gap.low - gap.previousClose);
+    return result(Math.max(within, upGap, downGap));
+}
+/**
+ * The previous close remembered in a region, for a caller folding over a run of
+ * bars rather than being handed one at a time.
+ */
+export function gapOf(state, key, bar) {
+    const closeKey = `${key}p`;
+    const seenKey = `${key}k`;
+    const held = state[closeKey];
+    const gap = {
+        high: bar.high,
+        low: bar.low,
+        previousClose: typeof held === 'number' ? held : NONE,
+        isFirstBar: state[seenKey] !== true,
+    };
+    state[seenKey] = true;
+    state[closeKey] = bar.close;
+    return gap;
+}
+/** `trueRange()` as a tail. */
+export function trueRangeTail() {
+    return tailOf((state, bar) => trueRangeOf(gapOf(state, 'g', bar), true));
+}
+/**
+ * True range with no exception on bar 0, as a step: absent there, like any
+ * other quantity that needs the bar before it. Not a call a script can make;
+ * see this file's opening note for which functions use it and why.
+ */
+export function gapTrueRangeStep(state, key, bar) {
+    return trueRangeOf(gapOf(state, `${key}g`, bar), false);
+}
+/** `trueRange()` over a run of bars. */
+export function trueRange(bars) {
+    return fold(trueRangeTail(), bars);
+}
+/** The gap-aware true range as a tail. */
+export function gapTrueRangeTail() {
+    return tailOf((state, bar) => gapTrueRangeStep(state, '', bar));
+}
+/** The gap-aware true range over a run of bars. */
+export function gapTrueRange(bars) {
+    return fold(gapTrueRangeTail(), bars);
+}
+/** `atr(len)`: the smoothed mean of true range, from bar `len - 1`. */
+export function atrStep(state, key, gap, len) {
+    return rmaStep(state, `${key}a`, trueRangeOf(gap, true), len);
+}
+/** `atr(len)` as a tail. */
+export function atrTail(len) {
+    return tailOf((state, bar) => atrStep(state, '', gapOf(state, 'g', bar), len));
+}
+/** `atr(len)` over a run of bars. */
+export function atr(bars, len = 14) {
+    return fold(atrTail(len), bars);
+}
+/** `natr(len)`: `atr` as a percentage of close, from bar `len - 1`. */
+export function natrStep(state, key, gap, close, len) {
+    const average = atrStep(state, key, gap, len);
+    if (!isPresent(average) || !isPresent(close) || close === 0)
+        return NONE;
+    return result((100 * average) / close);
+}
+/** `natr(len)` as a tail. */
+export function natrTail(len) {
+    return tailOf((state, bar) => natrStep(state, '', gapOf(state, 'g', bar), bar.close, len));
+}
+/** `natr(len)` over a run of bars. */
+export function natr(bars, len = 14) {
+    return fold(natrTail(len), bars);
+}
+//# sourceMappingURL=range.js.map

package/dist/core/stdlib/volatility/range.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"range.js","sourceRoot":"","sources":["../../../../src/core/stdlib/volatility/range.ts"],"names":[],"mappings":"AA0BA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC3E,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAY/C,gFAAgF;AAChF,MAAM,UAAU,WAAW,CAAC,GAAQ,EAAE,aAAsB;IAC1D,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;QACnB,OAAO,aAAa,IAAI,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC;YAC/D,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC;YAC5B,CAAC,CAAC,IAAI,CAAC;IACX,CAAC;IACD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,aAAa,CAAC;QAAE,OAAO,IAAI,CAAC;IAC9F,MAAM,MAAM,GAAG,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,GAAG,CAAC;IAClC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC;IACrD,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC;IACtD,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;AAClD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,KAAK,CAAC,KAAkB,EAAE,GAAW,EAAE,GAAQ;IAC7D,MAAM,QAAQ,GAAG,GAAG,GAAG,GAAG,CAAC;IAC3B,MAAM,OAAO,GAAG,GAAG,GAAG,GAAG,CAAC;IAC1B,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC7B,MAAM,GAAG,GAAQ;QACf,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,GAAG,EAAE,GAAG,CAAC,GAAG;QACZ,aAAa,EAAE,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI;QACrD,UAAU,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI;KACpC,CAAC;IACF,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;IACtB,KAAK,CAAC,QAAQ,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC;IAC5B,OAAO,GAAG,CAAC;AACb,CAAC;AAED,+BAA+B;AAC/B,MAAM,UAAU,aAAa;IAC3B,OAAO,MAAM,CAAC,CAAC,KAAK,EAAE,GAAQ,EAAE,EAAE,CAAC,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;AAChF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAkB,EAAE,GAAW,EAAE,GAAQ;IACxE,OAAO,WAAW,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;AAC1D,CAAC;AAED,wCAAwC;AACxC,MAAM,UAAU,SAAS,CAAC,IAAoB;IAC5C,OAAO,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,CAAC,CAAC;AACrC,CAAC;AAED,0CAA0C;AAC1C,MAAM,UAAU,gBAAgB;IAC9B,OAAO,MAAM,CAAC,CAAC,KAAK,EAAE,GAAQ,EAAE,EAAE,CAAC,gBAAgB,CAAC,KAAK,EAAE,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,mDAAmD;AACnD,MAAM,UAAU,YAAY,CAAC,IAAoB;IAC/C,OAAO,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,CAAC,CAAC;AACxC,CAAC;AAED,uEAAuE;AACvE,MAAM,UAAU,OAAO,CACrB,KAAkB,EAClB,GAAW,EACX,GAAQ,EACR,GAAkB;IAElB,OAAO,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,GAAG,EAAE,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,CAAC,CAAC;AAChE,CAAC;AAED,4BAA4B;AAC5B,MAAM,UAAU,OAAO,CAAC,GAAW;IACjC,OAAO,MAAM,CAAC,CAAC,KAAK,EAAE,GAAQ,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;AACtF,CAAC;AAED,qCAAqC;AACrC,MAAM,UAAU,GAAG,CAAC,IAAoB,EAAE,GAAG,GAAG,EAAE;IAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;AAClC,CAAC;AAED,uEAAuE;AACvE,MAAM,UAAU,QAAQ,CACtB,KAAkB,EAClB,GAAW,EACX,GAAQ,EACR,KAAY,EACZ,GAAkB;IAElB,MAAM,OAAO,GAAG,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;IAC9C,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACzE,OAAO,MAAM,CAAC,CAAC,GAAG,GAAG,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC;AACzC,CAAC;AAED,6BAA6B;AAC7B,MAAM,UAAU,QAAQ,CAAC,GAAW;IAClC,OAAO,MAAM,CAAC,CAAC,KAAK,EAAE,GAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,EAAE,KAAK,CAAC,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;AAClG,CAAC;AAED,sCAAsC;AACtC,MAAM,UAAU,IAAI,CAAC,IAAoB,EAAE,GAAG,GAAG,EAAE;IACjD,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;AACnC,CAAC"}

package/dist/core/stdlib/volume/accumulation.d.ts

@@ -0,0 +1,61 @@
+/**
+ * The running totals: `obv`, `ad`, `adOsc` and `pvt`.
+ *
+ * Every function in this module returns absence on every bar when the host
+ * supplies no volume, because `volume` is absent rather than zero there
+ * (`stdlib.md` sections 3.1 and 7). A script tests `chart.hasVolume` to branch
+ * on that rather than inspecting the result, and nothing here substitutes a
+ * zero to keep a line drawing.
+ *
+ * A running total is the one thing a lookback cannot stand in for, so each of
+ * these carries its total in the state region rather than in a closure: that is
+ * what lets an engine roll one back with the rest of a moving bar's state.
+ */
+import type { Bar, StateRecord, Tail, Value } from '../values/index.js';
+/**
+ * Where the close sat inside the bar, as -1 at the low to 1 at the high, times
+ * the volume behind it.
+ *
+ * A bar whose high and low are equal has no position inside it to report, and
+ * the settled treatment is that such a bar contributes nothing rather than
+ * ending the running total.
+ */
+export declare function moneyFlow(bar: Bar): Value;
+/** `obv()`: the running total of volume signed by the close's direction, from bar 0, seeded 0. */
+export declare function obvStep(state: StateRecord, key: string, bar: Bar): Value;
+/** `obv()` as a tail. */
+export declare function obvTail(): Tail<Bar, Value>;
+/** `obv()` over a run of bars. */
+export declare function obv(bars: readonly Bar[]): Value[];
+/** `ad()`: the running total of volume weighted by where the close sat, from bar 0. */
+export declare function adStep(state: StateRecord, key: string, bar: Bar): Value;
+/** `ad()` as a tail. */
+export declare function adTail(): Tail<Bar, Value>;
+/** `ad()` over a run of bars. */
+export declare function ad(bars: readonly Bar[]): Value[];
+/**
+ * `adOsc(fast, slow)`: the difference of two means of `ad`, from bar `slow - 1`.
+ *
+ * The averages run over the running total, not over the per-bar term, so what
+ * this measures is acceleration in accumulation rather than the flow itself.
+ */
+export declare function adOscStep(state: StateRecord, key: string, bar: Bar, fast: number | null, slow: number | null): Value;
+/** `adOsc(fast, slow)` as a tail. */
+export declare function adOscTail(fast?: number, slow?: number): Tail<Bar, Value>;
+/** `adOsc(fast, slow)` over a run of bars. */
+export declare function adOsc(bars: readonly Bar[], fast?: number, slow?: number): Value[];
+/**
+ * `pvt()`: the running total of volume weighted by percentage change, from bar
+ * 1, seeded 0.
+ *
+ * The total starts at zero before the first change, and the first change is at
+ * bar 1, so bar 0 is absent and bar 1 already carries its own term. Reporting a
+ * zero at bar 0 would claim a reading on a bar where the quantity is not
+ * defined.
+ */
+export declare function pvtStep(state: StateRecord, key: string, bar: Bar): Value;
+/** `pvt()` as a tail. */
+export declare function pvtTail(): Tail<Bar, Value>;
+/** `pvt()` over a run of bars. */
+export declare function pvt(bars: readonly Bar[]): Value[];
+//# sourceMappingURL=accumulation.d.ts.map

package/dist/core/stdlib/volume/accumulation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"accumulation.d.ts","sourceRoot":"","sources":["../../../../src/core/stdlib/volume/accumulation.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,OAAO,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAIxE;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,KAAK,CAMzC;AAED,kGAAkG;AAClG,wBAAgB,OAAO,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,KAAK,CAsBxE;AAED,yBAAyB;AACzB,wBAAgB,OAAO,IAAI,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAE1C;AAED,kCAAkC;AAClC,wBAAgB,GAAG,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,GAAG,KAAK,EAAE,CAEjD;AAED,uFAAuF;AACvF,wBAAgB,MAAM,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,KAAK,CAMvE;AAED,wBAAwB;AACxB,wBAAgB,MAAM,IAAI,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAEzC;AAED,iCAAiC;AACjC,wBAAgB,EAAE,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,GAAG,KAAK,EAAE,CAEhD;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,WAAW,EAClB,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,MAAM,GAAG,IAAI,EACnB,IAAI,EAAE,MAAM,GAAG,IAAI,GAClB,KAAK,CAMP;AAED,qCAAqC;AACrC,wBAAgB,SAAS,CAAC,IAAI,SAAI,EAAE,IAAI,SAAK,GAAG,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAE/D;AAED,8CAA8C;AAC9C,wBAAgB,KAAK,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,EAAE,IAAI,SAAI,EAAE,IAAI,SAAK,GAAG,KAAK,EAAE,CAExE;AAED;;;;;;;;GAQG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,WAAW,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,KAAK,CAexE;AAED,yBAAyB;AACzB,wBAAgB,OAAO,IAAI,IAAI,CAAC,GAAG,EAAE,KAAK,CAAC,CAE1C;AAED,kCAAkC;AAClC,wBAAgB,GAAG,CAAC,IAAI,EAAE,SAAS,GAAG,EAAE,GAAG,KAAK,EAAE,CAEjD"}