Skip to content

Commit 1afca5f

Browse files
authored
docs: update copy
Signed-off-by: Athan <kgryte@gmail.com>
1 parent a8524ca commit 1afca5f

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

  • lib/node_modules/@stdlib/math/base/tools/chebyshev-series

lib/node_modules/@stdlib/math/base/tools/chebyshev-series/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,8 @@ var v = chebyshevSeries( 1.0, [ 1.0, 0.5 ] );
6262
// returns 0.75
6363
```
6464

65+
The function evaluates Chebyshev polynomials at `x/2`.
66+
6567
#### chebyshevSeries.factory( c )
6668

6769
Uses code generation to in-line coefficients and return a function for evaluating a [Chebyshev series][chebyshev-series] using double-precision floating-point arithmetic.
@@ -74,6 +76,8 @@ var v = evaluate( 1.0 );
7476
// returns 0.75
7577
```
7678

79+
The returned function evaluates Chebyshev polynomials at `x/2`.
80+
7781
</section>
7882

7983
<!-- /.usage -->
@@ -83,7 +87,6 @@ var v = evaluate( 1.0 );
8387
## Notes
8488

8589
- The value at which to evaluate a Chebyshev series is expected to reside on the interval `[-2, 2]`.
86-
- The function evaluates Chebyshev polynomials at `x/2`.
8790
- The coefficients `c` **must be** be ordered in **descending** degree.
8891
- For hot code paths in which coefficients are invariant, a compiled function will be more performant than `chebyshevSeries()`.
8992
- While code generation can boost performance, its use may be problematic in browser contexts enforcing a strict [content security policy][mdn-csp] (CSP). If running in or targeting an environment with a CSP, avoid using code generation.

0 commit comments

Comments
 (0)