@stdlib/stats-base-dists-signrank-quantile 0.0.7 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/NOTICE +1 -1
- package/README.md +18 -4
- package/SECURITY.md +5 -0
- package/dist/index.d.ts +3 -0
- package/dist/index.js +9 -0
- package/dist/index.js.map +7 -0
- package/docs/types/index.d.ts +1 -1
- package/lib/index.js +3 -3
- package/package.json +20 -19
- package/docs/repl.txt +0 -67
- package/docs/types/test.ts +0 -98
- /package/lib/{quantile.js → main.js} +0 -0
package/NOTICE
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
Copyright (c) 2016-
|
|
1
|
+
Copyright (c) 2016-2024 The Stdlib Authors.
|
package/README.md
CHANGED
|
@@ -18,6 +18,17 @@ limitations under the License.
|
|
|
18
18
|
|
|
19
19
|
-->
|
|
20
20
|
|
|
21
|
+
|
|
22
|
+
<details>
|
|
23
|
+
<summary>
|
|
24
|
+
About stdlib...
|
|
25
|
+
</summary>
|
|
26
|
+
<p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
|
|
27
|
+
<p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
|
|
28
|
+
<p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
|
|
29
|
+
<p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
|
|
30
|
+
</details>
|
|
31
|
+
|
|
21
32
|
# Quantile Function
|
|
22
33
|
|
|
23
34
|
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
|
|
@@ -170,7 +181,7 @@ See [LICENSE][stdlib-license].
|
|
|
170
181
|
|
|
171
182
|
## Copyright
|
|
172
183
|
|
|
173
|
-
Copyright © 2016-
|
|
184
|
+
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
|
|
174
185
|
|
|
175
186
|
</section>
|
|
176
187
|
|
|
@@ -183,8 +194,8 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
183
194
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-signrank-quantile.svg
|
|
184
195
|
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-signrank-quantile
|
|
185
196
|
|
|
186
|
-
[test-image]: https://github.com/stdlib-js/stats-base-dists-signrank-quantile/actions/workflows/test.yml/badge.svg?branch=v0.0
|
|
187
|
-
[test-url]: https://github.com/stdlib-js/stats-base-dists-signrank-quantile/actions/workflows/test.yml?query=branch:v0.0
|
|
197
|
+
[test-image]: https://github.com/stdlib-js/stats-base-dists-signrank-quantile/actions/workflows/test.yml/badge.svg?branch=v0.2.0
|
|
198
|
+
[test-url]: https://github.com/stdlib-js/stats-base-dists-signrank-quantile/actions/workflows/test.yml?query=branch:v0.2.0
|
|
188
199
|
|
|
189
200
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-signrank-quantile/main.svg
|
|
190
201
|
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-signrank-quantile?branch=main
|
|
@@ -197,7 +208,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
197
208
|
-->
|
|
198
209
|
|
|
199
210
|
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
200
|
-
[chat-url]: https://gitter.im
|
|
211
|
+
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
|
|
201
212
|
|
|
202
213
|
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
203
214
|
|
|
@@ -207,8 +218,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
207
218
|
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
|
|
208
219
|
|
|
209
220
|
[deno-url]: https://github.com/stdlib-js/stats-base-dists-signrank-quantile/tree/deno
|
|
221
|
+
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-signrank-quantile/blob/deno/README.md
|
|
210
222
|
[umd-url]: https://github.com/stdlib-js/stats-base-dists-signrank-quantile/tree/umd
|
|
223
|
+
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-signrank-quantile/blob/umd/README.md
|
|
211
224
|
[esm-url]: https://github.com/stdlib-js/stats-base-dists-signrank-quantile/tree/esm
|
|
225
|
+
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-signrank-quantile/blob/esm/README.md
|
|
212
226
|
[branches-url]: https://github.com/stdlib-js/stats-base-dists-signrank-quantile/blob/main/branches.md
|
|
213
227
|
|
|
214
228
|
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-signrank-quantile/main/LICENSE
|
package/SECURITY.md
ADDED
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
"use strict";var s=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var n=s(function(E,q){
|
|
2
|
+
var h=require('@stdlib/utils-memoize/dist'),v;function w(r,e){var t;return e===0?r===0?1:0:(t=e*(e+1)/2,r<0||r>t?0:(r>t/2&&(r=t-r),v(r-e,e-1)+v(r,e-1)))}v=h(w);q.exports=v
|
|
3
|
+
});var c=s(function(G,o){
|
|
4
|
+
var y=require('@stdlib/math-base-assert-is-positive-integer/dist'),d=require('@stdlib/math-base-assert-is-finite/dist'),f=require('@stdlib/math-base-assert-is-nan/dist'),z=require('@stdlib/math-base-special-exp/dist'),I=require('@stdlib/constants-float64-ln-two/dist'),L=n();function P(r,e){var t,i,u;if(f(e)||!y(e)||!d(e))return NaN;if(f(r)||r<0||r>1)return NaN;if(r===0)return 0;if(r===1)return e*(e+1)/2;for(t=z(-e*I),u=0,i=-1;u<r;)i+=1,u+=t*L(i,e);return i}o.exports=P
|
|
5
|
+
});var l=s(function(H,m){
|
|
6
|
+
var F=require('@stdlib/math-base-assert-is-positive-integer/dist'),O=require('@stdlib/utils-constant-function/dist'),R=require('@stdlib/math-base-assert-is-finite/dist'),N=require('@stdlib/math-base-assert-is-nan/dist'),b=require('@stdlib/math-base-special-exp/dist'),j=require('@stdlib/constants-float64-ln-two/dist'),k=n();function A(r){var e;if(N(r)||!F(r)||!R(r))return O(NaN);return e=b(-r*j),t;function t(i){var u,a;if(N(i)||i<0||i>1)return NaN;if(i===0)return 0;if(i===1)return r*(r+1)/2;for(u=0,a=-1;u<i;)a+=1,u+=e*k(a,r);return a}}m.exports=A
|
|
7
|
+
});var B=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),g=c(),C=l();B(g,"factory",C);module.exports=g;
|
|
8
|
+
/** @license Apache-2.0 */
|
|
9
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../lib/weights.js", "../lib/main.js", "../lib/factory.js", "../lib/index.js"],
|
|
4
|
+
"sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar memoize = require( '@stdlib/utils-memoize' );\n\n\n// VARIABLES //\n\nvar memoized;\n\n\n// FUNCTIONS //\n\n/**\n* Calculates the weight for the `(x,n)` pair and memoizes the result.\n*\n* @private\n* @param {number} x - input value\n* @param {NonNegativeInteger} n - number of observations\n* @returns {number} weight\n*/\nfunction weights( x, n ) {\n\tvar mlim;\n\n\tif ( n === 0 ) {\n\t\treturn ( x === 0 ) ? 1 : 0;\n\t}\n\tmlim = n * ( n + 1 ) / 2;\n\tif ( x < 0 || x > mlim ) {\n\t\treturn 0;\n\t}\n\tif ( x > mlim / 2 ) {\n\t\tx = mlim - x;\n\t}\n\treturn memoized( x - n, n - 1 ) + memoized( x, n - 1 );\n}\n\n\n// MAIN //\n\nmemoized = memoize( weights );\n\n\n// EXPORTS //\n\nmodule.exports = memoized;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isPositiveInteger = require( '@stdlib/math-base-assert-is-positive-integer' );\nvar isfinite = require( '@stdlib/math-base-assert-is-finite' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar exp = require( '@stdlib/math-base-special-exp' );\nvar LN2 = require( '@stdlib/constants-float64-ln-two' );\nvar weights = require( './weights.js' );\n\n\n// MAIN //\n\n/**\n* Evaluates the quantile function of the Wilcoxon signed rank test statistic with `n` observations.\n*\n* @param {Probability} p - input value\n* @param {PositiveInteger} n - number of observations\n* @returns {NonNegativeInteger} evaluated quantile function\n*\n* @example\n* var y = quantile( 0.8, 5 );\n* // returns 11\n*\n* @example\n* var y = quantile( 0.5, 4 );\n* // returns 5\n*\n* @example\n* var y = quantile( 1.1, 5 );\n* // returns NaN\n*\n* @example\n* var y = quantile( -0.2, 5 );\n* // returns NaN\n*\n* @example\n* var y = quantile( NaN, 5 );\n* // returns NaN\n*\n* @example\n* var y = quantile( 0.0, NaN );\n* // returns NaN\n*/\nfunction quantile( p, n ) {\n\tvar pui;\n\tvar q;\n\tvar r;\n\tif ( isnan( n ) || !isPositiveInteger( n ) || !isfinite( n ) ) {\n\t\treturn NaN;\n\t}\n\tif ( isnan( p ) || p < 0.0 || p > 1.0 ) {\n\t\treturn NaN;\n\t}\n\tif ( p === 0.0 ) {\n\t\treturn 0;\n\t}\n\tif ( p === 1.0 ) {\n\t\treturn ( n * ( n + 1 ) ) / 2;\n\t}\n\tpui = exp( -n * LN2 );\n\tr = 0;\n\tq = -1;\n\twhile ( r < p ) {\n\t\tq += 1;\n\t\tr += pui * weights( q, n );\n\t}\n\treturn q;\n}\n\n\n// EXPORTS //\n\nmodule.exports = quantile;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isPositiveInteger = require( '@stdlib/math-base-assert-is-positive-integer' );\nvar constantFunction = require( '@stdlib/utils-constant-function' );\nvar isfinite = require( '@stdlib/math-base-assert-is-finite' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar exp = require( '@stdlib/math-base-special-exp' );\nvar LN2 = require( '@stdlib/constants-float64-ln-two' );\nvar weights = require( './weights.js' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the quantile function of the Wilcoxon signed rank test statistic with `n` observations.\n*\n* @param {PositiveInteger} n - number of observations\n* @returns {Function} quantile function\n*\n* @example\n* var quantile = factory( 10 );\n* var y = quantile( 0.5 );\n* // returns 27\n*\n* y = quantile( 0.8 );\n* // returns 36\n*/\nfunction factory( n ) {\n\tvar pui;\n\tif ( isnan( n ) || !isPositiveInteger( n ) || !isfinite( n ) ) {\n\t\treturn constantFunction( NaN );\n\t}\n\tpui = exp( -n * LN2 );\n\treturn quantile;\n\n\t/**\n\t* Evaluates the quantile function of the Wilcoxon signed rank test statistic.\n\t*\n\t* @private\n\t* @param {Probability} p - input value\n\t* @returns {NonNegativeInteger} evaluated quantile function\n\t*\n\t* @example\n\t* var y = quantile( 0.3 );\n\t* // returns <number>\n\t*/\n\tfunction quantile( p ) {\n\t\tvar r;\n\t\tvar q;\n\t\tif ( isnan( p ) || p < 0.0 || p > 1.0 ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tif ( p === 0.0 ) {\n\t\t\treturn 0.0;\n\t\t}\n\t\tif ( p === 1.0 ) {\n\t\t\treturn ( n * ( n + 1 ) ) / 2;\n\t\t}\n\t\tr = 0;\n\t\tq = -1;\n\t\twhile ( r < p ) {\n\t\t\tq += 1;\n\t\t\tr += pui * weights( q, n );\n\t\t}\n\t\treturn q;\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2020 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Wilcoxon signed rank test statistic quantile function.\n*\n* @module @stdlib/stats-base-dists-signrank-quantile\n*\n* @example\n* var quantile = require( '@stdlib/stats-base-dists-signrank-quantile' );\n*\n* var y = quantile( 0.8, 5 );\n* // returns 11\n*\n* var myQuantile = quantile.factory( 4 );\n*\n* y = myQuantile( 0.5 );\n* // returns 5\n*\n* y = myQuantile( 0.0 );\n* // returns 0\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
|
|
5
|
+
"mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,QAAS,uBAAwB,EAK3CC,EAaJ,SAASC,EAASC,EAAGC,EAAI,CACxB,IAAIC,EAEJ,OAAKD,IAAM,EACDD,IAAM,EAAM,EAAI,GAE1BE,EAAOD,GAAMA,EAAI,GAAM,EAClBD,EAAI,GAAKA,EAAIE,EACV,GAEHF,EAAIE,EAAO,IACfF,EAAIE,EAAOF,GAELF,EAAUE,EAAIC,EAAGA,EAAI,CAAE,EAAIH,EAAUE,EAAGC,EAAI,CAAE,GACtD,CAKAH,EAAWD,EAASE,CAAQ,EAK5BH,EAAO,QAAUE,IChEjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,8CAA+C,EAC5EC,EAAW,QAAS,oCAAqC,EACzDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAM,QAAS,kCAAmC,EAClDC,EAAU,IAoCd,SAASC,EAAUC,EAAGC,EAAI,CACzB,IAAIC,EACAC,EACAC,EACJ,GAAKT,EAAOM,CAAE,GAAK,CAACR,EAAmBQ,CAAE,GAAK,CAACP,EAAUO,CAAE,EAC1D,MAAO,KAER,GAAKN,EAAOK,CAAE,GAAKA,EAAI,GAAOA,EAAI,EACjC,MAAO,KAER,GAAKA,IAAM,EACV,MAAO,GAER,GAAKA,IAAM,EACV,OAASC,GAAMA,EAAI,GAAQ,EAK5B,IAHAC,EAAMN,EAAK,CAACK,EAAIJ,CAAI,EACpBO,EAAI,EACJD,EAAI,GACIC,EAAIJ,GACXG,GAAK,EACLC,GAAKF,EAAMJ,EAASK,EAAGF,CAAE,EAE1B,OAAOE,CACR,CAKAX,EAAO,QAAUO,IC5FjB,IAAAM,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAoB,QAAS,8CAA+C,EAC5EC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAW,QAAS,oCAAqC,EACzDC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAM,QAAS,kCAAmC,EAClDC,EAAU,IAmBd,SAASC,EAASC,EAAI,CACrB,IAAIC,EACJ,GAAKN,EAAOK,CAAE,GAAK,CAACR,EAAmBQ,CAAE,GAAK,CAACN,EAAUM,CAAE,EAC1D,OAAOP,EAAkB,GAAI,EAE9B,OAAAQ,EAAML,EAAK,CAACI,EAAIH,CAAI,EACbK,EAaP,SAASA,EAAUC,EAAI,CACtB,IAAIC,EACAC,EACJ,GAAKV,EAAOQ,CAAE,GAAKA,EAAI,GAAOA,EAAI,EACjC,MAAO,KAER,GAAKA,IAAM,EACV,MAAO,GAER,GAAKA,IAAM,EACV,OAASH,GAAMA,EAAI,GAAQ,EAI5B,IAFAI,EAAI,EACJC,EAAI,GACID,EAAID,GACXE,GAAK,EACLD,GAAKH,EAAMH,EAASO,EAAGL,CAAE,EAE1B,OAAOK,CACR,CACD,CAKAd,EAAO,QAAUQ,ICjDjB,IAAIO,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
|
|
6
|
+
"names": ["require_weights", "__commonJSMin", "exports", "module", "memoize", "memoized", "weights", "x", "n", "mlim", "require_main", "__commonJSMin", "exports", "module", "isPositiveInteger", "isfinite", "isnan", "exp", "LN2", "weights", "quantile", "p", "n", "pui", "q", "r", "require_factory", "__commonJSMin", "exports", "module", "isPositiveInteger", "constantFunction", "isfinite", "isnan", "exp", "LN2", "weights", "factory", "n", "pui", "quantile", "p", "r", "q", "setReadOnly", "main", "factory"]
|
|
7
|
+
}
|
package/docs/types/index.d.ts
CHANGED
package/lib/index.js
CHANGED
|
@@ -41,15 +41,15 @@
|
|
|
41
41
|
// MODULES //
|
|
42
42
|
|
|
43
43
|
var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
|
|
44
|
-
var
|
|
44
|
+
var main = require( './main.js' );
|
|
45
45
|
var factory = require( './factory.js' );
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
// MAIN //
|
|
49
49
|
|
|
50
|
-
setReadOnly(
|
|
50
|
+
setReadOnly( main, 'factory', factory );
|
|
51
51
|
|
|
52
52
|
|
|
53
53
|
// EXPORTS //
|
|
54
54
|
|
|
55
|
-
module.exports =
|
|
55
|
+
module.exports = main;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stdlib/stats-base-dists-signrank-quantile",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Wilcoxon signed rank test statistic quantile function.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": {
|
|
@@ -37,26 +37,27 @@
|
|
|
37
37
|
"url": "https://github.com/stdlib-js/stdlib/issues"
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@stdlib/constants-float64-ln-two": "^0.0
|
|
41
|
-
"@stdlib/math-base-assert-is-finite": "^0.0
|
|
42
|
-
"@stdlib/math-base-assert-is-nan": "^0.0
|
|
43
|
-
"@stdlib/math-base-assert-is-positive-integer": "^0.0
|
|
44
|
-
"@stdlib/math-base-special-exp": "^0.0
|
|
45
|
-
"@stdlib/utils-constant-function": "^0.0
|
|
46
|
-
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.0
|
|
47
|
-
"@stdlib/utils-memoize": "^0.0
|
|
40
|
+
"@stdlib/constants-float64-ln-two": "^0.2.0",
|
|
41
|
+
"@stdlib/math-base-assert-is-finite": "^0.2.0",
|
|
42
|
+
"@stdlib/math-base-assert-is-nan": "^0.2.0",
|
|
43
|
+
"@stdlib/math-base-assert-is-positive-integer": "^0.2.0",
|
|
44
|
+
"@stdlib/math-base-special-exp": "^0.2.0",
|
|
45
|
+
"@stdlib/utils-constant-function": "^0.2.0",
|
|
46
|
+
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0",
|
|
47
|
+
"@stdlib/utils-memoize": "^0.2.0"
|
|
48
48
|
},
|
|
49
49
|
"devDependencies": {
|
|
50
|
-
"@stdlib/
|
|
51
|
-
"@stdlib/constants-float64-
|
|
52
|
-
"@stdlib/constants-float64-
|
|
53
|
-
"@stdlib/
|
|
54
|
-
"@stdlib/
|
|
55
|
-
"@stdlib/random-base-
|
|
56
|
-
"@stdlib/random-base-randu": "^0.0.x",
|
|
50
|
+
"@stdlib/constants-float64-eps": "^0.1.1",
|
|
51
|
+
"@stdlib/constants-float64-ninf": "^0.1.1",
|
|
52
|
+
"@stdlib/constants-float64-pinf": "^0.1.1",
|
|
53
|
+
"@stdlib/math-base-special-abs": "^0.1.1",
|
|
54
|
+
"@stdlib/random-base-discrete-uniform": "^0.1.0",
|
|
55
|
+
"@stdlib/random-base-randu": "^0.1.0",
|
|
57
56
|
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
|
|
58
57
|
"istanbul": "^0.4.1",
|
|
59
|
-
"tap-
|
|
58
|
+
"tap-min": "git+https://github.com/Planeshifter/tap-min.git",
|
|
59
|
+
"@stdlib/bench-harness": "^0.2.0",
|
|
60
|
+
"@stdlib/bench": "^0.3.1"
|
|
60
61
|
},
|
|
61
62
|
"engines": {
|
|
62
63
|
"node": ">=0.10.0",
|
|
@@ -92,7 +93,7 @@
|
|
|
92
93
|
"continuous"
|
|
93
94
|
],
|
|
94
95
|
"funding": {
|
|
95
|
-
"type": "
|
|
96
|
-
"url": "https://
|
|
96
|
+
"type": "opencollective",
|
|
97
|
+
"url": "https://opencollective.com/stdlib"
|
|
97
98
|
}
|
|
98
99
|
}
|
package/docs/repl.txt
DELETED
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
{{alias}}( p, n )
|
|
3
|
-
Evaluates the quantile function for the Wilcoxon signed rank test statistic
|
|
4
|
-
with `n` observations at a probability `p`.
|
|
5
|
-
|
|
6
|
-
If `p < 0` or `p > 1`, the function returns `NaN`.
|
|
7
|
-
|
|
8
|
-
If provided `NaN` as any argument, the function returns `NaN`.
|
|
9
|
-
|
|
10
|
-
If not provided a positive integer for `n`, the function returns `NaN`.
|
|
11
|
-
|
|
12
|
-
Parameters
|
|
13
|
-
----------
|
|
14
|
-
p: number
|
|
15
|
-
Input probability.
|
|
16
|
-
|
|
17
|
-
n: integer
|
|
18
|
-
Number of observations.
|
|
19
|
-
|
|
20
|
-
Returns
|
|
21
|
-
-------
|
|
22
|
-
out: number
|
|
23
|
-
Evaluated quantile function.
|
|
24
|
-
|
|
25
|
-
Examples
|
|
26
|
-
--------
|
|
27
|
-
> var y = {{alias}}( 0.8, 5 )
|
|
28
|
-
11
|
|
29
|
-
> y = {{alias}}( 0.5, 4 )
|
|
30
|
-
5
|
|
31
|
-
|
|
32
|
-
> y = {{alias}}( 1.1, 5 )
|
|
33
|
-
NaN
|
|
34
|
-
> y = {{alias}}( -0.2, 5 )
|
|
35
|
-
NaN
|
|
36
|
-
|
|
37
|
-
> y = {{alias}}( NaN, 5 )
|
|
38
|
-
NaN
|
|
39
|
-
> y = {{alias}}( 0.0, NaN )
|
|
40
|
-
NaN
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
{{alias}}.factory( n )
|
|
44
|
-
Returns a function for evaluating the quantile function of the Wilcoxon
|
|
45
|
-
signed rank test statistic with `n` observations.
|
|
46
|
-
|
|
47
|
-
Parameters
|
|
48
|
-
----------
|
|
49
|
-
n: integer
|
|
50
|
-
Number of observations.
|
|
51
|
-
|
|
52
|
-
Returns
|
|
53
|
-
-------
|
|
54
|
-
quantile: Function
|
|
55
|
-
Quantile function.
|
|
56
|
-
|
|
57
|
-
Examples
|
|
58
|
-
--------
|
|
59
|
-
> var myQuantile = {{alias}}.factory( 8 );
|
|
60
|
-
> var y = myQuantile( 0.4 )
|
|
61
|
-
16
|
|
62
|
-
> y = myQuantile( 1.0 )
|
|
63
|
-
36
|
|
64
|
-
|
|
65
|
-
See Also
|
|
66
|
-
--------
|
|
67
|
-
|
package/docs/types/test.ts
DELETED
|
@@ -1,98 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* @license Apache-2.0
|
|
3
|
-
*
|
|
4
|
-
* Copyright (c) 2020 The Stdlib Authors.
|
|
5
|
-
*
|
|
6
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
7
|
-
* you may not use this file except in compliance with the License.
|
|
8
|
-
* You may obtain a copy of the License at
|
|
9
|
-
*
|
|
10
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
-
*
|
|
12
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
13
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
14
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
15
|
-
* See the License for the specific language governing permissions and
|
|
16
|
-
* limitations under the License.
|
|
17
|
-
*/
|
|
18
|
-
|
|
19
|
-
import quantile = require( './index' );
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
// TESTS //
|
|
23
|
-
|
|
24
|
-
// The function returns a number...
|
|
25
|
-
{
|
|
26
|
-
quantile( 0.2, 2 ); // $ExpectType number
|
|
27
|
-
quantile( 0.1, 2 ); // $ExpectType number
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
// The compiler throws an error if the function is provided values other than two numbers...
|
|
31
|
-
{
|
|
32
|
-
quantile( true, 3 ); // $ExpectError
|
|
33
|
-
quantile( false, 2 ); // $ExpectError
|
|
34
|
-
quantile( '5', 1 ); // $ExpectError
|
|
35
|
-
quantile( [], 1 ); // $ExpectError
|
|
36
|
-
quantile( {}, 2 ); // $ExpectError
|
|
37
|
-
quantile( ( x: number ): number => x, 2 ); // $ExpectError
|
|
38
|
-
|
|
39
|
-
quantile( 0.9, true ); // $ExpectError
|
|
40
|
-
quantile( 0.9, false ); // $ExpectError
|
|
41
|
-
quantile( 0.5, '5' ); // $ExpectError
|
|
42
|
-
quantile( 0.8, [] ); // $ExpectError
|
|
43
|
-
quantile( 0.9, {} ); // $ExpectError
|
|
44
|
-
quantile( 0.8, ( x: number ): number => x ); // $ExpectError
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
// The compiler throws an error if the function is provided an unsupported number of arguments...
|
|
48
|
-
{
|
|
49
|
-
quantile(); // $ExpectError
|
|
50
|
-
quantile( 0.2 ); // $ExpectError
|
|
51
|
-
quantile( 0.2, 0, 4 ); // $ExpectError
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
// Attached to main export is a `factory` method which returns a function...
|
|
55
|
-
{
|
|
56
|
-
quantile.factory( 3 ); // $ExpectType Unary
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
// The `factory` method returns a function which returns a number...
|
|
60
|
-
{
|
|
61
|
-
const fcn = quantile.factory( 3 );
|
|
62
|
-
fcn( 0.2 ); // $ExpectType number
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
// The compiler throws an error if the function returned by the `factory` method is provided an invalid argument...
|
|
66
|
-
{
|
|
67
|
-
const fcn = quantile.factory( 3 );
|
|
68
|
-
fcn( true ); // $ExpectError
|
|
69
|
-
fcn( false ); // $ExpectError
|
|
70
|
-
fcn( '5' ); // $ExpectError
|
|
71
|
-
fcn( [] ); // $ExpectError
|
|
72
|
-
fcn( {} ); // $ExpectError
|
|
73
|
-
fcn( ( x: number ): number => x ); // $ExpectError
|
|
74
|
-
}
|
|
75
|
-
|
|
76
|
-
// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments...
|
|
77
|
-
{
|
|
78
|
-
const fcn = quantile.factory( 3 );
|
|
79
|
-
fcn(); // $ExpectError
|
|
80
|
-
fcn( 0.2, 0 ); // $ExpectError
|
|
81
|
-
fcn( 0.2, 0, 1 ); // $ExpectError
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
// The compiler throws an error if the `factory` method is provided a value other than a number...
|
|
85
|
-
{
|
|
86
|
-
quantile.factory( true ); // $ExpectError
|
|
87
|
-
quantile.factory( false ); // $ExpectError
|
|
88
|
-
quantile.factory( '5' ); // $ExpectError
|
|
89
|
-
quantile.factory( [] ); // $ExpectError
|
|
90
|
-
quantile.factory( {} ); // $ExpectError
|
|
91
|
-
quantile.factory( ( x: number ): number => x ); // $ExpectError
|
|
92
|
-
}
|
|
93
|
-
|
|
94
|
-
// The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
|
|
95
|
-
{
|
|
96
|
-
quantile.factory( 2, 2 ); // $ExpectError
|
|
97
|
-
quantile.factory( 3, 4, 8 ); // $ExpectError
|
|
98
|
-
}
|
|
File without changes
|