File tree Expand file tree Collapse file tree 2 files changed +9
-9
lines changed
lib/node_modules/@stdlib/stats/base/dists/planck/pmf Expand file tree Collapse file tree 2 files changed +9
-9
lines changed Original file line number Diff line number Diff line change @@ -53,13 +53,13 @@ var pmf = require( '@stdlib/stats/base/dists/planck/pmf' );
53
53
Evaluates the [ probability mass function] [ pmf ] (PMF) of a Planck (discrete exponential) distribution with shape parameter ` lambda ` .
54
54
55
55
``` javascript
56
- var y = pmf ( 4 , 0.3 );
56
+ var y = pmf ( 4.0 , 0.3 );
57
57
// returns ~0.0781
58
58
59
- y = pmf ( 2 , 1.7 );
59
+ y = pmf ( 2.0 , 1.7 );
60
60
// returns ~0.0273
61
61
62
- y = pmf ( - 1 , 2.5 );
62
+ y = pmf ( - 1.0 , 2.5 );
63
63
// returns 0.0
64
64
```
65
65
@@ -69,14 +69,14 @@ If provided `NaN` as any argument, the function returns `NaN`.
69
69
var y = pmf ( NaN , 0.0 );
70
70
// returns NaN
71
71
72
- y = pmf ( 0 , NaN );
72
+ y = pmf ( 0.0 , NaN );
73
73
// returns NaN
74
74
```
75
75
76
76
If provided a shape parameter ` lambda ` which is a nonpositive number, the function returns ` NaN ` .
77
77
78
78
``` javascript
79
- var y = pmf ( 2 , - 1.0 );
79
+ var y = pmf ( 2.0 , - 1.0 );
80
80
// returns NaN
81
81
```
82
82
@@ -86,10 +86,10 @@ Returns a function for evaluating the [probability mass function][pmf] (PMF) of
86
86
87
87
``` javascript
88
88
var mypmf = pmf .factory ( 0.5 );
89
- var y = mypmf ( 3 );
89
+ var y = mypmf ( 3.0 );
90
90
// returns ~0.0878
91
91
92
- y = mypmf ( 1 );
92
+ y = mypmf ( 1.0 );
93
93
// returns ~0.2387
94
94
```
95
95
Original file line number Diff line number Diff line change @@ -30,8 +30,8 @@ var addon = require( './../src/addon.node' );
30
30
*
31
31
* @private
32
32
* @param {number } x - input value
33
- * @param {number } lambda - shape parameter
34
- * @returns {number } evaluated PMF
33
+ * @param {PositiveNumber } lambda - shape parameter
34
+ * @returns {Probability } evaluated PMF
35
35
*
36
36
* @example
37
37
* var y = pmf( 2, 0.5 );
You can’t perform that action at this time.
0 commit comments