File tree Expand file tree Collapse file tree 6 files changed +27
-27
lines changed
lib/node_modules/@stdlib/stats/base/dists/planck/quantile Expand file tree Collapse file tree 6 files changed +27
-27
lines changed Original file line number Diff line number Diff line change 25
25
Examples
26
26
--------
27
27
> var y = {{alias}}( 0.8, 0.4 )
28
- 4
28
+ 4.0
29
29
> y = {{alias}}( 0.5, 1.4 )
30
- 0
30
+ 0.0
31
31
> y = {{alias}}( 0.9, 2.1 )
32
- 1
32
+ 1.0
33
33
34
34
> y = {{alias}}( 0.2, -0.1 )
35
35
NaN
63
63
--------
64
64
> var myquantile = {{alias}}.factory( 0.4 );
65
65
> var y = myquantile( 0.4 )
66
- 1
66
+ 1.0
67
67
> y = myquantile( 0.8 )
68
- 4
68
+ 4.0
69
69
> y = myquantile( 1.0 )
70
70
Infinity
71
71
Original file line number Diff line number Diff line change @@ -48,15 +48,15 @@ interface Quantile {
48
48
*
49
49
* @example
50
50
* var y = quantile( 0.8, 0.4 );
51
- * // returns 4
51
+ * // returns 4.0
52
52
*
53
53
* @example
54
54
* var y = quantile( 0.5, 1.4 );
55
- * // returns 0
55
+ * // returns 0.0
56
56
*
57
57
* @example
58
58
* var y = quantile( 0.9, 2.1 );
59
- * // returns 1
59
+ * // returns 1.0
60
60
*
61
61
* @example
62
62
* var y = quantile( 0.2, -0.1 );
@@ -89,10 +89,10 @@ interface Quantile {
89
89
* @example
90
90
* var myquantile = quantile.factory( 0.4 );
91
91
* var y = myquantile( 0.4 );
92
- * // returns 1
92
+ * // returns 1.0
93
93
*
94
94
* y = myquantile( 0.8 );
95
- * // returns 4
95
+ * // returns 4.0
96
96
*
97
97
* y = myquantile( 1.0 );
98
98
* // returns Infinity
@@ -109,17 +109,17 @@ interface Quantile {
109
109
*
110
110
* @example
111
111
* var y = quantile( 0.8, 0.4 );
112
- * // returns 4
112
+ * // returns 4.0
113
113
*
114
114
* y = quantile( 0.5, 1.4 );
115
- * // returns 0
115
+ * // returns 0.0
116
116
*
117
117
* var myquantile = quantile.factory( 0.4 );
118
118
* y = myquantile( 0.4 );
119
- * // returns 1
119
+ * // returns 1.0
120
120
*
121
121
* y = myquantile( 0.8 );
122
- * // returns 4
122
+ * // returns 4.0
123
123
*
124
124
* y = myquantile( 1.0 );
125
125
* // returns Infinity
Original file line number Diff line number Diff line change @@ -38,10 +38,10 @@ var PINF = require( '@stdlib/constants/float64/pinf' );
38
38
* @example
39
39
* var quantile = factory( 0.4 );
40
40
* var y = quantile( 0.4 );
41
- * // returns 1
41
+ * // returns 1.0
42
42
*
43
43
* y = quantile( 0.8 );
44
- * // returns 4
44
+ * // returns 4.0
45
45
*
46
46
* y = quantile( 1.0 );
47
47
* // returns Infinity
@@ -57,7 +57,7 @@ function factory( lambda ) {
57
57
*
58
58
* @private
59
59
* @param {Probability } p - input value
60
- * @returns {NonNegativeInteger } evaluated quantile function
60
+ * @returns {number } evaluated quantile function
61
61
*
62
62
* @example
63
63
* var y = quantile( 0.3 );
Original file line number Diff line number Diff line change 27
27
* var quantile = require( '@stdlib/stats/base/dists/planck/quantile' );
28
28
*
29
29
* var y = quantile( 0.8, 0.4 );
30
- * // returns 4
30
+ * // returns 4.0
31
31
*
32
32
* y = quantile( 0.5, 1.4 );
33
- * // returns 0
33
+ * // returns 0.0
34
34
*
35
35
* var myquantile = quantile.factory( 0.4 );
36
36
* y = myquantile( 0.4 );
37
- * // returns 1
37
+ * // returns 1.0
38
38
*
39
39
* y = myquantile( 0.8 );
40
- * // returns 4
40
+ * // returns 4.0
41
41
*
42
42
* y = myquantile( 1.0 );
43
43
* // returns Infinity
Original file line number Diff line number Diff line change @@ -33,19 +33,19 @@ var PINF = require( '@stdlib/constants/float64/pinf' );
33
33
*
34
34
* @param {Probability } p - input value
35
35
* @param {PositiveNumber } lambda - shape parameter
36
- * @returns {NonNegativeInteger } evaluated quantile function
36
+ * @returns {number } evaluated quantile function
37
37
*
38
38
* @example
39
39
* var y = quantile( 0.8, 0.4 );
40
- * // returns 4
40
+ * // returns 4.0
41
41
*
42
42
* @example
43
43
* var y = quantile( 0.5, 1.4 );
44
- * // returns 0
44
+ * // returns 0.0
45
45
*
46
46
* @example
47
47
* var y = quantile( 0.9, 2.1 );
48
- * // returns 1
48
+ * // returns 1.0
49
49
*
50
50
* @example
51
51
* var y = quantile( 0.2, -0.1 );
Original file line number Diff line number Diff line change @@ -29,8 +29,8 @@ var addon = require( './../src/addon.node' );
29
29
* Evaluates the quantile function for a Planck distribution with shape parameter `lambda`.
30
30
*
31
31
* @private
32
- * @param {number } p - input probability
33
- * @param {number } lambda - shape parameter
32
+ * @param {Probability } p - input probability
33
+ * @param {PositiveNumber } lambda - shape parameter
34
34
* @returns {number } evaluated quantile function
35
35
*
36
36
* @example
You can’t perform that action at this time.
0 commit comments