File tree Expand file tree Collapse file tree 5 files changed +13
-13
lines changed
lib/node_modules/@stdlib/stats/base/dists/planck/mode Expand file tree Collapse file tree 5 files changed +13
-13
lines changed Original file line number Diff line number Diff line change 2
2
{{alias}}( λ )
3
3
Returns the mode of a Planck distribution with shape parameter `λ`.
4
4
5
- If `lambda <= 0`, the function returns `NaN`.
5
+ If `λ <= 0`, the function returns `NaN`.
6
6
7
7
Parameters
8
8
----------
11
11
12
12
Returns
13
13
-------
14
- out: integer
14
+ out: number
15
15
Mode.
16
16
17
17
Examples
18
18
--------
19
19
> var v = {{alias}}( 0.1 )
20
- 0
20
+ 0.0
21
21
> v = {{alias}}( 1.5 )
22
- 0
22
+ 0.0
23
23
24
24
See Also
25
25
--------
Original file line number Diff line number Diff line change 30
30
*
31
31
* @example
32
32
* var v = mode( 0.1 );
33
- * // returns 0
33
+ * // returns 0.0
34
34
*
35
35
* @example
36
36
* var v = mode( 1.5 );
37
- * // returns 0
37
+ * // returns 0.0
38
38
*
39
39
* @example
40
40
* var v = mode( -1.1 );
Original file line number Diff line number Diff line change 27
27
* var mode = require( '@stdlib/stats/base/dists/planck/mode' );
28
28
*
29
29
* var v = mode( 0.1 );
30
- * // returns 0
30
+ * // returns 0.0
31
31
*
32
32
* v = mode( 1.5 );
33
- * // returns 0
33
+ * // returns 0.0
34
34
*/
35
35
36
36
// MODULES //
Original file line number Diff line number Diff line change @@ -29,15 +29,15 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' );
29
29
* Returns the mode of a Planck distribution.
30
30
*
31
31
* @param {PositiveNumber } lambda - shape parameter
32
- * @returns {NonNegativeInteger } mode
32
+ * @returns {number } mode
33
33
*
34
34
* @example
35
35
* var v = mode( 0.1 );
36
- * // returns 0
36
+ * // returns 0.0
37
37
*
38
38
* @example
39
39
* var v = mode( 1.5 );
40
- * // returns 0
40
+ * // returns 0.0
41
41
*
42
42
* @example
43
43
* var v = mode( -1.1 );
@@ -51,7 +51,7 @@ function mode( lambda ) {
51
51
if ( isnan ( lambda ) || lambda <= 0.0 ) {
52
52
return NaN ;
53
53
}
54
- return 0 ;
54
+ return 0.0 ;
55
55
}
56
56
57
57
Original file line number Diff line number Diff line change @@ -29,7 +29,7 @@ var addon = require( './../src/addon.node' );
29
29
* Returns the mode for a Planck distribution with shape parameter `lambda`.
30
30
*
31
31
* @private
32
- * @param {number } lambda - shape parameter
32
+ * @param {PositiveNumber } lambda - shape parameter
33
33
* @returns {number } mode
34
34
*
35
35
* @example
You can’t perform that action at this time.
0 commit comments