Skip to content

Commit 42581f1

Browse files
committed
docs: update descriptions
1 parent ad7a467 commit 42581f1

File tree

7 files changed

+18
-16
lines changed

7 files changed

+18
-16
lines changed

lib/node_modules/@stdlib/math/base/tools/normhermitepoly/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# Normalized Hermite Polynomial
2222

23-
> Evaluate a normalized [Hermite polynomial][hermite-polynomial].
23+
> Evaluate a normalized [Hermite polynomial][hermite-polynomial] using double-precision floating-point arithmetic.
2424
2525
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
2626

@@ -57,7 +57,7 @@ var normhermitepoly = require( '@stdlib/math/base/tools/normhermitepoly' );
5757

5858
#### normhermitepoly( n, x )
5959

60-
Evaluates a normalized [Hermite polynomial][hermite-polynomial] of degree `n`.
60+
Evaluates a normalized [Hermite polynomial][hermite-polynomial] of degree `n` using double-precision floating-point arithmetic.
6161

6262
```javascript
6363
var v = normhermitepoly( 1, 1.0 );
@@ -78,7 +78,7 @@ v = normhermitepoly( -1, 0.5 );
7878

7979
#### normhermitepoly.factory( n )
8080

81-
Returns a `function` for evaluating a normalized [Hermite polynomial][hermite-polynomial] of degree `n`.
81+
Returns a function for evaluating a normalized [Hermite polynomial][hermite-polynomial] of degree `n` using double-precision floating-point arithmetic.
8282

8383
```javascript
8484
var polyval = normhermitepoly.factory( 2 );

lib/node_modules/@stdlib/math/base/tools/normhermitepoly/docs/repl.txt

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11

22
{{alias}}( n, x )
3-
Evaluates a normalized Hermite polynomial.
3+
Evaluates a normalized Hermite polynomial using double-precision floating-
4+
point arithmetic.
45

56
Parameters
67
----------
@@ -28,7 +29,8 @@
2829

2930

3031
{{alias}}.factory( n )
31-
Returns a function for evaluating a normalized Hermite polynomial.
32+
Returns a function for evaluating a normalized Hermite polynomial using
33+
double-precision floating-point arithmetic.
3234

3335
Parameters
3436
----------
@@ -42,8 +44,8 @@
4244

4345
Examples
4446
--------
45-
> var polyval = {{alias}}.factory( 2 );
46-
> var v = polyval( 0.5 )
47+
> var f = {{alias}}.factory( 2 );
48+
> var v = f( 0.5 )
4749
-0.75
4850

4951
See Also

lib/node_modules/@stdlib/math/base/tools/normhermitepoly/docs/types/index.d.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
/// <reference types="@stdlib/types"/>
2222

2323
/**
24-
* Evaluates a normalized Hermite polynomial.
24+
* Evaluates a normalized Hermite polynomial using double-precision floating-point arithmetic.
2525
*
2626
* @param x - value at which to evaluate a normalized Hermite polynomial
2727
* @returns result
@@ -33,7 +33,7 @@ type EvaluationFunction = ( x: number ) => number;
3333
*/
3434
interface NormHermitePoly {
3535
/**
36-
* Evaluates a normalized Hermite polynomial.
36+
* Evaluates a normalized Hermite polynomial using double-precision floating-point arithmetic.
3737
*
3838
* @param n - nonnegative polynomial degree
3939
* @param x - evaluation point
@@ -58,7 +58,7 @@ interface NormHermitePoly {
5858
( n: number, x: number ): number;
5959

6060
/**
61-
* Returns a function for evaluating a normalized Hermite polynomial.
61+
* Returns a function for evaluating a normalized Hermite polynomial using double-precision floating-point arithmetic.
6262
*
6363
* @param n - polynomial degree
6464
* @returns function for evaluating a normalized Hermite polynomial
@@ -73,7 +73,7 @@ interface NormHermitePoly {
7373
}
7474

7575
/**
76-
* Evaluates a normalized Hermite polynomial.
76+
* Evaluates a normalized Hermite polynomial using double-precision floating-point arithmetic.
7777
*
7878
* @param n - nonnegative polynomial degree
7979
* @param x - evaluation point

lib/node_modules/@stdlib/math/base/tools/normhermitepoly/lib/factory.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ var isint = require( '@stdlib/math/base/assert/is-integer' );
2828
// MAIN //
2929

3030
/**
31-
* Returns a function for evaluating a normalized Hermite polynomial.
31+
* Returns a function for evaluating a normalized Hermite polynomial using double-precision floating-point arithmetic.
3232
*
3333
* @param {NonNegativeInteger} n - polynomial degree
3434
* @returns {Function} function for evaluating a normalized Hermite polynomial
@@ -49,7 +49,7 @@ function factory( n ) {
4949
return polyval;
5050

5151
/**
52-
* Evaluates a normalized Hermite polynomial.
52+
* Evaluates a normalized Hermite polynomial using double-precision floating-point arithmetic.
5353
*
5454
* @private
5555
* @param {number} x - value at which to evaluate a normalized Hermite polynomial

lib/node_modules/@stdlib/math/base/tools/normhermitepoly/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Evaluate a normalized Hermite polynomial.
22+
* Evaluate a normalized Hermite polynomial using double-precision floating-point arithmetic.
2323
*
2424
* @module @stdlib/math/base/tools/normhermitepoly
2525
*

lib/node_modules/@stdlib/math/base/tools/normhermitepoly/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ var isint = require( '@stdlib/math/base/assert/is-integer' );
2727
// MAIN //
2828

2929
/**
30-
* Evaluates a normalized Hermite polynomial.
30+
* Evaluates a normalized Hermite polynomial using double-precision floating-point arithmetic.
3131
*
3232
* @param {NonNegativeInteger} n - nonnegative polynomial degree
3333
* @param {number} x - evaluation point

lib/node_modules/@stdlib/math/base/tools/normhermitepoly/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/math/base/tools/normhermitepoly",
33
"version": "0.0.0",
4-
"description": "Evaluate a normalized Hermite polynomial.",
4+
"description": "Evaluate a normalized Hermite polynomial using double-precision floating-point arithmetic.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

0 commit comments

Comments
 (0)