@stdlib/stats-base-dists-rayleigh-pdf 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 -73
- package/docs/types/test.ts +0 -98
- /package/lib/{pdf.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
|
# 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] -->
|
|
@@ -185,7 +196,7 @@ See [LICENSE][stdlib-license].
|
|
|
185
196
|
|
|
186
197
|
## Copyright
|
|
187
198
|
|
|
188
|
-
Copyright © 2016-
|
|
199
|
+
Copyright © 2016-2024. 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-rayleigh-pdf.svg
|
|
199
210
|
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-rayleigh-pdf
|
|
200
211
|
|
|
201
|
-
[test-image]: https://github.com/stdlib-js/stats-base-dists-rayleigh-pdf/actions/workflows/test.yml/badge.svg?branch=v0.0
|
|
202
|
-
[test-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-pdf/actions/workflows/test.yml?query=branch:v0.0
|
|
212
|
+
[test-image]: https://github.com/stdlib-js/stats-base-dists-rayleigh-pdf/actions/workflows/test.yml/badge.svg?branch=v0.2.0
|
|
213
|
+
[test-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-pdf/actions/workflows/test.yml?query=branch:v0.2.0
|
|
203
214
|
|
|
204
215
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-rayleigh-pdf/main.svg
|
|
205
216
|
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-rayleigh-pdf?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
|
|
|
@@ -222,8 +233,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
222
233
|
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
|
|
223
234
|
|
|
224
235
|
[deno-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-pdf/tree/deno
|
|
236
|
+
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-rayleigh-pdf/blob/deno/README.md
|
|
225
237
|
[umd-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-pdf/tree/umd
|
|
238
|
+
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-rayleigh-pdf/blob/umd/README.md
|
|
226
239
|
[esm-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-pdf/tree/esm
|
|
240
|
+
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-rayleigh-pdf/blob/esm/README.md
|
|
227
241
|
[branches-url]: https://github.com/stdlib-js/stats-base-dists-rayleigh-pdf/blob/main/branches.md
|
|
228
242
|
|
|
229
243
|
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-rayleigh-pdf/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 i=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var q=i(function(j,o){
|
|
2
|
+
var a=require('@stdlib/math-base-assert-is-nan/dist'),d=require('@stdlib/math-base-special-exp/dist'),v=require('@stdlib/math-base-special-pow/dist'),f=require('@stdlib/constants-float64-pinf/dist');function F(r,e){var t,u;return a(r)||a(e)||e<0?NaN:e===0?r===0?f:0:r<0||r===f?0:(u=v(e,2),t=1/u,t*r*d(-v(r,2)/(2*u)))}o.exports=F
|
|
3
|
+
});var N=i(function(k,p){
|
|
4
|
+
var w=require('@stdlib/utils-constant-function/dist'),I=require('@stdlib/stats-base-dists-degenerate-pdf/dist').factory,c=require('@stdlib/math-base-assert-is-nan/dist'),P=require('@stdlib/math-base-special-exp/dist'),s=require('@stdlib/math-base-special-pow/dist'),l=require('@stdlib/constants-float64-pinf/dist');function O(r){var e,t;if(c(r)||r<0)return w(NaN);if(r===0)return I(0);return t=s(r,2),e=1/t,u;function u(n){return c(n)?NaN:n<0||n===l?0:e*n*P(-s(n,2)/(2*t))}}p.exports=O
|
|
5
|
+
});var R=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),y=q(),b=N();R(y,"factory",b);module.exports=y;
|
|
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 pow = require( '@stdlib/math-base-special-pow' );\nvar PINF = require( '@stdlib/constants-float64-pinf' );\n\n\n// MAIN //\n\n/**\n* Evaluates the probability density function (PDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`.\n*\n* @param {number} x - input value\n* @param {NonNegativeNumber} sigma - scale parameter\n* @returns {number} evaluated PDF\n*\n* @example\n* var y = pdf( 0.3, 1.0 );\n* // returns ~0.287\n*\n* @example\n* var y = pdf( 2.0, 0.8 );\n* // returns ~0.137\n*\n* @example\n* var y = pdf( -1.0, 0.5 );\n* // returns 0.0\n*\n* @example\n* var y = pdf( 0.0, NaN );\n* // returns NaN\n*\n* @example\n* var y = pdf( NaN, 2.0 );\n* // returns NaN\n*\n* @example\n* // Negative scale parameter:\n* var y = pdf( 2.0, -1.0 );\n* // returns NaN\n*/\nfunction pdf( x, sigma ) {\n\tvar s2i;\n\tvar s2;\n\tif (\n\t\tisnan( x ) ||\n\t\tisnan( sigma ) ||\n\t\tsigma < 0.0\n\t) {\n\t\treturn NaN;\n\t}\n\tif ( sigma === 0.0 ) {\n\t\treturn ( x === 0.0 ) ? PINF : 0.0;\n\t}\n\tif ( x < 0.0 || x === PINF ) {\n\t\treturn 0.0;\n\t}\n\ts2 = pow( sigma, 2.0 );\n\ts2i = 1.0 / s2;\n\treturn s2i * x * exp( -pow( x, 2.0 ) / ( 2.0 * s2 ) );\n}\n\n\n// EXPORTS //\n\nmodule.exports = pdf;\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 degenerate = require( '@stdlib/stats-base-dists-degenerate-pdf' ).factory;\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar exp = require( '@stdlib/math-base-special-exp' );\nvar pow = require( '@stdlib/math-base-special-pow' );\nvar PINF = require( '@stdlib/constants-float64-pinf' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the probability density function (PDF) for a Rayleigh distribution with scale parameter `sigma`.\n*\n* @param {NonNegativeNumber} sigma - scale parameter\n* @returns {Function} PDF\n*\n* @example\n* var pdf = factory( 0.5 );\n* var y = pdf( 1.0 );\n* // returns ~0.541\n*\n* y = pdf( 0.1 );\n* // returns ~0.392\n*/\nfunction factory( sigma ) {\n\tvar s2i;\n\tvar s2;\n\tif ( isnan( sigma ) || sigma < 0.0 ) {\n\t\treturn constantFunction( NaN );\n\t}\n\tif ( sigma === 0.0 ) {\n\t\treturn degenerate( 0.0 );\n\t}\n\ts2 = pow( sigma, 2.0 );\n\ts2i = 1.0 / s2;\n\treturn pdf;\n\n\t/**\n\t* Evaluates the probability density function (PDF) for a Rayleigh distribution.\n\t*\n\t* @private\n\t* @param {number} x - input value\n\t* @returns {number} evaluated PDF\n\t*\n\t* @example\n\t* var y = pdf( 2.3 );\n\t* // returns <number>\n\t*/\n\tfunction pdf( x ) {\n\t\tif ( isnan( x ) ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tif ( x < 0.0 || x === PINF ) {\n\t\t\treturn 0.0;\n\t\t}\n\t\treturn s2i * x * exp( -pow( x, 2.0 ) / ( 2.0 * s2 ) );\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* Rayleigh distribution probability density function (PDF).\n*\n* @module @stdlib/stats-base-dists-rayleigh-pdf\n*\n* @example\n* var pdf = require( '@stdlib/stats-base-dists-rayleigh-pdf' );\n*\n* var y = pdf( 2.0, 4.0 );\n* // returns ~0.11\n*\n* var myPDF = pdf.factory( 4.0 );\n*\n* y = myPDF( 6.0 );\n* // returns ~0.122\n*\n* y = myPDF( 4.0 );\n* // returns ~0.152\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,EAAM,QAAS,+BAAgC,EAC/CC,EAAO,QAAS,gCAAiC,EAqCrD,SAASC,EAAKC,EAAGC,EAAQ,CACxB,IAAIC,EACAC,EACJ,OACCR,EAAOK,CAAE,GACTL,EAAOM,CAAM,GACbA,EAAQ,EAED,IAEHA,IAAU,EACLD,IAAM,EAAQF,EAAO,EAE1BE,EAAI,GAAOA,IAAMF,EACd,GAERK,EAAKN,EAAKI,EAAO,CAAI,EACrBC,EAAM,EAAMC,EACLD,EAAMF,EAAIJ,EAAK,CAACC,EAAKG,EAAG,CAAI,GAAM,EAAMG,EAAK,EACrD,CAKAT,EAAO,QAAUK,ICtFjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAa,QAAS,yCAA0C,EAAE,QAClEC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAM,QAAS,+BAAgC,EAC/CC,EAAO,QAAS,gCAAiC,EAmBrD,SAASC,EAASC,EAAQ,CACzB,IAAIC,EACAC,EACJ,GAAKP,EAAOK,CAAM,GAAKA,EAAQ,EAC9B,OAAOP,EAAkB,GAAI,EAE9B,GAAKO,IAAU,EACd,OAAON,EAAY,CAAI,EAExB,OAAAQ,EAAKL,EAAKG,EAAO,CAAI,EACrBC,EAAM,EAAMC,EACLC,EAaP,SAASA,EAAKC,EAAI,CACjB,OAAKT,EAAOS,CAAE,EACN,IAEHA,EAAI,GAAOA,IAAMN,EACd,EAEDG,EAAMG,EAAIR,EAAK,CAACC,EAAKO,EAAG,CAAI,GAAM,EAAMF,EAAK,CACrD,CACD,CAKAV,EAAO,QAAUO,IC1CjB,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", "exp", "pow", "PINF", "pdf", "x", "sigma", "s2i", "s2", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "degenerate", "isnan", "exp", "pow", "PINF", "factory", "sigma", "s2i", "s2", "pdf", "x", "setReadOnly", "main", "factory"]
|
|
7
|
+
}
|
package/docs/types/index.d.ts
CHANGED
package/lib/index.js
CHANGED
|
@@ -41,15 +41,15 @@
|
|
|
41
41
|
// MODULES //
|
|
42
42
|
|
|
43
43
|
var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
|
|
44
|
-
var
|
|
44
|
+
var main = require( './main.js' );
|
|
45
45
|
var factory = require( './factory.js' );
|
|
46
46
|
|
|
47
47
|
|
|
48
48
|
// MAIN //
|
|
49
49
|
|
|
50
|
-
setReadOnly(
|
|
50
|
+
setReadOnly( main, 'factory', factory );
|
|
51
51
|
|
|
52
52
|
|
|
53
53
|
// EXPORTS //
|
|
54
54
|
|
|
55
|
-
module.exports =
|
|
55
|
+
module.exports = main;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stdlib/stats-base-dists-rayleigh-pdf",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Rayleigh distribution probability density function (PDF).",
|
|
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-pinf": "^0.0
|
|
41
|
-
"@stdlib/math-base-assert-is-nan": "^0.0
|
|
42
|
-
"@stdlib/math-base-special-exp": "^0.0
|
|
43
|
-
"@stdlib/math-base-special-pow": "^0.0
|
|
44
|
-
"@stdlib/stats-base-dists-degenerate-pdf": "^0.0
|
|
45
|
-
"@stdlib/utils-constant-function": "^0.0
|
|
46
|
-
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.0
|
|
40
|
+
"@stdlib/constants-float64-pinf": "^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-pow": "^0.2.0",
|
|
44
|
+
"@stdlib/stats-base-dists-degenerate-pdf": "^0.2.0",
|
|
45
|
+
"@stdlib/utils-constant-function": "^0.2.0",
|
|
46
|
+
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0"
|
|
47
47
|
},
|
|
48
48
|
"devDependencies": {
|
|
49
|
-
"@stdlib/
|
|
50
|
-
"@stdlib/constants-float64-
|
|
51
|
-
"@stdlib/
|
|
52
|
-
"@stdlib/
|
|
53
|
-
"@stdlib/random-base-randu": "^0.0.x",
|
|
49
|
+
"@stdlib/constants-float64-eps": "^0.1.1",
|
|
50
|
+
"@stdlib/constants-float64-ninf": "^0.1.1",
|
|
51
|
+
"@stdlib/math-base-special-abs": "^0.1.1",
|
|
52
|
+
"@stdlib/random-base-randu": "^0.1.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",
|
|
@@ -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,73 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
{{alias}}( x, sigma )
|
|
3
|
-
Evaluates the probability density function (PDF) for a Rayleigh
|
|
4
|
-
distribution with scale parameter `sigma` at a value `x`.
|
|
5
|
-
|
|
6
|
-
If provided `NaN` as any argument, the function returns `NaN`.
|
|
7
|
-
|
|
8
|
-
If provided a negative value for `sigma`, the function returns `NaN`.
|
|
9
|
-
|
|
10
|
-
Parameters
|
|
11
|
-
----------
|
|
12
|
-
x: number
|
|
13
|
-
Input value.
|
|
14
|
-
|
|
15
|
-
sigma: number
|
|
16
|
-
Scale parameter.
|
|
17
|
-
|
|
18
|
-
Returns
|
|
19
|
-
-------
|
|
20
|
-
out: number
|
|
21
|
-
Evaluated PDF.
|
|
22
|
-
|
|
23
|
-
Examples
|
|
24
|
-
--------
|
|
25
|
-
> var y = {{alias}}( 0.3, 1.0 )
|
|
26
|
-
~0.287
|
|
27
|
-
> y = {{alias}}( 2.0, 0.8 )
|
|
28
|
-
~0.137
|
|
29
|
-
> y = {{alias}}( -1.0, 0.5 )
|
|
30
|
-
0.0
|
|
31
|
-
> y = {{alias}}( 0.0, NaN )
|
|
32
|
-
NaN
|
|
33
|
-
> y = {{alias}}( NaN, 2.0 )
|
|
34
|
-
NaN
|
|
35
|
-
|
|
36
|
-
// Negative scale parameter:
|
|
37
|
-
> y = {{alias}}( 2.0, -1.0 )
|
|
38
|
-
NaN
|
|
39
|
-
|
|
40
|
-
// Degenerate distribution when `sigma = 0.0`:
|
|
41
|
-
> y = {{alias}}( -2.0, 0.0 )
|
|
42
|
-
0.0
|
|
43
|
-
> y = {{alias}}( 0.0, 0.0 )
|
|
44
|
-
Infinity
|
|
45
|
-
> y = {{alias}}( 2.0, 0.0 )
|
|
46
|
-
0.0
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
{{alias}}.factory( sigma )
|
|
50
|
-
Returns a function for evaluating the probability density function (PDF) of
|
|
51
|
-
a Rayleigh distribution with scale parameter `sigma`.
|
|
52
|
-
|
|
53
|
-
Parameters
|
|
54
|
-
----------
|
|
55
|
-
sigma: number
|
|
56
|
-
Scale parameter.
|
|
57
|
-
|
|
58
|
-
Returns
|
|
59
|
-
-------
|
|
60
|
-
pdf: Function
|
|
61
|
-
Probability density function (PDF).
|
|
62
|
-
|
|
63
|
-
Examples
|
|
64
|
-
--------
|
|
65
|
-
> var myPDF = {{alias}}.factory( 4.0 );
|
|
66
|
-
> var y = myPDF( 6.0 )
|
|
67
|
-
~0.122
|
|
68
|
-
> y = myPDF( 4.0 )
|
|
69
|
-
~0.152
|
|
70
|
-
|
|
71
|
-
See Also
|
|
72
|
-
--------
|
|
73
|
-
|
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 pdf = require( './index' );
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
// TESTS //
|
|
23
|
-
|
|
24
|
-
// The function returns a number...
|
|
25
|
-
{
|
|
26
|
-
pdf( 2, 4 ); // $ExpectType number
|
|
27
|
-
pdf( 1, 2 ); // $ExpectType number
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
// The compiler throws an error if the function is provided values other than two numbers...
|
|
31
|
-
{
|
|
32
|
-
pdf( true, 3 ); // $ExpectError
|
|
33
|
-
pdf( false, 2 ); // $ExpectError
|
|
34
|
-
pdf( '5', 1 ); // $ExpectError
|
|
35
|
-
pdf( [], 1 ); // $ExpectError
|
|
36
|
-
pdf( {}, 4 ); // $ExpectError
|
|
37
|
-
pdf( ( x: number ): number => x, 2 ); // $ExpectError
|
|
38
|
-
|
|
39
|
-
pdf( 9, true ); // $ExpectError
|
|
40
|
-
pdf( 9, false ); // $ExpectError
|
|
41
|
-
pdf( 5, '5' ); // $ExpectError
|
|
42
|
-
pdf( 8, [] ); // $ExpectError
|
|
43
|
-
pdf( 9, {} ); // $ExpectError
|
|
44
|
-
pdf( 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
|
-
pdf(); // $ExpectError
|
|
50
|
-
pdf( 2 ); // $ExpectError
|
|
51
|
-
pdf( 2, 0, 4 ); // $ExpectError
|
|
52
|
-
}
|
|
53
|
-
|
|
54
|
-
// Attached to main export is a `factory` method which returns a function...
|
|
55
|
-
{
|
|
56
|
-
pdf.factory( 4 ); // $ExpectType Unary
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
// The `factory` method returns a function which returns a number...
|
|
60
|
-
{
|
|
61
|
-
const fcn = pdf.factory( 4 );
|
|
62
|
-
fcn( 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 = pdf.factory( 4 );
|
|
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 = pdf.factory( 4 );
|
|
79
|
-
fcn(); // $ExpectError
|
|
80
|
-
fcn( 2, 0 ); // $ExpectError
|
|
81
|
-
fcn( 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
|
-
pdf.factory( true ); // $ExpectError
|
|
87
|
-
pdf.factory( false ); // $ExpectError
|
|
88
|
-
pdf.factory( '5' ); // $ExpectError
|
|
89
|
-
pdf.factory( [] ); // $ExpectError
|
|
90
|
-
pdf.factory( {} ); // $ExpectError
|
|
91
|
-
pdf.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
|
-
pdf.factory( 0, 2 ); // $ExpectError
|
|
97
|
-
pdf.factory( 0, 4, 8 ); // $ExpectError
|
|
98
|
-
}
|
/package/lib/{pdf.js → main.js}
RENAMED
|
File without changes
|