@stdlib/stats-base-dists-kumaraswamy-logpdf 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 +17 -16
- package/docs/repl.txt +0 -83
- package/docs/types/test.ts +0 -119
- /package/lib/{logpdf.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
|
# Logarithm of Probability Density 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] -->
|
|
@@ -216,7 +227,7 @@ See [LICENSE][stdlib-license].
|
|
|
216
227
|
|
|
217
228
|
## Copyright
|
|
218
229
|
|
|
219
|
-
Copyright © 2016-
|
|
230
|
+
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
|
|
220
231
|
|
|
221
232
|
</section>
|
|
222
233
|
|
|
@@ -229,8 +240,8 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
229
240
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-kumaraswamy-logpdf.svg
|
|
230
241
|
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-kumaraswamy-logpdf
|
|
231
242
|
|
|
232
|
-
[test-image]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logpdf/actions/workflows/test.yml/badge.svg?branch=v0.0
|
|
233
|
-
[test-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logpdf/actions/workflows/test.yml?query=branch:v0.0
|
|
243
|
+
[test-image]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logpdf/actions/workflows/test.yml/badge.svg?branch=v0.2.0
|
|
244
|
+
[test-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logpdf/actions/workflows/test.yml?query=branch:v0.2.0
|
|
234
245
|
|
|
235
246
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-kumaraswamy-logpdf/main.svg
|
|
236
247
|
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-kumaraswamy-logpdf?branch=main
|
|
@@ -243,7 +254,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
243
254
|
-->
|
|
244
255
|
|
|
245
256
|
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
246
|
-
[chat-url]: https://gitter.im
|
|
257
|
+
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
|
|
247
258
|
|
|
248
259
|
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
249
260
|
|
|
@@ -253,8 +264,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
253
264
|
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
|
|
254
265
|
|
|
255
266
|
[deno-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logpdf/tree/deno
|
|
267
|
+
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logpdf/blob/deno/README.md
|
|
256
268
|
[umd-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logpdf/tree/umd
|
|
269
|
+
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logpdf/blob/umd/README.md
|
|
257
270
|
[esm-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logpdf/tree/esm
|
|
271
|
+
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logpdf/blob/esm/README.md
|
|
258
272
|
[branches-url]: https://github.com/stdlib-js/stats-base-dists-kumaraswamy-logpdf/blob/main/branches.md
|
|
259
273
|
|
|
260
274
|
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-kumaraswamy-logpdf/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 f=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var q=f(function(h,s){
|
|
2
|
+
var n=require('@stdlib/math-base-assert-is-nan/dist'),l=require('@stdlib/math-base-special-pow/dist'),a=require('@stdlib/math-base-special-ln/dist'),y=require('@stdlib/constants-float64-ninf/dist');function d(e,r,u){var t;return n(e)||n(r)||n(u)||r<=0||u<=0?NaN:e<=0||e>=1?y:(t=a(r*u),t+=(r-1)*a(e),t+=(u-1)*a(1-l(e,r)),t)}s.exports=d
|
|
3
|
+
});var N=f(function(j,c){
|
|
4
|
+
var F=require('@stdlib/utils-constant-function/dist'),o=require('@stdlib/math-base-assert-is-nan/dist'),g=require('@stdlib/math-base-special-pow/dist'),v=require('@stdlib/math-base-special-ln/dist'),w=require('@stdlib/constants-float64-ninf/dist');function I(e,r){if(o(e)||o(r)||e<=0||r<=0)return F(NaN);return u;function u(t){var i;return o(t)?NaN:t<=0||t>=1?w:(i=v(e*r),i+=(e-1)*v(t),i+=(r-1)*v(1-g(t,e)),i)}}c.exports=I
|
|
5
|
+
});var m=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),p=q(),O=N();m(p,"factory",O);module.exports=p;
|
|
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' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\n\n\n// MAIN //\n\n/**\n* Evaluates the natural logarithm of the probability density function (PDF) 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 {number} evaluated logPDF\n*\n* @example\n* var y = logpdf( 0.5, 1.0, 1.0 );\n* // returns 0.0\n*\n* @example\n* var y = logpdf( 0.5, 2.0, 4.0 );\n* // returns ~0.523\n*\n* @example\n* var y = logpdf( 0.2, 2.0, 2.0 );\n* // returns ~-0.264\n*\n* @example\n* var y = logpdf( 0.8, 4.0, 4.0 );\n* // returns ~0.522\n*\n* @example\n* var y = logpdf( -0.5, 4.0, 2.0 );\n* // returns -Infinity\n*\n* @example\n* var y = logpdf( 1.5, 4.0, 2.0 );\n* // returns -Infinity\n*\n* @example\n* var y = logpdf( 2.0, -1.0, 0.5 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 2.0, 0.5, -1.0 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( NaN, 1.0, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 0.0, NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = logpdf( 0.0, 1.0, NaN );\n* // returns NaN\n*/\nfunction logpdf( x, a, b ) {\n\tvar out;\n\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 || x >= 1.0 ) {\n\t\treturn NINF;\n\t}\n\tout = ln( a*b );\n\tout += ( a - 1.0 ) * ln( x );\n\tout += ( b - 1.0 ) * ln( 1.0 - pow( x, a ) );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = logpdf;\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' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the natural logarithm of the probability density function (PDF) 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} logPDF\n*\n* @example\n* var logpdf = factory( 0.5, 0.5 );\n*\n* var y = logpdf( 0.8 );\n* // returns ~-0.151\n*\n* y = logpdf( 0.3 );\n* // returns ~-0.388\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 logpdf;\n\n\t/**\n\t* Evaluates the natural logarithm of the probability density function (PDF) for a Kumaraswamy's double bounded distribution.\n\t*\n\t* @private\n\t* @param {number} x - input value\n\t* @returns {number} evaluated logPDF\n\t*\n\t* @example\n\t* var y = logpdf( 2.0 );\n\t* // returns <number>\n\t*/\n\tfunction logpdf( x ) {\n\t\tvar out;\n\n\t\tif ( isnan( x ) ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tif ( x <= 0.0 || x >= 1.0 ) {\n\t\t\treturn NINF;\n\t\t}\n\t\tout = ln( a*b );\n\t\tout += ( a - 1.0 ) * ln( x );\n\t\tout += ( b - 1.0 ) * ln( 1.0 - pow( x, a ) );\n\t\treturn out;\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 natural logarithm of the probability density function (PDF) for a Kumaraswamy's double bounded distribution.\n*\n* @module @stdlib/stats-base-dists-kumaraswamy-logpdf\n*\n* @example\n* var logpdf = require( '@stdlib/stats-base-dists-kumaraswamy-logpdf' );\n*\n* var y = logpdf( 0.5, 1.0, 1.0 );\n* // returns 0.0\n*\n* y = logpdf( 0.5, 2.0, 4.0 );\n* // returns ~0.523\n*\n* @example\n* var factory = require( '@stdlib/stats-base-dists-kumaraswamy-logpdf' ).factory;\n*\n* var logpdf = factory( 0.5, 0.5 );\n*\n* var y = logpdf( 0.8 );\n* // returns ~-0.151\n*\n* y = logpdf( 0.3 );\n* // returns ~-0.387\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,EAC/CC,EAAK,QAAS,8BAA+B,EAC7CC,EAAO,QAAS,gCAAiC,EAyDrD,SAASC,EAAQC,EAAGC,EAAGC,EAAI,CAC1B,IAAIC,EAEJ,OACCR,EAAOK,CAAE,GACTL,EAAOM,CAAE,GACTN,EAAOO,CAAE,GACTD,GAAK,GACLC,GAAK,EAEE,IAEHF,GAAK,GAAOA,GAAK,EACdF,GAERK,EAAMN,EAAII,EAAEC,CAAE,EACdC,IAASF,EAAI,GAAQJ,EAAIG,CAAE,EAC3BG,IAASD,EAAI,GAAQL,EAAI,EAAMD,EAAKI,EAAGC,CAAE,CAAE,EACpCE,EACR,CAKAT,EAAO,QAAUK,IC1GjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAK,QAAS,8BAA+B,EAC7CC,EAAO,QAAS,gCAAiC,EAqBrD,SAASC,EAASC,EAAGC,EAAI,CACxB,GACCN,EAAOK,CAAE,GACTL,EAAOM,CAAE,GACTD,GAAK,GACLC,GAAK,EAEL,OAAOP,EAAkB,GAAI,EAE9B,OAAOQ,EAaP,SAASA,EAAQC,EAAI,CACpB,IAAIC,EAEJ,OAAKT,EAAOQ,CAAE,EACN,IAEHA,GAAK,GAAOA,GAAK,EACdL,GAERM,EAAMP,EAAIG,EAAEC,CAAE,EACdG,IAASJ,EAAI,GAAQH,EAAIM,CAAE,EAC3BC,IAASH,EAAI,GAAQJ,EAAI,EAAMD,EAAKO,EAAGH,CAAE,CAAE,EACpCI,EACR,CACD,CAKAX,EAAO,QAAUM,ICxCjB,IAAIM,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", "ln", "NINF", "logpdf", "x", "a", "b", "out", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "isnan", "pow", "ln", "NINF", "factory", "a", "b", "logpdf", "x", "out", "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-logpdf",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Natural logarithm of the probability density function (PDF) for a Kumaraswamy's double bounded distribution.",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": {
|
|
@@ -37,23 +37,24 @@
|
|
|
37
37
|
"url": "https://github.com/stdlib-js/stdlib/issues"
|
|
38
38
|
},
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@stdlib/constants-float64-ninf": "^0.0
|
|
41
|
-
"@stdlib/math-base-assert-is-nan": "^0.0
|
|
42
|
-
"@stdlib/math-base-special-ln": "^0.0
|
|
43
|
-
"@stdlib/math-base-special-pow": "^0.0
|
|
44
|
-
"@stdlib/utils-constant-function": "^0.0
|
|
45
|
-
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.0
|
|
40
|
+
"@stdlib/constants-float64-ninf": "^0.2.0",
|
|
41
|
+
"@stdlib/math-base-assert-is-nan": "^0.2.0",
|
|
42
|
+
"@stdlib/math-base-special-ln": "^0.2.0",
|
|
43
|
+
"@stdlib/math-base-special-pow": "^0.2.0",
|
|
44
|
+
"@stdlib/utils-constant-function": "^0.2.0",
|
|
45
|
+
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0"
|
|
46
46
|
},
|
|
47
47
|
"devDependencies": {
|
|
48
|
-
"@stdlib/
|
|
49
|
-
"@stdlib/constants-float64-
|
|
50
|
-
"@stdlib/
|
|
51
|
-
"@stdlib/
|
|
52
|
-
"@stdlib/
|
|
53
|
-
"@stdlib/stats-base-dists-kumaraswamy-pdf": "^0.0.x",
|
|
48
|
+
"@stdlib/constants-float64-eps": "^0.1.1",
|
|
49
|
+
"@stdlib/constants-float64-pinf": "^0.1.1",
|
|
50
|
+
"@stdlib/math-base-special-abs": "^0.1.1",
|
|
51
|
+
"@stdlib/random-base-randu": "^0.1.0",
|
|
52
|
+
"@stdlib/stats-base-dists-kumaraswamy-pdf": "^0.2.0",
|
|
54
53
|
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
|
|
55
54
|
"istanbul": "^0.4.1",
|
|
56
|
-
"tap-
|
|
55
|
+
"tap-min": "git+https://github.com/Planeshifter/tap-min.git",
|
|
56
|
+
"@stdlib/bench-harness": "^0.2.0",
|
|
57
|
+
"@stdlib/bench": "^0.3.1"
|
|
57
58
|
},
|
|
58
59
|
"engines": {
|
|
59
60
|
"node": ">=0.10.0",
|
|
@@ -90,7 +91,7 @@
|
|
|
90
91
|
"continuous"
|
|
91
92
|
],
|
|
92
93
|
"funding": {
|
|
93
|
-
"type": "
|
|
94
|
-
"url": "https://
|
|
94
|
+
"type": "opencollective",
|
|
95
|
+
"url": "https://opencollective.com/stdlib"
|
|
95
96
|
}
|
|
96
97
|
}
|
package/docs/repl.txt
DELETED
|
@@ -1,83 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
{{alias}}( x, a, b )
|
|
3
|
-
Evaluates the natural logarithm of the probability density function (PDF)
|
|
4
|
-
for Kumaraswamy's double bounded distribution with first shape parameter `a`
|
|
5
|
-
and second shape 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 logPDF.
|
|
26
|
-
|
|
27
|
-
Examples
|
|
28
|
-
--------
|
|
29
|
-
> var y = {{alias}}( 0.5, 1.0, 1.0 )
|
|
30
|
-
0.0
|
|
31
|
-
> y = {{alias}}( 0.5, 2.0, 4.0 )
|
|
32
|
-
~0.523
|
|
33
|
-
> y = {{alias}}( 0.2, 2.0, 2.0 )
|
|
34
|
-
~-0.264
|
|
35
|
-
> y = {{alias}}( 0.8, 4.0, 4.0 )
|
|
36
|
-
~0.522
|
|
37
|
-
> y = {{alias}}( -0.5, 4.0, 2.0 )
|
|
38
|
-
-Infinity
|
|
39
|
-
> y = {{alias}}( 1.5, 4.0, 2.0 )
|
|
40
|
-
-Infinity
|
|
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 natural logarithm of the probability
|
|
57
|
-
density function (PDF) of a Kumaraswamy's double bounded distribution with
|
|
58
|
-
first shape parameter `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
|
-
logpdf: Function
|
|
71
|
-
Logarithm of probability density function (PDF).
|
|
72
|
-
|
|
73
|
-
Examples
|
|
74
|
-
--------
|
|
75
|
-
> var mylogpdf = {{alias}}.factory( 0.5, 1.0 );
|
|
76
|
-
> var y = mylogpdf( 0.8 )
|
|
77
|
-
~-0.582
|
|
78
|
-
> y = mylogpdf( 0.3 )
|
|
79
|
-
~-0.091
|
|
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 logpdf = require( './index' );
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
// TESTS //
|
|
23
|
-
|
|
24
|
-
// The function returns a number...
|
|
25
|
-
{
|
|
26
|
-
logpdf( 2, 0, 4 ); // $ExpectType number
|
|
27
|
-
logpdf( 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
|
-
logpdf( true, 3, 6 ); // $ExpectError
|
|
33
|
-
logpdf( false, 2, 4 ); // $ExpectError
|
|
34
|
-
logpdf( '5', 1, 2 ); // $ExpectError
|
|
35
|
-
logpdf( [], 1, 2 ); // $ExpectError
|
|
36
|
-
logpdf( {}, 2, 4 ); // $ExpectError
|
|
37
|
-
logpdf( ( x: number ): number => x, 2, 4 ); // $ExpectError
|
|
38
|
-
|
|
39
|
-
logpdf( 9, true, 12 ); // $ExpectError
|
|
40
|
-
logpdf( 9, false, 12 ); // $ExpectError
|
|
41
|
-
logpdf( 5, '5', 10 ); // $ExpectError
|
|
42
|
-
logpdf( 8, [], 16 ); // $ExpectError
|
|
43
|
-
logpdf( 9, {}, 18 ); // $ExpectError
|
|
44
|
-
logpdf( 8, ( x: number ): number => x, 16 ); // $ExpectError
|
|
45
|
-
|
|
46
|
-
logpdf( 9, 5, true ); // $ExpectError
|
|
47
|
-
logpdf( 9, 5, false ); // $ExpectError
|
|
48
|
-
logpdf( 5, 2, '5' ); // $ExpectError
|
|
49
|
-
logpdf( 8, 4, [] ); // $ExpectError
|
|
50
|
-
logpdf( 9, 4, {} ); // $ExpectError
|
|
51
|
-
logpdf( 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
|
-
logpdf(); // $ExpectError
|
|
57
|
-
logpdf( 2 ); // $ExpectError
|
|
58
|
-
logpdf( 2, 0 ); // $ExpectError
|
|
59
|
-
logpdf( 2, 0, 4, 1 ); // $ExpectError
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
// Attached to main export is a `factory` method which returns a function...
|
|
63
|
-
{
|
|
64
|
-
logpdf.factory( 0, 4 ); // $ExpectType Unary
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
// The `factory` method returns a function which returns a number...
|
|
68
|
-
{
|
|
69
|
-
const fcn = logpdf.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 = logpdf.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 = logpdf.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
|
-
logpdf.factory( true, 3 ); // $ExpectError
|
|
95
|
-
logpdf.factory( false, 2 ); // $ExpectError
|
|
96
|
-
logpdf.factory( '5', 1 ); // $ExpectError
|
|
97
|
-
logpdf.factory( [], 1 ); // $ExpectError
|
|
98
|
-
logpdf.factory( {}, 2 ); // $ExpectError
|
|
99
|
-
logpdf.factory( ( x: number ): number => x, 2 ); // $ExpectError
|
|
100
|
-
|
|
101
|
-
logpdf.factory( 9, true ); // $ExpectError
|
|
102
|
-
logpdf.factory( 9, false ); // $ExpectError
|
|
103
|
-
logpdf.factory( 5, '5' ); // $ExpectError
|
|
104
|
-
logpdf.factory( 8, [] ); // $ExpectError
|
|
105
|
-
logpdf.factory( 9, {} ); // $ExpectError
|
|
106
|
-
logpdf.factory( 8, ( x: number ): number => x ); // $ExpectError
|
|
107
|
-
|
|
108
|
-
logpdf.factory( [], true ); // $ExpectError
|
|
109
|
-
logpdf.factory( {}, false ); // $ExpectError
|
|
110
|
-
logpdf.factory( false, '5' ); // $ExpectError
|
|
111
|
-
logpdf.factory( {}, [] ); // $ExpectError
|
|
112
|
-
logpdf.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
|
-
logpdf.factory( 0 ); // $ExpectError
|
|
118
|
-
logpdf.factory( 0, 4, 8 ); // $ExpectError
|
|
119
|
-
}
|
|
File without changes
|