@stdlib/stats-base-dists-t-quantile 0.0.7 → 0.1.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/CITATION.cff +30 -0
- package/NOTICE +1 -1
- package/README.md +15 -4
- package/dist/index.d.ts +3 -0
- package/dist/index.js +7 -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 +16 -16
- package/docs/repl.txt +0 -70
- package/docs/types/test.ts +0 -98
- /package/lib/{quantile.js → main.js} +0 -0
package/CITATION.cff
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
cff-version: 1.2.0
|
|
2
|
+
title: stdlib
|
|
3
|
+
message: >-
|
|
4
|
+
If you use this software, please cite it using the
|
|
5
|
+
metadata from this file.
|
|
6
|
+
|
|
7
|
+
type: software
|
|
8
|
+
|
|
9
|
+
authors:
|
|
10
|
+
- name: The Stdlib Authors
|
|
11
|
+
url: https://github.com/stdlib-js/stdlib/graphs/contributors
|
|
12
|
+
|
|
13
|
+
repository-code: https://github.com/stdlib-js/stdlib
|
|
14
|
+
url: https://stdlib.io
|
|
15
|
+
|
|
16
|
+
abstract: |
|
|
17
|
+
Standard library for JavaScript and Node.js.
|
|
18
|
+
|
|
19
|
+
keywords:
|
|
20
|
+
- JavaScript
|
|
21
|
+
- Node.js
|
|
22
|
+
- TypeScript
|
|
23
|
+
- standard library
|
|
24
|
+
- scientific computing
|
|
25
|
+
- numerical computing
|
|
26
|
+
- statistical computing
|
|
27
|
+
|
|
28
|
+
license: Apache-2.0 AND BSL-1.0
|
|
29
|
+
|
|
30
|
+
date-released: 2016
|
package/NOTICE
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
Copyright (c) 2016-
|
|
1
|
+
Copyright (c) 2016-2023 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] -->
|
|
@@ -185,7 +196,7 @@ See [LICENSE][stdlib-license].
|
|
|
185
196
|
|
|
186
197
|
## Copyright
|
|
187
198
|
|
|
188
|
-
Copyright © 2016-
|
|
199
|
+
Copyright © 2016-2023. The Stdlib [Authors][stdlib-authors].
|
|
189
200
|
|
|
190
201
|
</section>
|
|
191
202
|
|
|
@@ -198,8 +209,8 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
198
209
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-t-quantile.svg
|
|
199
210
|
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-t-quantile
|
|
200
211
|
|
|
201
|
-
[test-image]: https://github.com/stdlib-js/stats-base-dists-t-quantile/actions/workflows/test.yml/badge.svg?branch=v0.0
|
|
202
|
-
[test-url]: https://github.com/stdlib-js/stats-base-dists-t-quantile/actions/workflows/test.yml?query=branch:v0.0
|
|
212
|
+
[test-image]: https://github.com/stdlib-js/stats-base-dists-t-quantile/actions/workflows/test.yml/badge.svg?branch=v0.1.0
|
|
213
|
+
[test-url]: https://github.com/stdlib-js/stats-base-dists-t-quantile/actions/workflows/test.yml?query=branch:v0.1.0
|
|
203
214
|
|
|
204
215
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-t-quantile/main.svg
|
|
205
216
|
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-t-quantile?branch=main
|
|
@@ -212,7 +223,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
212
223
|
-->
|
|
213
224
|
|
|
214
225
|
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
215
|
-
[chat-url]: https://gitter.im
|
|
226
|
+
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
|
|
216
227
|
|
|
217
228
|
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
218
229
|
|
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";var t=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var q=t(function(R,s){
|
|
2
|
+
var N=require('@stdlib/math-base-special-kernel-betaincinv/dist'),u=require('@stdlib/math-base-assert-is-nan/dist'),l=require('@stdlib/math-base-special-signum/dist'),x=require('@stdlib/math-base-special-sqrt/dist');function y(r,e){var i,n;return u(e)||u(r)||e<=0||r<0||r>1?NaN:(i=r>.5?1-r:r,n=N(e/2,.5,2*i,1-2*i),l(r-.5)*x(e*n[1]/n[0]))}s.exports=y
|
|
3
|
+
});var v=t(function(h,o){
|
|
4
|
+
var b=require('@stdlib/utils-constant-function/dist'),g=require('@stdlib/math-base-special-kernel-betaincinv/dist'),c=require('@stdlib/math-base-assert-is-nan/dist'),k=require('@stdlib/math-base-special-signum/dist'),B=require('@stdlib/math-base-special-sqrt/dist');function d(r){if(c(r)||r<=0)return b(NaN);return e;function e(i){var n,a;return c(i)||i<0||i>1?NaN:(n=i>.5?1-i:i,a=g(r/2,.5,2*n,1-2*n),k(i-.5)*B(r*a[1]/a[0]))}}o.exports=d
|
|
5
|
+
});var m=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),f=q(),F=v();m(f,"factory",F);module.exports=f;
|
|
6
|
+
/** @license Apache-2.0 */
|
|
7
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
{
|
|
2
|
+
"version": 3,
|
|
3
|
+
"sources": ["../lib/main.js", "../lib/factory.js", "../lib/index.js"],
|
|
4
|
+
"sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 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 kernelBetaincinv = require( '@stdlib/math-base-special-kernel-betaincinv' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar sign = require( '@stdlib/math-base-special-signum' );\nvar sqrt = require( '@stdlib/math-base-special-sqrt' );\n\n\n// MAIN //\n\n/**\n* Evaluates the quantile function for a Student's t distribution with degrees of freedom `v` at a probability `p`.\n*\n* @param {Probability} p - input value\n* @param {PositiveNumber} v - degrees of freedom\n* @returns {number} evaluated quantile function\n*\n* @example\n* var y = quantile( 0.8, 1.0 );\n* // returns ~1.376\n*\n* @example\n* var y = quantile( 0.1, 1.0 );\n* // returns ~-3.078\n*\n* @example\n* var y = quantile( 0.5, 0.1 );\n* // returns 0.0\n*\n* @example\n* var y = quantile( -0.2, 0.1 );\n* // returns NaN\n*\n* @example\n* var y = quantile( NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = quantile( 0.0, NaN );\n* // returns NaN\n*\n* @example\n* var y = quantile( 0.5, -1.0 );\n* // returns NaN\n*/\nfunction quantile( p, v ) {\n\tvar prob;\n\tvar xs;\n\tif (\n\t\tisnan( v ) ||\n\t\tisnan( p ) ||\n\t\tv <= 0.0 ||\n\t\tp < 0.0 ||\n\t\tp > 1.0\n\t) {\n\t\treturn NaN;\n\t}\n\tprob = ( p > 0.5 ) ? 1.0 - p : p;\n\txs = kernelBetaincinv( v / 2.0, 0.5, 2.0 * prob, 1.0 - (2.0 * prob) );\n\treturn sign( p - 0.5 ) * sqrt( v * xs[ 1 ] / xs[ 0 ] );\n}\n\n\n// EXPORTS //\n\nmodule.exports = quantile;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 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 constantFunction = require( '@stdlib/utils-constant-function' );\nvar kernelBetaincinv = require( '@stdlib/math-base-special-kernel-betaincinv' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar sign = require( '@stdlib/math-base-special-signum' );\nvar sqrt = require( '@stdlib/math-base-special-sqrt' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the quantile function for a Student's t distribution with degrees of freedom `v`.\n*\n* @param {PositiveNumber} v - degrees of freedom\n* @returns {Function} quantile function\n*\n* @example\n* var quantile = factory( 0.5 );\n* var y = quantile( 0.5 );\n* // returns 0.0\n*\n* y = quantile( 0.8 );\n* // returns ~2.513\n*\n* y = quantile( 1.0 );\n* // returns Infinity\n*/\nfunction factory( v ) {\n\tif ( isnan( v ) || v <= 0.0 ) {\n\t\treturn constantFunction( NaN );\n\t}\n\treturn quantile;\n\n\t/**\n\t* Evaluates the quantile function for a Student's t distribution.\n\t*\n\t* @private\n\t* @param {Probability} p - input value\n\t* @returns {number} 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 prob;\n\t\tvar xs;\n\n\t\tif ( isnan( p ) || p < 0.0 || p > 1.0 ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tprob = ( p > 0.5 ) ? 1.0 - p : p;\n\t\txs = kernelBetaincinv( v / 2.0, 0.5, 2.0 * prob, 1.0 - (2.0 * prob) );\n\t\treturn sign( p - 0.5 ) * sqrt( v * xs[ 1 ] / xs[ 0 ] );\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 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* Evaluate the quantile function for a Student's t distribution.\n*\n* @module @stdlib/stats-base-dists-t-quantile\n*\n* @example\n* var quantile = require( '@stdlib/stats-base-dists-t-quantile' );\n*\n* var y = quantile( 0.8, 1.0 );\n* // returns ~1.376\n*\n* y = quantile( 0.1, 1.0 );\n* // returns ~-3.078\n*\n* y = quantile( 0.5, 0.1 );\n* // returns 0.0\n*\n* var myquantile = quantile.factory( 4.0 );\n*\n* y = myquantile( 0.2 );\n* // returns ~-0.941\n*\n* y = myquantile( 0.9 );\n* // returns ~1.533\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,EAAmB,QAAS,6CAA8C,EAC1EC,EAAQ,QAAS,iCAAkC,EACnDC,EAAO,QAAS,kCAAmC,EACnDC,EAAO,QAAS,gCAAiC,EAwCrD,SAASC,EAAUC,EAAGC,EAAI,CACzB,IAAIC,EACAC,EACJ,OACCP,EAAOK,CAAE,GACTL,EAAOI,CAAE,GACTC,GAAK,GACLD,EAAI,GACJA,EAAI,EAEG,KAERE,EAASF,EAAI,GAAQ,EAAMA,EAAIA,EAC/BG,EAAKR,EAAkBM,EAAI,EAAK,GAAK,EAAMC,EAAM,EAAO,EAAMA,CAAM,EAC7DL,EAAMG,EAAI,EAAI,EAAIF,EAAMG,EAAIE,EAAI,CAAE,EAAIA,EAAI,CAAE,CAAE,EACtD,CAKAT,EAAO,QAAUK,ICrFjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAmB,QAAS,6CAA8C,EAC1EC,EAAQ,QAAS,iCAAkC,EACnDC,EAAO,QAAS,kCAAmC,EACnDC,EAAO,QAAS,gCAAiC,EAsBrD,SAASC,EAASC,EAAI,CACrB,GAAKJ,EAAOI,CAAE,GAAKA,GAAK,EACvB,OAAON,EAAkB,GAAI,EAE9B,OAAOO,EAaP,SAASA,EAAUC,EAAI,CACtB,IAAIC,EACAC,EAEJ,OAAKR,EAAOM,CAAE,GAAKA,EAAI,GAAOA,EAAI,EAC1B,KAERC,EAASD,EAAI,GAAQ,EAAMA,EAAIA,EAC/BE,EAAKT,EAAkBK,EAAI,EAAK,GAAK,EAAMG,EAAM,EAAO,EAAMA,CAAM,EAC7DN,EAAMK,EAAI,EAAI,EAAIJ,EAAME,EAAII,EAAI,CAAE,EAAIA,EAAI,CAAE,CAAE,EACtD,CACD,CAKAX,EAAO,QAAUM,ICjCjB,IAAIM,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
|
|
6
|
+
"names": ["require_main", "__commonJSMin", "exports", "module", "kernelBetaincinv", "isnan", "sign", "sqrt", "quantile", "p", "v", "prob", "xs", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "kernelBetaincinv", "isnan", "sign", "sqrt", "factory", "v", "quantile", "p", "prob", "xs", "setReadOnly", "main", "factory"]
|
|
7
|
+
}
|
package/docs/types/index.d.ts
CHANGED
package/lib/index.js
CHANGED
|
@@ -47,15 +47,15 @@
|
|
|
47
47
|
// MODULES //
|
|
48
48
|
|
|
49
49
|
var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
|
|
50
|
-
var
|
|
50
|
+
var main = require( './main.js' );
|
|
51
51
|
var factory = require( './factory.js' );
|
|
52
52
|
|
|
53
53
|
|
|
54
54
|
// MAIN //
|
|
55
55
|
|
|
56
|
-
setReadOnly(
|
|
56
|
+
setReadOnly( main, 'factory', factory );
|
|
57
57
|
|
|
58
58
|
|
|
59
59
|
// EXPORTS //
|
|
60
60
|
|
|
61
|
-
module.exports =
|
|
61
|
+
module.exports = main;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stdlib/stats-base-dists-t-quantile",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.1.0",
|
|
4
4
|
"description": "Student's t distribution quantile function.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": {
|
|
@@ -37,23 +37,23 @@
|
|
|
37
37
|
"url": "https://github.com/stdlib-js/stdlib/issues"
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@stdlib/math-base-assert-is-nan": "^0.0
|
|
41
|
-
"@stdlib/math-base-special-kernel-betaincinv": "^0.0
|
|
42
|
-
"@stdlib/math-base-special-signum": "^0.0
|
|
43
|
-
"@stdlib/math-base-special-sqrt": "^0.0
|
|
44
|
-
"@stdlib/utils-constant-function": "^0.0
|
|
45
|
-
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.0
|
|
40
|
+
"@stdlib/math-base-assert-is-nan": "^0.1.0",
|
|
41
|
+
"@stdlib/math-base-special-kernel-betaincinv": "^0.1.0",
|
|
42
|
+
"@stdlib/math-base-special-signum": "^0.1.0",
|
|
43
|
+
"@stdlib/math-base-special-sqrt": "^0.1.0",
|
|
44
|
+
"@stdlib/utils-constant-function": "^0.1.0",
|
|
45
|
+
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0"
|
|
46
46
|
},
|
|
47
47
|
"devDependencies": {
|
|
48
|
-
"@stdlib/bench": "^0.0
|
|
49
|
-
"@stdlib/constants-float64-eps": "^0.0
|
|
50
|
-
"@stdlib/constants-float64-ninf": "^0.0
|
|
51
|
-
"@stdlib/math-base-special-abs": "^0.0
|
|
52
|
-
"@stdlib/math-base-special-ceil": "^0.0
|
|
53
|
-
"@stdlib/random-base-randu": "^0.0.
|
|
48
|
+
"@stdlib/bench": "^0.1.0",
|
|
49
|
+
"@stdlib/constants-float64-eps": "^0.1.0",
|
|
50
|
+
"@stdlib/constants-float64-ninf": "^0.1.0",
|
|
51
|
+
"@stdlib/math-base-special-abs": "^0.1.0",
|
|
52
|
+
"@stdlib/math-base-special-ceil": "^0.1.0",
|
|
53
|
+
"@stdlib/random-base-randu": "^0.0.8",
|
|
54
54
|
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
|
|
55
55
|
"istanbul": "^0.4.1",
|
|
56
|
-
"tap-
|
|
56
|
+
"tap-min": "git+https://github.com/Planeshifter/tap-min.git"
|
|
57
57
|
},
|
|
58
58
|
"engines": {
|
|
59
59
|
"node": ">=0.10.0",
|
|
@@ -88,7 +88,7 @@
|
|
|
88
88
|
"continuous"
|
|
89
89
|
],
|
|
90
90
|
"funding": {
|
|
91
|
-
"type": "
|
|
92
|
-
"url": "https://
|
|
91
|
+
"type": "opencollective",
|
|
92
|
+
"url": "https://opencollective.com/stdlib"
|
|
93
93
|
}
|
|
94
94
|
}
|
package/docs/repl.txt
DELETED
|
@@ -1,70 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
{{alias}}( p, v )
|
|
3
|
-
Evaluates the quantile function for a Student's t distribution with degrees
|
|
4
|
-
of freedom `v` 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 provided a non-positive value for `v`, the function returns `NaN`.
|
|
11
|
-
|
|
12
|
-
Parameters
|
|
13
|
-
----------
|
|
14
|
-
p: number
|
|
15
|
-
Input probability.
|
|
16
|
-
|
|
17
|
-
v: number
|
|
18
|
-
Degrees of freedom.
|
|
19
|
-
|
|
20
|
-
Returns
|
|
21
|
-
-------
|
|
22
|
-
out: number
|
|
23
|
-
Evaluated quantile function.
|
|
24
|
-
|
|
25
|
-
Examples
|
|
26
|
-
--------
|
|
27
|
-
> var y = {{alias}}( 0.8, 1.0 )
|
|
28
|
-
~1.376
|
|
29
|
-
> y = {{alias}}( 0.1, 1.0 )
|
|
30
|
-
~-3.078
|
|
31
|
-
> y = {{alias}}( 0.5, 0.1 )
|
|
32
|
-
0.0
|
|
33
|
-
|
|
34
|
-
> y = {{alias}}( -0.2, 0.1 )
|
|
35
|
-
NaN
|
|
36
|
-
|
|
37
|
-
> y = {{alias}}( NaN, 1.0 )
|
|
38
|
-
NaN
|
|
39
|
-
> y = {{alias}}( 0.0, NaN )
|
|
40
|
-
NaN
|
|
41
|
-
|
|
42
|
-
> y = {{alias}}( 0.5, -1.0 )
|
|
43
|
-
NaN
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
{{alias}}.factory( v )
|
|
47
|
-
Returns a function for evaluating the quantile function of a Student's t
|
|
48
|
-
distribution with degrees of freedom `v`.
|
|
49
|
-
|
|
50
|
-
Parameters
|
|
51
|
-
----------
|
|
52
|
-
v: number
|
|
53
|
-
Degrees of freedom.
|
|
54
|
-
|
|
55
|
-
Returns
|
|
56
|
-
-------
|
|
57
|
-
quantile: Function
|
|
58
|
-
Quantile function.
|
|
59
|
-
|
|
60
|
-
Examples
|
|
61
|
-
--------
|
|
62
|
-
> var myQuantile = {{alias}}.factory( 4.0 );
|
|
63
|
-
> var y = myQuantile( 0.2 )
|
|
64
|
-
~-0.941
|
|
65
|
-
> y = myQuantile( 0.9 )
|
|
66
|
-
~1.533
|
|
67
|
-
|
|
68
|
-
See Also
|
|
69
|
-
--------
|
|
70
|
-
|
package/docs/types/test.ts
DELETED
|
@@ -1,98 +0,0 @@
|
|
|
1
|
-
/*
|
|
2
|
-
* @license Apache-2.0
|
|
3
|
-
*
|
|
4
|
-
* Copyright (c) 2019 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
|