@stdlib/stats-base-dists-kumaraswamy-cdf 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 +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 +15 -14
- package/docs/repl.txt +0 -83
- package/docs/types/test.ts +0 -119
- /package/lib/{cdf.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
|
# Cumulative Distribution 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] -->
|
|
@@ -206,7 +217,7 @@ See [LICENSE][stdlib-license].
|
|
|
206
217
|
|
|
207
218
|
## Copyright
|
|
208
219
|
|
|
209
|
-
Copyright © 2016-
|
|
220
|
+
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
|
|
210
221
|
|
|
211
222
|
</section>
|
|
212
223
|
|
|
@@ -219,8 +230,8 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
219
230
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-kumaraswamy-cdf.svg
|
|
220
231
|
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-kumaraswamy-cdf
|
|
221
232
|
|
|
222
|
-
[test-image]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-cdf/actions/workflows/test.yml/badge.svg?branch=v0.0
|
|
223
|
-
[test-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-cdf/actions/workflows/test.yml?query=branch:v0.0
|
|
233
|
+
[test-image]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-cdf/actions/workflows/test.yml/badge.svg?branch=v0.2.0
|
|
234
|
+
[test-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-cdf/actions/workflows/test.yml?query=branch:v0.2.0
|
|
224
235
|
|
|
225
236
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-kumaraswamy-cdf/main.svg
|
|
226
237
|
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-kumaraswamy-cdf?branch=main
|
|
@@ -233,7 +244,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
233
244
|
-->
|
|
234
245
|
|
|
235
246
|
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
236
|
-
[chat-url]: https://gitter.im
|
|
247
|
+
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
|
|
237
248
|
|
|
238
249
|
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
239
250
|
|
|
@@ -243,8 +254,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
243
254
|
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
|
|
244
255
|
|
|
245
256
|
[deno-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-cdf/tree/deno
|
|
257
|
+
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-cdf/blob/deno/README.md
|
|
246
258
|
[umd-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-cdf/tree/umd
|
|
259
|
+
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-cdf/blob/umd/README.md
|
|
247
260
|
[esm-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-cdf/tree/esm
|
|
261
|
+
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-cdf/blob/esm/README.md
|
|
248
262
|
[branches-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-cdf/blob/main/branches.md
|
|
249
263
|
|
|
250
264
|
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-kumaraswamy-cdf/main/LICENSE
|
package/SECURITY.md
ADDED
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";var a=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var o=a(function(F,c){
|
|
2
|
+
var i=require('@stdlib/math-base-assert-is-nan/dist'),f=require('@stdlib/math-base-special-pow/dist');function p(e,r,t){return i(e)||i(r)||i(t)||r<=0||t<=0?NaN:e<=0?0:e>=1?1:1-f(1-f(e,r),t)}c.exports=p
|
|
3
|
+
});var v=a(function(O,q){
|
|
4
|
+
var y=require('@stdlib/utils-constant-function/dist'),u=require('@stdlib/math-base-assert-is-nan/dist'),s=require('@stdlib/math-base-special-pow/dist');function d(e,r){if(u(e)||u(r)||e<=0||r<=0)return y(NaN);return t;function t(n){return u(n)?NaN:n<=0?0:n>=1?1:1-s(1-s(n,e),r)}}q.exports=d
|
|
5
|
+
});var w=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),N=o(),l=v();w(N,"factory",l);module.exports=N;
|
|
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 isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar pow = require( '@stdlib/math-base-special-pow' );\n\n\n// MAIN //\n\n/**\n* Evaluates the cumulative distribution function (CDF) for a Kumaraswamy's double bounded distribution with first shape parameter `a` and second shape parameter `b` at a value `x`.\n*\n* @param {number} x - input value\n* @param {PositiveNumber} a - first shape parameter\n* @param {PositiveNumber} b - second shape parameter\n* @returns {Probability} evaluated CDF\n*\n* @example\n* var y = cdf( 0.5, 1.0, 1.0 );\n* // returns ~0.5\n*\n* @example\n* var y = cdf( 0.5, 2.0, 4.0 );\n* // returns ~0.684\n*\n* @example\n* var y = cdf( 0.2, 2.0, 2.0 );\n* // returns ~0.078\n*\n* @example\n* var y = cdf( 0.8, 4.0, 4.0 );\n* // returns ~0.878\n*\n* @example\n* var y = cdf( -0.5, 4.0, 2.0 );\n* // returns 0.0\n*\n* @example\n* var y = cdf( 1.5, 4.0, 2.0 );\n* // returns 1.0\n*\n* @example\n* var y = cdf( 2.0, -1.0, 0.5 );\n* // returns NaN\n*\n* @example\n* var y = cdf( 2.0, 0.5, -1.0 );\n* // returns NaN\n*\n* @example\n* var y = cdf( NaN, 1.0, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = cdf( 0.0, NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = cdf( 0.0, 1.0, NaN );\n* // returns NaN\n*/\nfunction cdf( x, a, b ) {\n\tif (\n\t\tisnan( x ) ||\n\t\tisnan( a ) ||\n\t\tisnan( b ) ||\n\t\ta <= 0.0 ||\n\t\tb <= 0.0\n\t) {\n\t\treturn NaN;\n\t}\n\tif ( x <= 0.0 ) {\n\t\treturn 0.0;\n\t}\n\tif ( x >= 1.0 ) {\n\t\treturn 1.0;\n\t}\n\treturn 1.0 - pow( 1.0 - pow( x, a ), b );\n}\n\n\n// EXPORTS //\n\nmodule.exports = cdf;\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 isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar pow = require( '@stdlib/math-base-special-pow' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the cumulative distribution function (CDF) for a Kumaraswamy's double bounded distribution with first shape parameter `a` and second shape parameter `b`.\n*\n* @param {PositiveNumber} a - first shape parameter\n* @param {PositiveNumber} b - second shape parameter\n* @returns {Function} CDF\n*\n* @example\n* var cdf = factory( 0.5, 0.5 );\n*\n* var y = cdf( 0.8 );\n* // returns ~0.675\n*\n* y = cdf( 0.3 );\n* // returns ~0.327\n*/\nfunction factory( a, b ) {\n\tif (\n\t\tisnan( a ) ||\n\t\tisnan( b ) ||\n\t\ta <= 0.0 ||\n\t\tb <= 0.0\n\t) {\n\t\treturn constantFunction( NaN );\n\t}\n\treturn cdf;\n\n\t/**\n\t* Evaluates the cumulative distribution function (CDF) for a Kumaraswamy's double bounded distribution.\n\t*\n\t* @private\n\t* @param {number} x - input value\n\t* @returns {Probability} evaluated CDF\n\t*\n\t* @example\n\t* var y = cdf( 2.0 );\n\t* // returns <number>\n\t*/\n\tfunction cdf( x ) {\n\t\tif ( isnan( x ) ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tif ( x <= 0.0 ) {\n\t\t\treturn 0.0;\n\t\t}\n\t\tif ( x >= 1.0 ) {\n\t\t\treturn 1.0;\n\t\t}\n\t\treturn 1.0 - pow( 1.0 - pow( x, a ), b );\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 cumulative distribution function (CDF) for a Kumaraswamy's double bounded distribution.\n*\n* @module @stdlib/stats-base-dists-kumaraswamy-cdf\n*\n* @example\n* var cdf = require( '@stdlib/stats-base-dists-kumaraswamy-cdf' );\n*\n* var y = cdf( 0.5, 1.0, 1.0 );\n* // returns 0.5\n*\n* y = cdf( 0.5, 2.0, 4.0 );\n* // returns ~0.684\n*\n* @example\n* var factory = require( '@stdlib/stats-base-dists-kumaraswamy-cdf' ).factory;\n*\n* var cdf = factory( 0.5, 0.5 );\n*\n* var y = cdf( 0.8 );\n* // returns ~0.675\n*\n* y = cdf( 0.3 );\n* // returns ~0.327\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,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAyDnD,SAASC,EAAKC,EAAGC,EAAGC,EAAI,CACvB,OACCL,EAAOG,CAAE,GACTH,EAAOI,CAAE,GACTJ,EAAOK,CAAE,GACTD,GAAK,GACLC,GAAK,EAEE,IAEHF,GAAK,EACF,EAEHA,GAAK,EACF,EAED,EAAMF,EAAK,EAAMA,EAAKE,EAAGC,CAAE,EAAGC,CAAE,CACxC,CAKAN,EAAO,QAAUG,ICtGjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAqBnD,SAASC,EAASC,EAAGC,EAAI,CACxB,GACCJ,EAAOG,CAAE,GACTH,EAAOI,CAAE,GACTD,GAAK,GACLC,GAAK,EAEL,OAAOL,EAAkB,GAAI,EAE9B,OAAOM,EAaP,SAASA,EAAKC,EAAI,CACjB,OAAKN,EAAOM,CAAE,EACN,IAEHA,GAAK,EACF,EAEHA,GAAK,EACF,EAED,EAAML,EAAK,EAAMA,EAAKK,EAAGH,CAAE,EAAGC,CAAE,CACxC,CACD,CAKAN,EAAO,QAAUI,ICpCjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
|
|
6
|
+
"names": ["require_main", "__commonJSMin", "exports", "module", "isnan", "pow", "cdf", "x", "a", "b", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "isnan", "pow", "factory", "a", "b", "cdf", "x", "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-kumaraswamy-cdf",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Kumaraswamy's double bounded distribution cumulative distribution function (CDF).",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": {
|
|
@@ -37,21 +37,22 @@
|
|
|
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-pow": "^0.0
|
|
42
|
-
"@stdlib/utils-constant-function": "^0.0
|
|
43
|
-
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.0
|
|
40
|
+
"@stdlib/math-base-assert-is-nan": "^0.2.0",
|
|
41
|
+
"@stdlib/math-base-special-pow": "^0.2.0",
|
|
42
|
+
"@stdlib/utils-constant-function": "^0.2.0",
|
|
43
|
+
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0"
|
|
44
44
|
},
|
|
45
45
|
"devDependencies": {
|
|
46
|
-
"@stdlib/assert-is-number": "^0.
|
|
47
|
-
"@stdlib/
|
|
48
|
-
"@stdlib/constants-float64-
|
|
49
|
-
"@stdlib/constants-float64-
|
|
50
|
-
"@stdlib/
|
|
51
|
-
"@stdlib/random-base-randu": "^0.0.x",
|
|
46
|
+
"@stdlib/assert-is-number": "^0.1.1",
|
|
47
|
+
"@stdlib/constants-float64-eps": "^0.1.1",
|
|
48
|
+
"@stdlib/constants-float64-ninf": "^0.1.1",
|
|
49
|
+
"@stdlib/constants-float64-pinf": "^0.1.1",
|
|
50
|
+
"@stdlib/random-base-randu": "^0.1.0",
|
|
52
51
|
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
|
|
53
52
|
"istanbul": "^0.4.1",
|
|
54
|
-
"tap-
|
|
53
|
+
"tap-min": "git+https://github.com/Planeshifter/tap-min.git",
|
|
54
|
+
"@stdlib/bench-harness": "^0.2.0",
|
|
55
|
+
"@stdlib/bench": "^0.3.1"
|
|
55
56
|
},
|
|
56
57
|
"engines": {
|
|
57
58
|
"node": ">=0.10.0",
|
|
@@ -86,7 +87,7 @@
|
|
|
86
87
|
"continuous"
|
|
87
88
|
],
|
|
88
89
|
"funding": {
|
|
89
|
-
"type": "
|
|
90
|
-
"url": "https://
|
|
90
|
+
"type": "opencollective",
|
|
91
|
+
"url": "https://opencollective.com/stdlib"
|
|
91
92
|
}
|
|
92
93
|
}
|
package/docs/repl.txt
DELETED
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
{{alias}}( x, a, b )
|
|
3
|
-
Evaluates the cumulative distribution function (CDF) for Kumaraswamy's
|
|
4
|
-
double bounded distribution with first shape parameter `a` and second shape
|
|
5
|
-
parameter `b` at a value `x`.
|
|
6
|
-
|
|
7
|
-
If provided `NaN` as any argument, the function returns `NaN`.
|
|
8
|
-
|
|
9
|
-
If `a <= 0` or `b <= 0`, the function returns `NaN`.
|
|
10
|
-
|
|
11
|
-
Parameters
|
|
12
|
-
----------
|
|
13
|
-
x: number
|
|
14
|
-
Input value.
|
|
15
|
-
|
|
16
|
-
a: number
|
|
17
|
-
First shape parameter.
|
|
18
|
-
|
|
19
|
-
b: number
|
|
20
|
-
Second shape parameter.
|
|
21
|
-
|
|
22
|
-
Returns
|
|
23
|
-
-------
|
|
24
|
-
out: number
|
|
25
|
-
Evaluated CDF.
|
|
26
|
-
|
|
27
|
-
Examples
|
|
28
|
-
--------
|
|
29
|
-
> var y = {{alias}}( 0.5, 1.0, 1.0 )
|
|
30
|
-
~0.5
|
|
31
|
-
> y = {{alias}}( 0.5, 2.0, 4.0 )
|
|
32
|
-
~0.684
|
|
33
|
-
> y = {{alias}}( 0.2, 2.0, 2.0 )
|
|
34
|
-
~0.078
|
|
35
|
-
> y = {{alias}}( 0.8, 4.0, 4.0 )
|
|
36
|
-
~0.878
|
|
37
|
-
> y = {{alias}}( -0.5, 4.0, 2.0 )
|
|
38
|
-
0.0
|
|
39
|
-
> y = {{alias}}( 1.5, 4.0, 2.0 )
|
|
40
|
-
1.0
|
|
41
|
-
|
|
42
|
-
> y = {{alias}}( 2.0, -1.0, 0.5 )
|
|
43
|
-
NaN
|
|
44
|
-
> y = {{alias}}( 2.0, 0.5, -1.0 )
|
|
45
|
-
NaN
|
|
46
|
-
|
|
47
|
-
> y = {{alias}}( NaN, 1.0, 1.0 )
|
|
48
|
-
NaN
|
|
49
|
-
> y = {{alias}}( 0.0, NaN, 1.0 )
|
|
50
|
-
NaN
|
|
51
|
-
> y = {{alias}}( 0.0, 1.0, NaN )
|
|
52
|
-
NaN
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
{{alias}}.factory( a, b )
|
|
56
|
-
Returns a function for evaluating the cumulative distribution function (CDF)
|
|
57
|
-
of a Kumaraswamy's double bounded distribution with first shape parameter
|
|
58
|
-
`a` and second shape parameter `b`.
|
|
59
|
-
|
|
60
|
-
Parameters
|
|
61
|
-
----------
|
|
62
|
-
a: number
|
|
63
|
-
First shape parameter.
|
|
64
|
-
|
|
65
|
-
b: number
|
|
66
|
-
Second shape parameter.
|
|
67
|
-
|
|
68
|
-
Returns
|
|
69
|
-
-------
|
|
70
|
-
cdf: Function
|
|
71
|
-
Cumulative distribution function (CDF).
|
|
72
|
-
|
|
73
|
-
Examples
|
|
74
|
-
--------
|
|
75
|
-
> var mycdf = {{alias}}.factory( 0.5, 1.0 );
|
|
76
|
-
> var y = mycdf( 0.8 )
|
|
77
|
-
~0.894
|
|
78
|
-
> y = mycdf( 0.3 )
|
|
79
|
-
~0.548
|
|
80
|
-
|
|
81
|
-
See Also
|
|
82
|
-
--------
|
|
83
|
-
|
package/docs/types/test.ts
DELETED
|
@@ -1,119 +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 cdf = require( './index' );
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
// TESTS //
|
|
23
|
-
|
|
24
|
-
// The function returns a number...
|
|
25
|
-
{
|
|
26
|
-
cdf( 2, 0, 4 ); // $ExpectType number
|
|
27
|
-
cdf( 1, 2, 8 ); // $ExpectType number
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
// The compiler throws an error if the function is provided values other than three numbers...
|
|
31
|
-
{
|
|
32
|
-
cdf( true, 3, 6 ); // $ExpectError
|
|
33
|
-
cdf( false, 2, 4 ); // $ExpectError
|
|
34
|
-
cdf( '5', 1, 2 ); // $ExpectError
|
|
35
|
-
cdf( [], 1, 2 ); // $ExpectError
|
|
36
|
-
cdf( {}, 2, 4 ); // $ExpectError
|
|
37
|
-
cdf( ( x: number ): number => x, 2, 4 ); // $ExpectError
|
|
38
|
-
|
|
39
|
-
cdf( 9, true, 12 ); // $ExpectError
|
|
40
|
-
cdf( 9, false, 12 ); // $ExpectError
|
|
41
|
-
cdf( 5, '5', 10 ); // $ExpectError
|
|
42
|
-
cdf( 8, [], 16 ); // $ExpectError
|
|
43
|
-
cdf( 9, {}, 18 ); // $ExpectError
|
|
44
|
-
cdf( 8, ( x: number ): number => x, 16 ); // $ExpectError
|
|
45
|
-
|
|
46
|
-
cdf( 9, 5, true ); // $ExpectError
|
|
47
|
-
cdf( 9, 5, false ); // $ExpectError
|
|
48
|
-
cdf( 5, 2, '5' ); // $ExpectError
|
|
49
|
-
cdf( 8, 4, [] ); // $ExpectError
|
|
50
|
-
cdf( 9, 4, {} ); // $ExpectError
|
|
51
|
-
cdf( 8, 5, ( x: number ): number => x ); // $ExpectError
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
// The compiler throws an error if the function is provided an unsupported number of arguments...
|
|
55
|
-
{
|
|
56
|
-
cdf(); // $ExpectError
|
|
57
|
-
cdf( 2 ); // $ExpectError
|
|
58
|
-
cdf( 2, 0 ); // $ExpectError
|
|
59
|
-
cdf( 2, 0, 4, 1 ); // $ExpectError
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
// Attached to main export is a `factory` method which returns a function...
|
|
63
|
-
{
|
|
64
|
-
cdf.factory( 0, 4 ); // $ExpectType Unary
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
// The `factory` method returns a function which returns a number...
|
|
68
|
-
{
|
|
69
|
-
const fcn = cdf.factory( 0, 4 );
|
|
70
|
-
fcn( 2 ); // $ExpectType number
|
|
71
|
-
}
|
|
72
|
-
|
|
73
|
-
// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments...
|
|
74
|
-
{
|
|
75
|
-
const fcn = cdf.factory( 0, 4 );
|
|
76
|
-
fcn( true ); // $ExpectError
|
|
77
|
-
fcn( false ); // $ExpectError
|
|
78
|
-
fcn( '5' ); // $ExpectError
|
|
79
|
-
fcn( [] ); // $ExpectError
|
|
80
|
-
fcn( {} ); // $ExpectError
|
|
81
|
-
fcn( ( x: number ): number => x ); // $ExpectError
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments...
|
|
85
|
-
{
|
|
86
|
-
const fcn = cdf.factory( 0, 4 );
|
|
87
|
-
fcn(); // $ExpectError
|
|
88
|
-
fcn( 2, 0 ); // $ExpectError
|
|
89
|
-
fcn( 2, 0, 1 ); // $ExpectError
|
|
90
|
-
}
|
|
91
|
-
|
|
92
|
-
// The compiler throws an error if the `factory` method is provided values other than two numbers...
|
|
93
|
-
{
|
|
94
|
-
cdf.factory( true, 3 ); // $ExpectError
|
|
95
|
-
cdf.factory( false, 2 ); // $ExpectError
|
|
96
|
-
cdf.factory( '5', 1 ); // $ExpectError
|
|
97
|
-
cdf.factory( [], 1 ); // $ExpectError
|
|
98
|
-
cdf.factory( {}, 2 ); // $ExpectError
|
|
99
|
-
cdf.factory( ( x: number ): number => x, 2 ); // $ExpectError
|
|
100
|
-
|
|
101
|
-
cdf.factory( 9, true ); // $ExpectError
|
|
102
|
-
cdf.factory( 9, false ); // $ExpectError
|
|
103
|
-
cdf.factory( 5, '5' ); // $ExpectError
|
|
104
|
-
cdf.factory( 8, [] ); // $ExpectError
|
|
105
|
-
cdf.factory( 9, {} ); // $ExpectError
|
|
106
|
-
cdf.factory( 8, ( x: number ): number => x ); // $ExpectError
|
|
107
|
-
|
|
108
|
-
cdf.factory( [], true ); // $ExpectError
|
|
109
|
-
cdf.factory( {}, false ); // $ExpectError
|
|
110
|
-
cdf.factory( false, '5' ); // $ExpectError
|
|
111
|
-
cdf.factory( {}, [] ); // $ExpectError
|
|
112
|
-
cdf.factory( '5', ( x: number ): number => x ); // $ExpectError
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
// The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
|
|
116
|
-
{
|
|
117
|
-
cdf.factory( 0 ); // $ExpectError
|
|
118
|
-
cdf.factory( 0, 4, 8 ); // $ExpectError
|
|
119
|
-
}
|
/package/lib/{cdf.js → main.js}
RENAMED
|
File without changes
|