@thi.ng/dsp
Version:
Composable signal generators, oscillators, filters, FFT, spectrum, windowing & related DSP utils
29 lines • 1.01 kB
TypeScript
import { Add } from "./add.js";
/**
* Timebased version of {@link add}. Creates a new `Add` gen based on
* given `start` (default: 0) and `end` (default: 1) positions and
* tracing a line over `num` steps.
*
* @remarks
* Unless `skipFirst` is true, the `end` value is only reached at `num +
* 1` steps. The line will NOT stop at `end` but continue indefinitely
* if more than `n + 1` values are requested from the generator.
*
* @example
* ```ts tangle:../export/line.ts
* import { line } from "@thi.ng/dsp";
*
* console.log(
* line(0, 1, 5).take(7)
* );
* // [ 0, 0.2, 0.4, 0.6, 0.8, 1, 1.2 ]
* ```
*
* @param start - start value
* @param end - end value
* @param num - num steps (default: 10)
* @param skipFirst - true to skip start value (default: false)
* @param clampEnd - true to clamp curve at end value (default: false)
*/
export declare const line: (start?: number, end?: number, num?: number, skipFirst?: boolean, clampEnd?: boolean) => Add;
//# sourceMappingURL=line.d.ts.map