@thi.ng/dsp 4.1.3 → 4.2.0

package/power.js

@@ -3,7 +3,7 @@ import { isComplex } from "./complex.js";
 /**
  * Computes the sum of the given array.
  *
- * @param window
+ * @param window -
  */
 export const integralT = (window) => {
     let sum = 0;
@@ -15,7 +15,7 @@ export const integralT = (window) => {
 /**
  * Computes the squared sum of given array.
  *
- * @param window
+ * @param window -
  */
 export const integralTSquared = (window) => {
     let sum = 0;
@@ -27,7 +27,7 @@ export const integralTSquared = (window) => {
 /**
  * Computes the `sum(|c(i)|)` for given complex array.
  *
- * @param window
+ * @param window -
  */
 export const integralF = ([real, img]) => {
     let sum = 0;
@@ -39,7 +39,7 @@ export const integralF = ([real, img]) => {
 /**
  * Computes the `sum(|c(i)|^2)` for given complex array.
  *
- * @param window
+ * @param window -
  */
 export const integralFSquared = ([real, img]) => {
     let sum = 0;
@@ -51,15 +51,15 @@ export const integralFSquared = ([real, img]) => {
 /**
  * If `scale` is a number, returns it. Else returns `base / integralT(scale)`.
  *
- * @param scale
- * @param base
+ * @param scale -
+ * @param base -
  */
 export const powerScale = (scale, base = 1) => isNumber(scale) ? scale : base / integralT(scale);
 /**
  * If `scale` is a number, returns it. Else returns `integralT(scale) / base`.
  *
- * @param scale
- * @param base
+ * @param scale -
+ * @param base -
  */
 export const invPowerScale = (scale, base = 1) => isNumber(scale) ? scale : integralT(scale) / base;
 /**
@@ -70,7 +70,7 @@ export const invPowerScale = (scale, base = 1) => isNumber(scale) ? scale : inte
  * - http://www.it.uom.gr/teaching/linearalgebra/NumericalRecipiesInC/c13-4.pdf
  * - http://www.hep.ucl.ac.uk/~rjn/saltStuff/fftNormalisation.pdf
  *
- * @param window
+ * @param window -
  */
 export const powerSumSquared = (window) => isComplex(window)
     ? integralFSquared(window) / window[0].length
@@ -83,7 +83,7 @@ export const powerSumSquared = (window) => isComplex(window)
  * - http://www.it.uom.gr/teaching/linearalgebra/NumericalRecipiesInC/c13-4.pdf
  * - http://www.hep.ucl.ac.uk/~rjn/saltStuff/fftNormalisation.pdf
  *
- * @param window
+ * @param window -
  */
 export const powerMeanSquared = (window) => powerSumSquared(window) /
     (isComplex(window) ? window[0].length : window.length);
@@ -96,7 +96,7 @@ export const powerMeanSquared = (window) => powerSumSquared(window) /
  * - http://www.it.uom.gr/teaching/linearalgebra/NumericalRecipiesInC/c13-4.pdf
  * - http://www.hep.ucl.ac.uk/~rjn/saltStuff/fftNormalisation.pdf
  *
- * @param window
+ * @param window -
  */
 export const powerTimeIntegral = (window, fs) => (isComplex(window) ? integralFSquared(window) : integralTSquared(window)) /
     fs;

package/reciprocal.d.ts

@@ -3,7 +3,7 @@ import { AGen } from "./agen.js";
 /**
  * Returns a gen which yield sequence `y(t) = 1 / (y(t - 1) + step)`.
  *
- * @param step
+ * @param step -
  */
 export declare const reciprocal: (step?: number | undefined) => Reciprocal;
 export declare class Reciprocal extends AGen<number> implements IReset {

package/reciprocal.js

@@ -2,7 +2,7 @@ import { AGen } from "./agen.js";
 /**
  * Returns a gen which yield sequence `y(t) = 1 / (y(t - 1) + step)`.
  *
- * @param step
+ * @param step -
  */
 export const reciprocal = (step) => new Reciprocal(step);
 export class Reciprocal extends AGen {

package/serial.d.ts

@@ -8,8 +8,8 @@ import { AProc } from "./aproc.js";
  * @remarks
  * Provides optimized (loop free) versions for 2-4 inputs
  *
- * @param a
- * @param b
+ * @param a -
+ * @param b -
  */
 export declare function serial<A, B, C>(a: IProc<A, B>, b: IProc<B, C>): IProc<A, C>;
 export declare function serial<A, B, C, D>(a: IProc<A, B>, b: IProc<B, C>, c: IProc<C, D>): IProc<A, D>;

package/sweep.d.ts

@@ -18,10 +18,10 @@
  * // [...]
  * ```
  *
- * @param start
- * @param end
- * @param steps
- * @param rate
+ * @param start -
+ * @param end -
+ * @param steps -
+ * @param rate -
  * @param clamp - true, if clamp at `end` value
  */
 export declare const sweep: (start: number, end: number, steps: number, rate?: number | undefined, clamp?: boolean) => import("./api.js").IGen<number>;

package/sweep.js

@@ -20,10 +20,10 @@ import { curve } from "./curve.js";
  * // [...]
  * ```
  *
- * @param start
- * @param end
- * @param steps
- * @param rate
+ * @param start -
+ * @param end -
+ * @param steps -
+ * @param rate -
  * @param clamp - true, if clamp at `end` value
  */
 export const sweep = (start, end, steps, rate, clamp = true) => addG(curve(start, end, steps, rate, false, clamp));

package/window.d.ts

@@ -5,17 +5,17 @@ import type { WindowFn } from "./api.js";
  * The buffer size MUST be the same as the signal length given to
  * {@link fft}.
  *
- * @param fn
- * @param lenOfBuf
+ * @param fn -
+ * @param lenOfBuf -
  */
 export declare const window: (fn: WindowFn, lenOfBuf: number | FloatArray) => FloatArray;
 /**
  * Takes a `signal` and `window` buffer and multiplies both elementwise. Writes
  * results into `out` (or back into `signal` by default).
  *
- * @param signal
- * @param window
- * @param out
+ * @param signal -
+ * @param window -
+ * @param out -
  */
 export declare const applyWindow: (signal: NumericArray, window: NumericArray, out?: NumericArray) => NumericArray;
 export declare const windowRect: WindowFn;

package/window.js

@@ -10,8 +10,8 @@ const cos = Math.cos;
  * The buffer size MUST be the same as the signal length given to
  * {@link fft}.
  *
- * @param fn
- * @param lenOfBuf
+ * @param fn -
+ * @param lenOfBuf -
  */
 export const window = (fn, lenOfBuf) => {
     const buf = isNumber(lenOfBuf) ? new Float64Array(lenOfBuf) : lenOfBuf;
@@ -25,9 +25,9 @@ export const window = (fn, lenOfBuf) => {
  * Takes a `signal` and `window` buffer and multiplies both elementwise. Writes
  * results into `out` (or back into `signal` by default).
  *
- * @param signal
- * @param window
- * @param out
+ * @param signal -
+ * @param window -
+ * @param out -
  */
 export const applyWindow = (signal, window, out = signal) => {
     for (let i = signal.length; i-- > 0;) {