Skip to content

Commit a477ce3

Browse files
committed
chore: ensure consistent use of decimals
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 18a1bcc commit a477ce3

File tree

5 files changed

+13
-13
lines changed

5 files changed

+13
-13
lines changed

lib/node_modules/@stdlib/stats/base/dists/planck/mode/docs/repl.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
{{alias}}( λ )
33
Returns the mode of a Planck distribution with shape parameter `λ`.
44

5-
If `lambda <= 0`, the function returns `NaN`.
5+
If `λ <= 0`, the function returns `NaN`.
66

77
Parameters
88
----------
@@ -11,15 +11,15 @@
1111

1212
Returns
1313
-------
14-
out: integer
14+
out: number
1515
Mode.
1616

1717
Examples
1818
--------
1919
> var v = {{alias}}( 0.1 )
20-
0
20+
0.0
2121
> v = {{alias}}( 1.5 )
22-
0
22+
0.0
2323

2424
See Also
2525
--------

lib/node_modules/@stdlib/stats/base/dists/planck/mode/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,11 @@
3030
*
3131
* @example
3232
* var v = mode( 0.1 );
33-
* // returns 0
33+
* // returns 0.0
3434
*
3535
* @example
3636
* var v = mode( 1.5 );
37-
* // returns 0
37+
* // returns 0.0
3838
*
3939
* @example
4040
* var v = mode( -1.1 );

lib/node_modules/@stdlib/stats/base/dists/planck/mode/lib/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@
2727
* var mode = require( '@stdlib/stats/base/dists/planck/mode' );
2828
*
2929
* var v = mode( 0.1 );
30-
* // returns 0
30+
* // returns 0.0
3131
*
3232
* v = mode( 1.5 );
33-
* // returns 0
33+
* // returns 0.0
3434
*/
3535

3636
// MODULES //

lib/node_modules/@stdlib/stats/base/dists/planck/mode/lib/main.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,15 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' );
2929
* Returns the mode of a Planck distribution.
3030
*
3131
* @param {PositiveNumber} lambda - shape parameter
32-
* @returns {NonNegativeInteger} mode
32+
* @returns {number} mode
3333
*
3434
* @example
3535
* var v = mode( 0.1 );
36-
* // returns 0
36+
* // returns 0.0
3737
*
3838
* @example
3939
* var v = mode( 1.5 );
40-
* // returns 0
40+
* // returns 0.0
4141
*
4242
* @example
4343
* var v = mode( -1.1 );
@@ -51,7 +51,7 @@ function mode( lambda ) {
5151
if ( isnan( lambda ) || lambda <= 0.0 ) {
5252
return NaN;
5353
}
54-
return 0;
54+
return 0.0;
5555
}
5656

5757

lib/node_modules/@stdlib/stats/base/dists/planck/mode/lib/native.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ var addon = require( './../src/addon.node' );
2929
* Returns the mode for a Planck distribution with shape parameter `lambda`.
3030
*
3131
* @private
32-
* @param {number} lambda - shape parameter
32+
* @param {PositiveNumber} lambda - shape parameter
3333
* @returns {number} mode
3434
*
3535
* @example

0 commit comments

Comments
 (0)