@thi.ng/dsp 4.2.24 → 4.2.26

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2022-11-30T22:27:37Z
+- **Last updated**: 2022-12-20T16:33:11Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/README.md

@@ -1,10 +1,10 @@
 <!-- This file is generated - DO NOT EDIT! -->
 
-# ![dsp](https://media.thi.ng/umbrella/banners-20220914/thing-dsp.svg?5dc8dc3b)
+# ![@thi.ng/dsp](https://media.thi.ng/umbrella/banners-20220914/thing-dsp.svg?5dc8dc3b)
 
 [![npm version](https://img.shields.io/npm/v/@thi.ng/dsp.svg)](https://www.npmjs.com/package/@thi.ng/dsp)
 ![npm downloads](https://img.shields.io/npm/dm/@thi.ng/dsp.svg)
-[![Twitter Follow](https://img.shields.io/twitter/follow/thing_umbrella.svg?style=flat-square&label=twitter)](https://twitter.com/thing_umbrella)
+[![Mastodon Follow](https://img.shields.io/mastodon/follow/109331703950160316?domain=https%3A%2F%2Fmastodon.thi.ng&style=social)](https://mastodon.thi.ng/@toxi)
 
 This project is part of the
 [@thi.ng/umbrella](https://github.com/thi-ng/umbrella/) monorepo.
@@ -35,7 +35,7 @@ This project is part of the
 
 ## About
 
-Composable signal generators, oscillators, filters, FFT, spectrum, windowing & related DSP utils.
+Composable signal generators, oscillators, filters, FFT, spectrum, windowing & related DSP utils
 
 Partially ported from other thi.ng projects (e.g.
 [thi.ng/synstack](https://github.com/thi-ng/synstack),
@@ -79,11 +79,8 @@ ES module import:
 
 For Node.js REPL:
 
-```text
-# with flag only for < v16
-node --experimental-repl-await
-
-> const dsp = await import("@thi.ng/dsp");
+```js
+const dsp = await import("@thi.ng/dsp");
 ```
 
 Package sizes (brotli'd, pre-treeshake): ESM: 6.84 KB
@@ -569,7 +566,7 @@ Desmos](https://www.desmos.com/calculator/lkyf2ag3ta) to experiment.
 
 ## Authors
 
-Karsten Schmidt
+- [Karsten Schmidt](https://thi.ng)
 
 If this project contributes to an academic publication, please cite it as:
 
@@ -584,4 +581,4 @@ If this project contributes to an academic publication, please cite it as:
 
 ## License
 
-&copy; 2015 - 2022 Karsten Schmidt // Apache Software License 2.0
+&copy; 2015 - 2022 Karsten Schmidt // Apache License 2.0

package/agen.d.ts

@@ -1,8 +1,9 @@
 import type { IGen } from "./api.js";
 /**
  * Abstract base class for unit gens in this package. Provides
- * {@link @thi.ng/api#IDeref} to obtain the gen's current value and
- * `Iterable` implementations to use gens as ES6 iterables.
+ * [`IDeref`](https://docs.thi.ng/umbrella/api/interfaces/IDeref.html) to obtain
+ * the gen's current value and `Iterable` implementations to use gens as ES6
+ * iterables.
  */
 export declare abstract class AGen<T> implements IGen<T> {
     protected _val: T;

package/agen.js

@@ -1,8 +1,9 @@
 import { __take } from "./internal/take.js";
 /**
  * Abstract base class for unit gens in this package. Provides
- * {@link @thi.ng/api#IDeref} to obtain the gen's current value and
- * `Iterable` implementations to use gens as ES6 iterables.
+ * [`IDeref`](https://docs.thi.ng/umbrella/api/interfaces/IDeref.html) to obtain
+ * the gen's current value and `Iterable` implementations to use gens as ES6
+ * iterables.
  */
 export class AGen {
     constructor(_val) {

package/anti-alias.d.ts

@@ -1,11 +1,10 @@
 import type { FnN2 } from "@thi.ng/api";
 /**
  * Reference:
- * - {@link https://en.wikipedia.org/wiki/Gibbs_phenomenon}
- * - {@link http://www.musicdsp.org/files/bandlimited.pdf}
+ * - https://en.wikipedia.org/wiki/Gibbs_phenomenon
+ * - http://www.musicdsp.org/files/bandlimited.pdf
  *
- * Interactive graph:
- * {@link https://www.desmos.com/calculator/irugw6gnhy}
+ * [Interactive graph](https://www.desmos.com/calculator/irugw6gnhy)
  *
  * @param n - number of octaves
  * @param i - curr octave [1..n]
@@ -15,9 +14,9 @@ export declare const gibbs: FnN2;
  * Fejér weight for `k`-th harmonic in a Fourier series of length `n`.
  *
  * @remarks
- * Used for attenuating the {@link gibbs} factor when summing a Fourier
- * series. Linearly attentuates higher harmonics, with the first bin
- * receiving a weight on 1 and the last bin `1/n`.
+ * Used for attenuating the {@link gibbs} factor when summing a Fourier series.
+ * Linearly attentuates higher harmonics, with the first bin receiving a weight
+ * on 1 and the last bin `1/n`.
  *
  * @param k -
  * @param n -
@@ -26,8 +25,8 @@ export declare const fejer: FnN2;
 /**
  * Polynomial attenuation to create bandlimited version of a signal.
  *
- * - {@link http://research.spa.aalto.fi/publications/papers/smc2010-phaseshaping/}
- * - {@link http://www.kvraudio.com/forum/viewtopic.php?t=375517}
+ * - http://research.spa.aalto.fi/publications/papers/smc2010-phaseshaping/
+ * - http://www.kvraudio.com/forum/viewtopic.php?t=375517
  *
  * @param dt - time step
  * @param t - normalized phase

package/anti-alias.js

@@ -1,11 +1,10 @@
 import { HALF_PI } from "@thi.ng/math/api";
 /**
  * Reference:
- * - {@link https://en.wikipedia.org/wiki/Gibbs_phenomenon}
- * - {@link http://www.musicdsp.org/files/bandlimited.pdf}
+ * - https://en.wikipedia.org/wiki/Gibbs_phenomenon
+ * - http://www.musicdsp.org/files/bandlimited.pdf
  *
- * Interactive graph:
- * {@link https://www.desmos.com/calculator/irugw6gnhy}
+ * [Interactive graph](https://www.desmos.com/calculator/irugw6gnhy)
  *
  * @param n - number of octaves
  * @param i - curr octave [1..n]
@@ -15,9 +14,9 @@ export const gibbs = (n, i) => Math.cos(((i - 1) * HALF_PI) / n) ** 2;
  * Fejér weight for `k`-th harmonic in a Fourier series of length `n`.
  *
  * @remarks
- * Used for attenuating the {@link gibbs} factor when summing a Fourier
- * series. Linearly attentuates higher harmonics, with the first bin
- * receiving a weight on 1 and the last bin `1/n`.
+ * Used for attenuating the {@link gibbs} factor when summing a Fourier series.
+ * Linearly attentuates higher harmonics, with the first bin receiving a weight
+ * on 1 and the last bin `1/n`.
  *
  * @param k -
  * @param n -
@@ -26,8 +25,8 @@ export const fejer = (k, n) => (n - k) / n;
 /**
  * Polynomial attenuation to create bandlimited version of a signal.
  *
- * - {@link http://research.spa.aalto.fi/publications/papers/smc2010-phaseshaping/}
- * - {@link http://www.kvraudio.com/forum/viewtopic.php?t=375517}
+ * - http://research.spa.aalto.fi/publications/papers/smc2010-phaseshaping/
+ * - http://www.kvraudio.com/forum/viewtopic.php?t=375517
  *
  * @param dt - time step
  * @param t - normalized phase

package/api.d.ts

@@ -1,7 +1,7 @@
 import type { FnN2, IDeref, NumericArray } from "@thi.ng/api";
-export declare type StatelessOscillator = (phase: number, freq: number, amp?: number, dc?: number, ...opts: any[]) => number;
-export declare type ComplexArray = [NumericArray, NumericArray];
-export declare type WindowFn = FnN2;
+export type StatelessOscillator = (phase: number, freq: number, amp?: number, dc?: number, ...opts: any[]) => number;
+export type ComplexArray = [NumericArray, NumericArray];
+export type WindowFn = FnN2;
 export interface IGen<T> extends Iterable<T>, IDeref<T> {
     next(): T;
     take(num: number, out?: T[], idx?: number): T[];
@@ -28,8 +28,8 @@ export interface IFilter {
      */
     filterCoeffs(): FilterConfig;
 }
-export declare type FilterType = "lp" | "hp" | "bp" | "notch" | "peak" | "loshelf" | "hishelf" | "all";
-export declare type BiquadType = "lp" | "hp" | "bp" | "notch" | "peak" | "loshelf" | "hishelf";
-export declare type OnepoleType = "lp" | "hp";
-export declare type SVFType = "lp" | "hp" | "bp" | "notch" | "peak" | "all";
+export type FilterType = "lp" | "hp" | "bp" | "notch" | "peak" | "loshelf" | "hishelf" | "all";
+export type BiquadType = "lp" | "hp" | "bp" | "notch" | "peak" | "loshelf" | "hishelf";
+export type OnepoleType = "lp" | "hp";
+export type SVFType = "lp" | "hp" | "bp" | "notch" | "peak" | "all";
 //# sourceMappingURL=api.d.ts.map

package/aproc.d.ts

@@ -2,7 +2,8 @@ import type { IXform } from "@thi.ng/transducers";
 import type { IProc, IProc2 } from "./api.js";
 /**
  * Abstract base class for processors in this package. Provides
- * {@link @thi.ng/api#IDeref} to obtain the processor's current value.
+ * [`IDeref`](https://docs.thi.ng/umbrella/api/interfaces/IDeref.html) to obtain
+ * the processor's current value.
  */
 export declare abstract class AProc<A, B> implements IProc<A, B>, IXform<A, B> {
     protected _val: B;

package/aproc.js

@@ -1,7 +1,8 @@
 import { map } from "@thi.ng/transducers/map";
 /**
  * Abstract base class for processors in this package. Provides
- * {@link @thi.ng/api#IDeref} to obtain the processor's current value.
+ * [`IDeref`](https://docs.thi.ng/umbrella/api/interfaces/IDeref.html) to obtain
+ * the processor's current value.
  */
 export class AProc {
     constructor(_val) {

package/fft.d.ts

@@ -13,17 +13,18 @@ export declare const complexArray: (n: number) => ComplexArray;
  */
 export declare const copyComplex: (complex: ComplexArray) => ComplexArray;
 /**
- * If given a {@link ComplexArray}, computes the complex conjugate,
- * concatenates it in mirrored order to input (excluding bin 0) and
- * returns it as new (complex) array.
+ * If given a {@link ComplexArray}, computes the complex conjugate, concatenates
+ * it in mirrored order to input (excluding bin 0) and returns it as new
+ * (complex) array.
  *
  * @remarks
  * The length of the input buffer(s) is assumed to be a power of 2.
  *
- * If given a {@link @thi.ng/api#NumericArray}, the `isImg` arg chooses
- * from one of the following operations: If `true` (default), returns
- * new array with *negated* values concatenated in reverse order. If
- * `false`, returns new array with *original* values concatenated in
+ * If given a
+ * [`NumericArray`](https://docs.thi.ng/umbrella/api/types/NumericArray.html),
+ * the `isImg` arg chooses from one of the following operations: If `true`
+ * (default), returns new array with *negated* values concatenated in reverse
+ * order. If `false`, returns new array with *original* values concatenated in
  * reverse order.
  *
  * @example

package/osc-additive.d.ts

@@ -17,14 +17,14 @@ import type { StatelessOscillator } from "./api.js";
 export declare const additive: (osc: StatelessOscillator, freqFn: Fn<number, number>, ampFn: Fn<number, number>, n: number) => StatelessOscillator;
 /**
  * Interactive graph of this oscillator:
- * {@link https://www.desmos.com/calculator/irugw6gnhy}
+ * https://www.desmos.com/calculator/irugw6gnhy
  *
  * @param n - number of octaves
  */
 export declare const squareAdditive: (n?: number) => StatelessOscillator;
 /**
  * Interactive graph of this oscillator:
- * {@link https://www.desmos.com/calculator/irugw6gnhy}
+ * https://www.desmos.com/calculator/irugw6gnhy
  *
  * @param n - number of octaves
  */

package/osc-additive.js

@@ -31,14 +31,14 @@ export const additive = (osc, freqFn, ampFn, n) => {
 };
 /**
  * Interactive graph of this oscillator:
- * {@link https://www.desmos.com/calculator/irugw6gnhy}
+ * https://www.desmos.com/calculator/irugw6gnhy
  *
  * @param n - number of octaves
  */
 export const squareAdditive = (n = 8) => additive(sin, (i) => 2 * (i - 1) + 1, (i) => (1 / (2 * (i - 1) + 1)) * gibbs(n, i), n);
 /**
  * Interactive graph of this oscillator:
- * {@link https://www.desmos.com/calculator/irugw6gnhy}
+ * https://www.desmos.com/calculator/irugw6gnhy
  *
  * @param n - number of octaves
  */

package/osc.d.ts

@@ -13,7 +13,8 @@ import type { IGen, StatelessOscillator } from "./api.js";
  * freq and its `dc` offset to `baseFreq * TAU`). Also see {@link fmodOsc} for
  * syntax sugar. The `phase` arg is only used if `freq` is NOT an `IGen`.
  *
- * The oscillator initializes to zero and its {@link @thi.ng/api#IDeref.deref}
+ * The oscillator initializes to zero and its
+ * [`IDeref`](https://docs.thi.ng/umbrella/api/interfaces/IDeref.html).deref}
  * value is only available / valid after the first invocation of
  * {@link IGen.next}.
  *

package/osc.js

@@ -16,7 +16,8 @@ import { sum } from "./sum.js";
  * freq and its `dc` offset to `baseFreq * TAU`). Also see {@link fmodOsc} for
  * syntax sugar. The `phase` arg is only used if `freq` is NOT an `IGen`.
  *
- * The oscillator initializes to zero and its {@link @thi.ng/api#IDeref.deref}
+ * The oscillator initializes to zero and its
+ * [`IDeref`](https://docs.thi.ng/umbrella/api/interfaces/IDeref.html).deref}
  * value is only available / valid after the first invocation of
  * {@link IGen.next}.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/dsp",
-  "version": "4.2.24",
+  "version": "4.2.26",
   "description": "Composable signal generators, oscillators, filters, FFT, spectrum, windowing & related DSP utils",
   "type": "module",
   "module": "./index.js",
@@ -21,11 +21,11 @@
       "url": "https://patreon.com/thing_umbrella"
     }
   ],
-  "author": "Karsten Schmidt <k+npm@thi.ng>",
+  "author": "Karsten Schmidt (https://thi.ng)",
   "license": "Apache-2.0",
   "scripts": {
     "build": "yarn clean && tsc --declaration",
-    "clean": "rimraf '*.js' '*.d.ts' '*.map' doc",
+    "clean": "rimraf '*.js' '*.d.ts' '*.map' doc internal",
     "doc": "typedoc --excludePrivate --excludeInternal --out doc src/index.ts",
     "doc:ae": "mkdir -p .ae/doc .ae/temp && api-extractor run --local --verbose",
     "doc:readme": "yarn doc:stats && tools:readme",
@@ -34,20 +34,20 @@
     "test": "testament test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.5.1",
-    "@thi.ng/checks": "^3.3.4",
-    "@thi.ng/errors": "^2.2.5",
-    "@thi.ng/math": "^5.3.15",
-    "@thi.ng/random": "^3.3.17",
-    "@thi.ng/transducers": "^8.3.25"
+    "@thi.ng/api": "^8.6.1",
+    "@thi.ng/checks": "^3.3.5",
+    "@thi.ng/errors": "^2.2.6",
+    "@thi.ng/math": "^5.3.17",
+    "@thi.ng/random": "^3.3.19",
+    "@thi.ng/transducers": "^8.3.27"
   },
   "devDependencies": {
-    "@microsoft/api-extractor": "^7.33.5",
-    "@thi.ng/testament": "^0.3.6",
+    "@microsoft/api-extractor": "^7.33.7",
+    "@thi.ng/testament": "^0.3.7",
     "rimraf": "^3.0.2",
     "tools": "^0.0.1",
-    "typedoc": "^0.23.20",
-    "typescript": "^4.8.4"
+    "typedoc": "^0.23.22",
+    "typescript": "^4.9.4"
   },
   "keywords": [
     "allpass",
@@ -272,5 +272,5 @@
     ],
     "year": 2015
   },
-  "gitHead": "1fe40da507070653f420156d91e6b27cf682004f\n"
+  "gitHead": "7b2af448da8a63fb21704a79cc4cdf1f3d7d7a64\n"
 }

package/pink-noise.d.ts

@@ -1,7 +1,7 @@
 import type { IReset, Tuple } from "@thi.ng/api";
 import type { IRandom } from "@thi.ng/random";
 import { AGen } from "./agen.js";
-declare type PNoiseCoeffs = Tuple<number, 5>;
+type PNoiseCoeffs = Tuple<number, 5>;
 /**
  * Pink noise generator with customizable frequency distribution. The
  * default config produces a power spectrum roughly following the `1/f`

package/waveshaper.d.ts

@@ -1,6 +1,6 @@
 import type { Fn2 } from "@thi.ng/api";
 import { AProc } from "./aproc.js";
-export declare type WaveShaperFn = Fn2<number, number, number>;
+export type WaveShaperFn = Fn2<number, number, number>;
 /**
  * Customizable wave shaper for user defined shaping function supporting
  * one (optional, implementation specific) adjustable curve parameter.

package/white-noise.d.ts

@@ -3,7 +3,8 @@ import type { IRandom } from "@thi.ng/random";
 import { AGen } from "./agen.js";
 /**
  * White noise gen with customizable gain and
- * {@link @thi.ng/random#IRandom} source.
+ * [`IRandom`](https://docs.thi.ng/umbrella/random/interfaces/IRandom.html)
+ * source.
  *
  * @param gain -
  * @param rnd -

package/white-noise.js

@@ -2,7 +2,8 @@ import { SYSTEM } from "@thi.ng/random/system";
 import { AGen } from "./agen.js";
 /**
  * White noise gen with customizable gain and
- * {@link @thi.ng/random#IRandom} source.
+ * [`IRandom`](https://docs.thi.ng/umbrella/random/interfaces/IRandom.html)
+ * source.
  *
  * @param gain -
  * @param rnd -