diff --git a/lib/node_modules/@stdlib/math/base/tools/docs/types/index.d.ts b/lib/node_modules/@stdlib/math/base/tools/docs/types/index.d.ts index 59a7fa73157b..7c5b95709b90 100644 --- a/lib/node_modules/@stdlib/math/base/tools/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/math/base/tools/docs/types/index.d.ts @@ -20,6 +20,8 @@ /* eslint-disable max-lines */ +import chebyshevSeries = require( '@stdlib/math/base/tools/chebyshev-series' ); +import chebyshevSeriesf = require( '@stdlib/math/base/tools/chebyshev-seriesf' ); import continuedFraction = require( '@stdlib/math/base/tools/continued-fraction' ); import evalpoly = require( '@stdlib/math/base/tools/evalpoly' ); import evalpolyf = require( '@stdlib/math/base/tools/evalpolyf' ); @@ -36,6 +38,62 @@ import sumSeries = require( '@stdlib/math/base/tools/sum-series' ); * Interface describing the `tools` namespace. */ interface Namespace { + /** + * Evaluates a Chebyshev series using double-precision floating-point arithmetic. + * + * ## Notes + * + * - The implementation uses [Clenshaw's recurrence algorithm][clenshaw]. + * - The function evaluates Chebyshev polynomials at `x/2`. + * + * [clenshaw]: https://en.wikipedia.org/wiki/Clenshaw_algorithm + * + * @param x - value at which to evaluate the Chebyshev series (expected to be in `[-2, 2]`) + * @param c - Chebyshev series coefficients ordered in descending degree + * @returns evaluated Chebyshev series + * + * @example + * var v = ns.chebyshevSeries( 1.0, [ 1.0, 0.5 ] ); // 1*T_0(1/2) + 0.5*T_1(1/2) + * // returns 0.75 + * + * @example + * var evaluate = ns.chebyshevSeries.factory( [ 1.0, 0.5 ] ); // 1*T_0(1/2) + 0.5*T_1(1/2) + * + * var v = evaluate( 1.0 ); + * // returns 0.75 + */ + chebyshevSeries: typeof chebyshevSeries; + + /** + * Evaluates a Chebyshev series using single-precision floating-point arithmetic. + * + * ## Notes + * + * - The implementation uses [Clenshaw's recurrence algorithm][clenshaw]. + * - The function evaluates Chebyshev polynomials at `x/2`. + * + * [clenshaw]: https://en.wikipedia.org/wiki/Clenshaw_algorithm + * + * @param x - value at which to evaluate the Chebyshev series (expected to be in `[-2, 2]`) + * @param c - Chebyshev series coefficients ordered in descending degree + * @returns evaluated Chebyshev series + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * + * var v = ns.chebyshevSeriesf( 1.0, new Float32Array( [ 1.0, 0.5 ] ) ); // 1*T_0(1/2) + 0.5*T_1(1/2) + * // returns 0.75 + * + * @example + * var Float32Array = require( '@stdlib/array/float32' ); + * + * var evaluate = ns.chebyshevSeriesf.factory( new Float32Array( [ 1.0, 0.5 ] ) ); // 1*T_0(1/2) + 0.5*T_1(1/2) + * + * var v = evaluate( 1.0 ); + * // returns 0.75 + */ + chebyshevSeriesf: typeof chebyshevSeriesf; + /** * Evaluates the continued fraction approximation for the supplied series generator using the modified Lentz algorithm. *