Skip to content

Commit 73a211c

Browse files
authored
docs: update function description and cleanup for math/base/special/dirac-deltaf
PR-URL: #4778 Reviewed-by: Athan Reines <[email protected]>
1 parent fd335df commit 73a211c

File tree

10 files changed

+14
-14
lines changed

10 files changed

+14
-14
lines changed

lib/node_modules/@stdlib/math/base/special/dirac-deltaf/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
# Dirac Delta
2222

23-
> Evaluate the [Dirac delta function][dirac-delta-function] in single-precision floating-point format.
23+
> Evaluate the [Dirac delta function][dirac-delta-function] for a single-precision floating-point number.
2424
2525
<section class="intro">
2626

@@ -70,7 +70,7 @@ var diracDeltaf = require( '@stdlib/math/base/special/dirac-deltaf' );
7070

7171
#### diracDeltaf( x )
7272

73-
Evaluates the [Dirac delta function][dirac-delta-function] in single-precision floating-point format.
73+
Evaluates the [Dirac delta function][dirac-delta-function] for a single-precision floating-point number.
7474

7575
```javascript
7676
var v = diracDeltaf( 0.0 );
@@ -137,7 +137,7 @@ for ( i = 0; i < x.length; i++ ) {
137137

138138
#### stdlib_base_dirac_deltaf( x )
139139

140-
Evaluates the [Dirac delta function][dirac-delta-function] in single-precision floating-point format.
140+
Evaluates the [Dirac delta function][dirac-delta-function] for a single-precision floating-point number.
141141

142142
```c
143143
float x = stdlib_base_dirac_deltaf( 0.0f );

lib/node_modules/@stdlib/math/base/special/dirac-deltaf/benchmark/c/benchmark.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ static double rand_float( void ) {
8989
* @param x input value
9090
* @return function result
9191
*/
92-
float dirac_deltaf( float x ) {
92+
static float dirac_deltaf( float x ) {
9393
if ( x == 0.0f ) {
9494
return HUGE_VAL;
9595
}

lib/node_modules/@stdlib/math/base/special/dirac-deltaf/docs/repl.txt

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

22
{{alias}}( x )
3-
Evaluates the Dirac delta function in single-precision
4-
floating-point format.
3+
Evaluates the Dirac delta function for a single-precision
4+
floating-point number.
55

66
Parameters
77
----------

lib/node_modules/@stdlib/math/base/special/dirac-deltaf/docs/types/index.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
// TypeScript Version: 4.1
2020

2121
/**
22-
* Evaluates the Dirac delta function in single-precision floating-point format.
22+
* Evaluates the Dirac delta function for a single-precision floating-point number.
2323
*
2424
* @param x - input value
2525
* @returns function value

lib/node_modules/@stdlib/math/base/special/dirac-deltaf/include/stdlib/math/base/special/dirac_deltaf.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ extern "C" {
2727
#endif
2828

2929
/**
30-
* Evaluates the Dirac delta function in single-precision floating-point format.
30+
* Evaluates the Dirac delta function for a single-precision floating-point number.
3131
*/
3232
float stdlib_base_dirac_deltaf( const float x );
3333

lib/node_modules/@stdlib/math/base/special/dirac-deltaf/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 the Dirac delta function in single-precision floating-point format.
22+
* Evaluate the Dirac delta function for a single-precision floating-point number.
2323
*
2424
* @module @stdlib/math/base/special/dirac-deltaf
2525
*

lib/node_modules/@stdlib/math/base/special/dirac-deltaf/lib/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ var PINF = require( '@stdlib/constants/float32/pinf' );
2727
// MAIN //
2828

2929
/**
30-
* Evaluates the Dirac delta function in single-precision floating-point format.
30+
* Evaluates the Dirac delta function for a single-precision floating-point number.
3131
*
3232
* @param {number} x - input value
3333
* @returns {number} function value

lib/node_modules/@stdlib/math/base/special/dirac-deltaf/lib/native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' );
2626
// MAIN //
2727

2828
/**
29-
* Evaluates the Dirac delta function in single-precision floating-point format.
29+
* Evaluates the Dirac delta function for a single-precision floating-point number.
3030
*
3131
* @private
3232
* @param {number} x - input value

lib/node_modules/@stdlib/math/base/special/dirac-deltaf/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/special/dirac-deltaf",
33
"version": "0.0.0",
4-
"description": "Evaluate the Dirac delta function in single-precision floating-point format.",
4+
"description": "Evaluate the Dirac delta function for a single-precision floating-point number.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

lib/node_modules/@stdlib/math/base/special/dirac-deltaf/src/main.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,10 @@
2121
#include "stdlib/constants/float32/pinf.h"
2222

2323
/**
24-
* Evaluates the Dirac delta function in single-precision floating-point format.
24+
* Evaluates the Dirac delta function for a single-precision floating-point number.
2525
*
2626
* @param x input value
27-
* @return output value
27+
* @return output value
2828
*
2929
* @example
3030
* float out = stdlib_base_dirac_deltaf( 3.14f );

0 commit comments

Comments
 (0)