@stdlib/stats-base-dists-gumbel-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 +16 -15
- package/docs/repl.txt +0 -74
- 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] -->
|
|
@@ -190,7 +201,7 @@ See [LICENSE][stdlib-license].
|
|
|
190
201
|
|
|
191
202
|
## Copyright
|
|
192
203
|
|
|
193
|
-
Copyright © 2016-
|
|
204
|
+
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
|
|
194
205
|
|
|
195
206
|
</section>
|
|
196
207
|
|
|
@@ -203,8 +214,8 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
203
214
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-gumbel-logpdf.svg
|
|
204
215
|
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-gumbel-logpdf
|
|
205
216
|
|
|
206
|
-
[test-image]: https://github.com/stdlib-js/stats-base-dists-gumbel-logpdf/actions/workflows/test.yml/badge.svg?branch=v0.0
|
|
207
|
-
[test-url]: https://github.com/stdlib-js/stats-base-dists-gumbel-logpdf/actions/workflows/test.yml?query=branch:v0.0
|
|
217
|
+
[test-image]: https://github.com/stdlib-js/stats-base-dists-gumbel-logpdf/actions/workflows/test.yml/badge.svg?branch=v0.2.0
|
|
218
|
+
[test-url]: https://github.com/stdlib-js/stats-base-dists-gumbel-logpdf/actions/workflows/test.yml?query=branch:v0.2.0
|
|
208
219
|
|
|
209
220
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-gumbel-logpdf/main.svg
|
|
210
221
|
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-gumbel-logpdf?branch=main
|
|
@@ -217,7 +228,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
217
228
|
-->
|
|
218
229
|
|
|
219
230
|
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
220
|
-
[chat-url]: https://gitter.im
|
|
231
|
+
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
|
|
221
232
|
|
|
222
233
|
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
223
234
|
|
|
@@ -227,8 +238,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
227
238
|
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
|
|
228
239
|
|
|
229
240
|
[deno-url]: https://github.com/stdlib-js/stats-base-dists-gumbel-logpdf/tree/deno
|
|
241
|
+
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-gumbel-logpdf/blob/deno/README.md
|
|
230
242
|
[umd-url]: https://github.com/stdlib-js/stats-base-dists-gumbel-logpdf/tree/umd
|
|
243
|
+
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-gumbel-logpdf/blob/umd/README.md
|
|
231
244
|
[esm-url]: https://github.com/stdlib-js/stats-base-dists-gumbel-logpdf/tree/esm
|
|
245
|
+
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-gumbel-logpdf/blob/esm/README.md
|
|
232
246
|
[branches-url]: https://github.com/stdlib-js/stats-base-dists-gumbel-logpdf/blob/main/branches.md
|
|
233
247
|
|
|
234
248
|
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-gumbel-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 s=f(function(j,o){
|
|
2
|
+
var a=require('@stdlib/math-base-assert-is-nan/dist'),p=require('@stdlib/math-base-special-exp/dist'),l=require('@stdlib/math-base-special-ln/dist'),y=require('@stdlib/constants-float64-ninf/dist');function d(e,r,i){var n;return a(e)||a(r)||a(i)||i<=0?NaN:e===y?0:(n=(e-r)/i,-n-p(-n)-l(i))}o.exports=d
|
|
3
|
+
});var c=f(function(k,q){
|
|
4
|
+
var F=require('@stdlib/utils-constant-function/dist'),v=require('@stdlib/math-base-assert-is-nan/dist'),g=require('@stdlib/math-base-special-exp/dist'),z=require('@stdlib/math-base-special-ln/dist'),I=require('@stdlib/constants-float64-ninf/dist');function x(e,r){var i;if(v(e)||v(r)||r<=0)return F(NaN);return i=z(r),n;function n(u){var t;return v(u)?NaN:u===I?0:(t=(u-e)/r,-t-g(-t)-i)}}q.exports=x
|
|
5
|
+
});var O=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),N=s(),R=c();O(N,"factory",R);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 exp = require( '@stdlib/math-base-special-exp' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\n\n\n// MAIN //\n\n/**\n* Evaluates the logarithm of the probability density function (PDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`.\n*\n* @param {number} x - input value\n* @param {number} mu - location parameter\n* @param {PositiveNumber} beta - scale parameter\n* @returns {number} evaluated logarithm of PDF\n*\n* @example\n* var y = logpdf( 0.0, 0.0, 2.0 );\n* // returns ~-1.693\n*\n* @example\n* var y = logpdf( 0.0, 0.0, 1.0 );\n* // returns ~-1.0\n*\n* @example\n* var y = logpdf( 1.0, 3.0, 2.0 );\n* // returns ~-2.411\n*\n* @example\n* var y = logpdf( NaN, 0.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, 0.0, NaN );\n* // returns NaN\n*\n* @example\n* // Negative scale parameter:\n* var y = logpdf( 2.0, 0.0, -1.0 );\n* // returns NaN\n*/\nfunction logpdf( x, mu, beta ) {\n\tvar z;\n\tif (\n\t\tisnan( x ) ||\n\t\tisnan( mu ) ||\n\t\tisnan( beta ) ||\n\t\tbeta <= 0.0\n\t) {\n\t\treturn NaN;\n\t}\n\tif ( x === NINF ) {\n\t\treturn 0.0;\n\t}\n\tz = ( x - mu ) / beta;\n\treturn -z - exp( -z ) - ln( beta );\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 exp = require( '@stdlib/math-base-special-exp' );\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 logarithm of the probability density function (PDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta`.\n*\n* @param {number} mu - location parameter\n* @param {PositiveNumber} beta - scale parameter\n* @returns {Function} logPDF\n*\n* @example\n* var logpdf = factory( 0.0, 2.0 );\n* var y = logpdf( 0.0 );\n* // returns ~-1.693\n*/\nfunction factory( mu, beta ) {\n\tvar lbeta;\n\tif (\n\t\tisnan( mu ) ||\n\t\tisnan( beta ) ||\n\t\tbeta <= 0.0\n\t) {\n\t\treturn constantFunction( NaN );\n\t}\n\tlbeta = ln( beta );\n\treturn logpdf;\n\n\t/**\n\t* Evaluates the logarithm of the probability density function (PDF) for a Gumbel 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.3 );\n\t* // returns <number>\n\t*/\n\tfunction logpdf( x ) {\n\t\tvar z;\n\t\tif ( isnan( x ) ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tif ( x === NINF ) {\n\t\t\treturn 0.0;\n\t\t}\n\t\tz = ( x - mu ) / beta;\n\t\treturn -z - exp( -z ) - lbeta;\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* Gumbel distribution logarithm of probability density function (PDF).\n*\n* @module @stdlib/stats-base-dists-gumbel-logpdf\n*\n* @example\n* var logpdf = require( '@stdlib/stats-base-dists-gumbel-logpdf' );\n*\n* var y = logpdf( 2.0, 0.0, 1.0 );\n* // returns ~-2.137\n*\n* var mylogpdf = logpdf.factory( 10.0, 2.0 );\n* y = mylogpdf( 10.0 );\n* // returns ~-1.693\n*\n* y = mylogpdf( 12.0 );\n* // returns ~-2.064\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,EA0CrD,SAASC,EAAQC,EAAGC,EAAIC,EAAO,CAC9B,IAAIC,EACJ,OACCR,EAAOK,CAAE,GACTL,EAAOM,CAAG,GACVN,EAAOO,CAAK,GACZA,GAAQ,EAED,IAEHF,IAAMF,EACH,GAERK,GAAMH,EAAIC,GAAOC,EACV,CAACC,EAAIP,EAAK,CAACO,CAAE,EAAIN,EAAIK,CAAK,EAClC,CAKAR,EAAO,QAAUK,ICvFjB,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,EAiBrD,SAASC,EAASC,EAAIC,EAAO,CAC5B,IAAIC,EACJ,GACCP,EAAOK,CAAG,GACVL,EAAOM,CAAK,GACZA,GAAQ,EAER,OAAOP,EAAkB,GAAI,EAE9B,OAAAQ,EAAQL,EAAII,CAAK,EACVE,EAaP,SAASA,EAAQC,EAAI,CACpB,IAAIC,EACJ,OAAKV,EAAOS,CAAE,EACN,IAEHA,IAAMN,EACH,GAERO,GAAMD,EAAIJ,GAAOC,EACV,CAACI,EAAIT,EAAK,CAACS,CAAE,EAAIH,EACzB,CACD,CAKAT,EAAO,QAAUM,ICzCjB,IAAIO,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
|
|
6
|
+
"names": ["require_main", "__commonJSMin", "exports", "module", "isnan", "exp", "ln", "NINF", "logpdf", "x", "mu", "beta", "z", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "isnan", "exp", "ln", "NINF", "factory", "mu", "beta", "lbeta", "logpdf", "x", "z", "setReadOnly", "main", "factory"]
|
|
7
|
+
}
|
package/docs/types/index.d.ts
CHANGED
package/lib/index.js
CHANGED
|
@@ -40,15 +40,15 @@
|
|
|
40
40
|
// MODULES //
|
|
41
41
|
|
|
42
42
|
var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
|
|
43
|
-
var
|
|
43
|
+
var main = require( './main.js' );
|
|
44
44
|
var factory = require( './factory.js' );
|
|
45
45
|
|
|
46
46
|
|
|
47
47
|
// MAIN //
|
|
48
48
|
|
|
49
|
-
setReadOnly(
|
|
49
|
+
setReadOnly( main, 'factory', factory );
|
|
50
50
|
|
|
51
51
|
|
|
52
52
|
// EXPORTS //
|
|
53
53
|
|
|
54
|
-
module.exports =
|
|
54
|
+
module.exports = main;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stdlib/stats-base-dists-gumbel-logpdf",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Gumbel distribution logarithm of probability density function (PDF).",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": {
|
|
@@ -37,22 +37,23 @@
|
|
|
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-exp": "^0.0
|
|
43
|
-
"@stdlib/math-base-special-ln": "^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-exp": "^0.2.0",
|
|
43
|
+
"@stdlib/math-base-special-ln": "^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/random-base-randu": "^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",
|
|
53
52
|
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
|
|
54
53
|
"istanbul": "^0.4.1",
|
|
55
|
-
"tap-
|
|
54
|
+
"tap-min": "git+https://github.com/Planeshifter/tap-min.git",
|
|
55
|
+
"@stdlib/bench-harness": "^0.2.0",
|
|
56
|
+
"@stdlib/bench": "^0.3.1"
|
|
56
57
|
},
|
|
57
58
|
"engines": {
|
|
58
59
|
"node": ">=0.10.0",
|
|
@@ -85,7 +86,7 @@
|
|
|
85
86
|
"continuous"
|
|
86
87
|
],
|
|
87
88
|
"funding": {
|
|
88
|
-
"type": "
|
|
89
|
-
"url": "https://
|
|
89
|
+
"type": "opencollective",
|
|
90
|
+
"url": "https://opencollective.com/stdlib"
|
|
90
91
|
}
|
|
91
92
|
}
|
package/docs/repl.txt
DELETED
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
{{alias}}( x, μ, β )
|
|
3
|
-
Evaluates the logarithm of the probability density function (PDF) for a
|
|
4
|
-
Gumbel distribution with location parameter `μ` and scale parameter `β` at a
|
|
5
|
-
value `x`.
|
|
6
|
-
|
|
7
|
-
If provided `NaN` as any argument, the function returns `NaN`.
|
|
8
|
-
|
|
9
|
-
If provided `β <= 0`, the function returns `NaN`.
|
|
10
|
-
|
|
11
|
-
Parameters
|
|
12
|
-
----------
|
|
13
|
-
x: number
|
|
14
|
-
Input value.
|
|
15
|
-
|
|
16
|
-
μ: number
|
|
17
|
-
Location parameter.
|
|
18
|
-
|
|
19
|
-
β: number
|
|
20
|
-
Scale parameter.
|
|
21
|
-
|
|
22
|
-
Returns
|
|
23
|
-
-------
|
|
24
|
-
out: number
|
|
25
|
-
Evaluated logPDF.
|
|
26
|
-
|
|
27
|
-
Examples
|
|
28
|
-
--------
|
|
29
|
-
> var y = {{alias}}( 0.0, 0.0, 2.0 )
|
|
30
|
-
~-1.693
|
|
31
|
-
> y = {{alias}}( 0.0, 0.0, 1.0 )
|
|
32
|
-
~-1
|
|
33
|
-
> y = {{alias}}( 1.0, 3.0, 2.0 )
|
|
34
|
-
~-2.411
|
|
35
|
-
> y = {{alias}}( NaN, 0.0, 1.0 )
|
|
36
|
-
NaN
|
|
37
|
-
> y = {{alias}}( 0.0, NaN, 1.0 )
|
|
38
|
-
NaN
|
|
39
|
-
> y = {{alias}}( 0.0, 0.0, NaN )
|
|
40
|
-
NaN
|
|
41
|
-
// Negative scale parameter:
|
|
42
|
-
> y = {{alias}}( 2.0, 0.0, -1.0 )
|
|
43
|
-
NaN
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
{{alias}}.factory( μ, β )
|
|
47
|
-
Returns a function for evaluating the logarithm of the probability density
|
|
48
|
-
function (PDF) of a Gumbel distribution with location parameter `μ` and
|
|
49
|
-
scale parameter `β`.
|
|
50
|
-
|
|
51
|
-
Parameters
|
|
52
|
-
----------
|
|
53
|
-
μ: number
|
|
54
|
-
Location parameter.
|
|
55
|
-
|
|
56
|
-
β: number
|
|
57
|
-
Scale parameter.
|
|
58
|
-
|
|
59
|
-
Returns
|
|
60
|
-
-------
|
|
61
|
-
logpdf: Function
|
|
62
|
-
Logarithm of probability density function (PDF).
|
|
63
|
-
|
|
64
|
-
Examples
|
|
65
|
-
--------
|
|
66
|
-
> var mylogpdf = {{alias}}.factory( 10.0, 2.0 );
|
|
67
|
-
> var y = mylogpdf( 10.0 )
|
|
68
|
-
~-1.693
|
|
69
|
-
> y = mylogpdf( 12.0 )
|
|
70
|
-
~-2.061
|
|
71
|
-
|
|
72
|
-
See Also
|
|
73
|
-
--------
|
|
74
|
-
|
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, 2, 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( 3, 4 ); // $ExpectType Unary
|
|
65
|
-
}
|
|
66
|
-
|
|
67
|
-
// The `factory` method returns a function which returns a number...
|
|
68
|
-
{
|
|
69
|
-
const fcn = logpdf.factory( 3, 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( 3, 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( 3, 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
|