@stdlib/stats-base-dists-normal-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 CHANGED
@@ -1 +1 @@
1
- Copyright (c) 2016-2022 The Stdlib Authors.
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] -->
@@ -184,7 +195,7 @@ See [LICENSE][stdlib-license].
184
195
 
185
196
  ## Copyright
186
197
 
187
- Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
198
+ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
188
199
 
189
200
  </section>
190
201
 
@@ -197,8 +208,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
197
208
  [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-normal-pdf.svg
198
209
  [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-normal-pdf
199
210
 
200
- [test-image]: https://github.com/stdlib-js/stats-base-dists-normal-pdf/actions/workflows/test.yml/badge.svg?branch=v0.0.7
201
- [test-url]: https://github.com/stdlib-js/stats-base-dists-normal-pdf/actions/workflows/test.yml?query=branch:v0.0.7
211
+ [test-image]: https://github.com/stdlib-js/stats-base-dists-normal-pdf/actions/workflows/test.yml/badge.svg?branch=v0.2.0
212
+ [test-url]: https://github.com/stdlib-js/stats-base-dists-normal-pdf/actions/workflows/test.yml?query=branch:v0.2.0
202
213
 
203
214
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-normal-pdf/main.svg
204
215
  [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-normal-pdf?branch=main
@@ -211,7 +222,7 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
211
222
  -->
212
223
 
213
224
  [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
214
- [chat-url]: https://gitter.im/stdlib-js/stdlib/
225
+ [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
215
226
 
216
227
  [stdlib]: https://github.com/stdlib-js/stdlib
217
228
 
@@ -221,8 +232,11 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
221
232
  [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
222
233
 
223
234
  [deno-url]: https://github.com/stdlib-js/stats-base-dists-normal-pdf/tree/deno
235
+ [deno-readme]: https://github.com/stdlib-js/stats-base-dists-normal-pdf/blob/deno/README.md
224
236
  [umd-url]: https://github.com/stdlib-js/stats-base-dists-normal-pdf/tree/umd
237
+ [umd-readme]: https://github.com/stdlib-js/stats-base-dists-normal-pdf/blob/umd/README.md
225
238
  [esm-url]: https://github.com/stdlib-js/stats-base-dists-normal-pdf/tree/esm
239
+ [esm-readme]: https://github.com/stdlib-js/stats-base-dists-normal-pdf/blob/esm/README.md
226
240
  [branches-url]: https://github.com/stdlib-js/stats-base-dists-normal-pdf/blob/main/branches.md
227
241
 
228
242
  [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-normal-pdf/main/LICENSE
package/SECURITY.md ADDED
@@ -0,0 +1,5 @@
1
+ # Security
2
+
3
+ > Policy for reporting security vulnerabilities.
4
+
5
+ See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).
@@ -0,0 +1,3 @@
1
+ /// <reference path="../docs/types/index.d.ts" />
2
+ import pdf from '../docs/types/index';
3
+ export = pdf;
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(h,c){
2
+ var I=require('@stdlib/math-base-special-exp/dist'),o=require('@stdlib/math-base-special-pow/dist'),O=require('@stdlib/math-base-special-sqrt/dist'),P=require('@stdlib/constants-float64-two-pi/dist'),w=require('@stdlib/constants-float64-pinf/dist'),n=require('@stdlib/math-base-assert-is-nan/dist');function x(e,r,t){var a,u,i;return n(e)||n(r)||n(t)||t<0?NaN:t===0?e===r?w:0:(a=o(t,2),u=1/O(a*P),i=-1/(2*a),u*I(i*o(e-r,2)))}c.exports=x
3
+ });var y=f(function(j,N){
4
+ var A=require('@stdlib/utils-constant-function/dist'),B=require('@stdlib/stats-base-dists-degenerate-pdf/dist').factory,v=require('@stdlib/math-base-assert-is-nan/dist'),F=require('@stdlib/math-base-special-sqrt/dist'),T=require('@stdlib/math-base-special-exp/dist'),p=require('@stdlib/math-base-special-pow/dist'),W=require('@stdlib/constants-float64-two-pi/dist');function _(e,r){var t,a,u;if(v(e)||v(r)||r<0)return A(NaN);if(r===0)return B(e);return t=p(r,2),a=1/F(t*W),u=-1/(2*t),i;function i(q){return v(q)?NaN:a*T(u*p(q-e,2))}}N.exports=_
5
+ });var l=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),d=s(),R=y();l(d,"factory",R);module.exports=d;
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 exp = require( '@stdlib/math-base-special-exp' );\nvar pow = require( '@stdlib/math-base-special-pow' );\nvar sqrt = require( '@stdlib/math-base-special-sqrt' );\nvar TWO_PI = require( '@stdlib/constants-float64-two-pi' );\nvar PINF = require( '@stdlib/constants-float64-pinf' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\n\n\n// MAIN //\n\n/**\n* Evaluates the probability density function (PDF) for a normal distribution with mean `mu` and standard deviation `sigma` at a value `x`.\n*\n* @param {number} x - input value\n* @param {number} mu - mean\n* @param {NonNegativeNumber} sigma - standard deviation\n* @returns {number} evaluated probability density function\n*\n* @example\n* var y = pdf( 2.0, 0.0, 1.0 );\n* // returns ~0.054\n*\n* @example\n* var y = pdf( -1.0, 4.0, 2.0 );\n* // returns ~0.009\n*\n* @example\n* var y = pdf( NaN, 0.0, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = pdf( 0.0, NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = pdf( 0.0, 0.0, NaN );\n* // returns NaN\n*\n* @example\n* // Negative standard deviation:\n* var y = pdf( 2.0, 0.0, -1.0 );\n* // returns NaN\n*\n* @example\n* var y = pdf( 2.0, 8.0, 0.0 );\n* // returns 0.0\n*\n* @example\n* var y = pdf( 8.0, 8.0, 0.0 );\n* // returns Infinity\n*/\nfunction pdf( x, mu, sigma ) {\n\tvar s2;\n\tvar A;\n\tvar B;\n\tif (\n\t\tisnan( x ) ||\n\t\tisnan( mu ) ||\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 === mu ) ? PINF : 0.0;\n\t}\n\ts2 = pow( sigma, 2.0 );\n\tA = 1.0 / sqrt( s2*TWO_PI );\n\tB = -1.0 / ( 2.0*s2 );\n\treturn A * exp( B * pow(x-mu, 2.0) );\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 sqrt = require( '@stdlib/math-base-special-sqrt' );\nvar exp = require( '@stdlib/math-base-special-exp' );\nvar pow = require( '@stdlib/math-base-special-pow' );\nvar TWO_PI = require( '@stdlib/constants-float64-two-pi' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the probability density function (PDF) for a normal distribution.\n*\n* @param {number} mu - mean\n* @param {NonNegativeNumber} sigma - standard deviation\n* @returns {Function} function to evaluate the probability density function\n*\n* @example\n* var pdf = factory( 10.0, 2.0 );\n* var y = pdf( 10.0 );\n* // returns ~0.199\n*\n* y = pdf( 5.0 );\n* // returns ~0.009\n*/\nfunction factory( mu, sigma ) {\n\tvar s2;\n\tvar A;\n\tvar B;\n\tif (\n\t\tisnan( mu ) ||\n\t\tisnan( sigma ) ||\n\t\tsigma < 0.0\n\t) {\n\t\treturn constantFunction( NaN );\n\t}\n\tif ( sigma === 0.0 ) {\n\t\treturn degenerate( mu );\n\t}\n\ts2 = pow( sigma, 2.0 );\n\tA = 1.0 / sqrt( s2*TWO_PI );\n\tB = -1.0 / ( 2.0*s2 );\n\treturn pdf;\n\n\t/**\n\t* Evaluates the probability density function (PDF) for a normal distribution.\n\t*\n\t* @private\n\t* @param {number} x - input value\n\t* @returns {number} evaluated probability density function\n\t*\n\t* @example\n\t* var y = pdf( -3.14 );\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\treturn A * exp( B * pow(x-mu, 2.0) );\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Normal distribution probability density function (PDF).\n*\n* @module @stdlib/stats-base-dists-normal-pdf\n*\n* @example\n* var pdf = require( '@stdlib/stats-base-dists-normal-pdf' );\n*\n* var y = pdf( 2.0, 0.0, 1.0 );\n* // returns ~0.054\n*\n* var myPDF = pdf.factory( 10.0, 2.0 );\n* y = myPDF( 10.0 );\n* // returns ~0.199\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,EAAM,QAAS,+BAAgC,EAC/CC,EAAM,QAAS,+BAAgC,EAC/CC,EAAO,QAAS,gCAAiC,EACjDC,EAAS,QAAS,kCAAmC,EACrDC,EAAO,QAAS,gCAAiC,EACjDC,EAAQ,QAAS,iCAAkC,EA8CvD,SAASC,EAAKC,EAAGC,EAAIC,EAAQ,CAC5B,IAAIC,EACAC,EACAC,EACJ,OACCP,EAAOE,CAAE,GACTF,EAAOG,CAAG,GACVH,EAAOI,CAAM,GACbA,EAAQ,EAED,IAEHA,IAAU,EACLF,IAAMC,EAAOJ,EAAO,GAE9BM,EAAKT,EAAKQ,EAAO,CAAI,EACrBE,EAAI,EAAMT,EAAMQ,EAAGP,CAAO,EAC1BS,EAAI,IAAS,EAAIF,GACVC,EAAIX,EAAKY,EAAIX,EAAIM,EAAEC,EAAI,CAAG,CAAE,EACpC,CAKAT,EAAO,QAAUO,ICjGjB,IAAAO,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAa,QAAS,yCAA0C,EAAE,QAClEC,EAAQ,QAAS,iCAAkC,EACnDC,EAAO,QAAS,gCAAiC,EACjDC,EAAM,QAAS,+BAAgC,EAC/CC,EAAM,QAAS,+BAAgC,EAC/CC,EAAS,QAAS,kCAAmC,EAoBzD,SAASC,EAASC,EAAIC,EAAQ,CAC7B,IAAIC,EACAC,EACAC,EACJ,GACCV,EAAOM,CAAG,GACVN,EAAOO,CAAM,GACbA,EAAQ,EAER,OAAOT,EAAkB,GAAI,EAE9B,GAAKS,IAAU,EACd,OAAOR,EAAYO,CAAG,EAEvB,OAAAE,EAAKL,EAAKI,EAAO,CAAI,EACrBE,EAAI,EAAMR,EAAMO,EAAGJ,CAAO,EAC1BM,EAAI,IAAS,EAAIF,GACVG,EAaP,SAASA,EAAKC,EAAI,CACjB,OAAKZ,EAAOY,CAAE,EACN,IAEDH,EAAIP,EAAKQ,EAAIP,EAAIS,EAAEN,EAAI,CAAG,CAAE,CACpC,CACD,CAKAT,EAAO,QAAUQ,ICnDjB,IAAIQ,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
6
+ "names": ["require_main", "__commonJSMin", "exports", "module", "exp", "pow", "sqrt", "TWO_PI", "PINF", "isnan", "pdf", "x", "mu", "sigma", "s2", "A", "B", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "degenerate", "isnan", "sqrt", "exp", "pow", "TWO_PI", "factory", "mu", "sigma", "s2", "A", "B", "pdf", "x", "setReadOnly", "main", "factory"]
7
+ }
@@ -16,7 +16,7 @@
16
16
  * limitations under the License.
17
17
  */
18
18
 
19
- // TypeScript Version: 2.0
19
+ // TypeScript Version: 4.1
20
20
 
21
21
  /**
22
22
  * Evaluates the probability density function (PDF) for a normal distribution.
package/lib/index.js CHANGED
@@ -37,15 +37,15 @@
37
37
  // MODULES //
38
38
 
39
39
  var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
40
- var pdf = require( './pdf.js' );
40
+ var main = require( './main.js' );
41
41
  var factory = require( './factory.js' );
42
42
 
43
43
 
44
44
  // MAIN //
45
45
 
46
- setReadOnly( pdf, 'factory', factory );
46
+ setReadOnly( main, 'factory', factory );
47
47
 
48
48
 
49
49
  // EXPORTS //
50
50
 
51
- module.exports = pdf;
51
+ module.exports = main;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/stats-base-dists-normal-pdf",
3
- "version": "0.0.7",
3
+ "version": "0.2.0",
4
4
  "description": "Normal distribution probability density function (PDF).",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -37,25 +37,26 @@
37
37
  "url": "https://github.com/stdlib-js/stdlib/issues"
38
38
  },
39
39
  "dependencies": {
40
- "@stdlib/constants-float64-pinf": "^0.0.x",
41
- "@stdlib/constants-float64-two-pi": "^0.0.x",
42
- "@stdlib/math-base-assert-is-nan": "^0.0.x",
43
- "@stdlib/math-base-special-exp": "^0.0.x",
44
- "@stdlib/math-base-special-pow": "^0.0.x",
45
- "@stdlib/math-base-special-sqrt": "^0.0.x",
46
- "@stdlib/stats-base-dists-degenerate-pdf": "^0.0.x",
47
- "@stdlib/utils-constant-function": "^0.0.x",
48
- "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
40
+ "@stdlib/constants-float64-pinf": "^0.2.0",
41
+ "@stdlib/constants-float64-two-pi": "^0.2.0",
42
+ "@stdlib/math-base-assert-is-nan": "^0.2.0",
43
+ "@stdlib/math-base-special-exp": "^0.2.0",
44
+ "@stdlib/math-base-special-pow": "^0.2.0",
45
+ "@stdlib/math-base-special-sqrt": "^0.2.0",
46
+ "@stdlib/stats-base-dists-degenerate-pdf": "^0.2.0",
47
+ "@stdlib/utils-constant-function": "^0.2.0",
48
+ "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0"
49
49
  },
50
50
  "devDependencies": {
51
- "@stdlib/bench": "^0.0.x",
52
- "@stdlib/constants-float64-eps": "^0.0.x",
53
- "@stdlib/constants-float64-ninf": "^0.0.x",
54
- "@stdlib/math-base-special-abs": "^0.0.x",
55
- "@stdlib/random-base-randu": "^0.0.x",
51
+ "@stdlib/constants-float64-eps": "^0.1.1",
52
+ "@stdlib/constants-float64-ninf": "^0.1.1",
53
+ "@stdlib/math-base-special-abs": "^0.1.1",
54
+ "@stdlib/random-base-randu": "^0.1.0",
56
55
  "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
57
56
  "istanbul": "^0.4.1",
58
- "tap-spec": "5.x.x"
57
+ "tap-min": "git+https://github.com/Planeshifter/tap-min.git",
58
+ "@stdlib/bench-harness": "^0.2.0",
59
+ "@stdlib/bench": "^0.3.1"
59
60
  },
60
61
  "engines": {
61
62
  "node": ">=0.10.0",
@@ -88,7 +89,7 @@
88
89
  "univariate"
89
90
  ],
90
91
  "funding": {
91
- "type": "patreon",
92
- "url": "https://www.patreon.com/athan"
92
+ "type": "opencollective",
93
+ "url": "https://opencollective.com/stdlib"
93
94
  }
94
95
  }
package/docs/repl.txt DELETED
@@ -1,75 +0,0 @@
1
-
2
- {{alias}}( x, μ, σ )
3
- Evaluates the probability density function (PDF) for a normal distribution
4
- with mean `μ` and standard deviation `σ` at a value `x`.
5
-
6
- If provided `NaN` as any argument, the function returns `NaN`.
7
-
8
- If provided `σ < 0`, the function returns `NaN`.
9
-
10
- Parameters
11
- ----------
12
- x: number
13
- Input value.
14
-
15
- μ: number
16
- Location parameter.
17
-
18
- σ: number
19
- Standard deviation.
20
-
21
- Returns
22
- -------
23
- out: number
24
- Evaluated PDF.
25
-
26
- Examples
27
- --------
28
- > var y = {{alias}}( 2.0, 0.0, 1.0 )
29
- ~0.054
30
- > y = {{alias}}( -1.0, 4.0, 2.0 )
31
- ~0.009
32
- > y = {{alias}}( NaN, 0.0, 1.0 )
33
- NaN
34
- > y = {{alias}}( 0.0, NaN, 1.0 )
35
- NaN
36
- > y = {{alias}}( 0.0, 0.0, NaN )
37
- NaN
38
-
39
- // Negative standard deviation:
40
- > y = {{alias}}( 2.0, 0.0, -1.0 )
41
- NaN
42
-
43
- // Degenerate distribution centered at `μ` when `σ = 0.0`:
44
- > y = {{alias}}( 2.0, 8.0, 0.0 )
45
- 0.0
46
- > y = {{alias}}( 8.0, 8.0, 0.0 )
47
- infinity
48
-
49
-
50
- {{alias}}.factory( μ, σ )
51
- Returns a function for evaluating the probability density function (PDF) of
52
- a normal distribution with mean `μ` and standard deviation `σ`.
53
-
54
- Parameters
55
- ----------
56
- μ: number
57
- Location parameter.
58
-
59
- σ: number
60
- Standard deviation.
61
-
62
- Returns
63
- -------
64
- pdf: Function
65
- Probability density function (PDF).
66
-
67
- Examples
68
- --------
69
- > var myPDF = {{alias}}.factory( 10.0, 2.0 );
70
- > var y = myPDF( 10.0 )
71
- ~0.199
72
-
73
- See Also
74
- --------
75
-
@@ -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 pdf = require( './index' );
20
-
21
-
22
- // TESTS //
23
-
24
- // The function returns a number...
25
- {
26
- pdf( 2, 2, 4 ); // $ExpectType number
27
- pdf( 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
- pdf( true, 3, 6 ); // $ExpectError
33
- pdf( false, 2, 4 ); // $ExpectError
34
- pdf( '5', 1, 2 ); // $ExpectError
35
- pdf( [], 1, 2 ); // $ExpectError
36
- pdf( {}, 2, 4 ); // $ExpectError
37
- pdf( ( x: number ): number => x, 2, 4 ); // $ExpectError
38
-
39
- pdf( 9, true, 12 ); // $ExpectError
40
- pdf( 9, false, 12 ); // $ExpectError
41
- pdf( 5, '5', 10 ); // $ExpectError
42
- pdf( 8, [], 16 ); // $ExpectError
43
- pdf( 9, {}, 18 ); // $ExpectError
44
- pdf( 8, ( x: number ): number => x, 16 ); // $ExpectError
45
-
46
- pdf( 9, 5, true ); // $ExpectError
47
- pdf( 9, 5, false ); // $ExpectError
48
- pdf( 5, 2, '5' ); // $ExpectError
49
- pdf( 8, 4, [] ); // $ExpectError
50
- pdf( 9, 4, {} ); // $ExpectError
51
- pdf( 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
- pdf(); // $ExpectError
57
- pdf( 2 ); // $ExpectError
58
- pdf( 2, 0 ); // $ExpectError
59
- pdf( 2, 0, 4, 1 ); // $ExpectError
60
- }
61
-
62
- // Attached to main export is a `factory` method which returns a function...
63
- {
64
- pdf.factory( 3, 4 ); // $ExpectType Unary
65
- }
66
-
67
- // The `factory` method returns a function which returns a number...
68
- {
69
- const fcn = pdf.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 = pdf.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 = pdf.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
- pdf.factory( true, 3 ); // $ExpectError
95
- pdf.factory( false, 2 ); // $ExpectError
96
- pdf.factory( '5', 1 ); // $ExpectError
97
- pdf.factory( [], 1 ); // $ExpectError
98
- pdf.factory( {}, 2 ); // $ExpectError
99
- pdf.factory( ( x: number ): number => x, 2 ); // $ExpectError
100
-
101
- pdf.factory( 9, true ); // $ExpectError
102
- pdf.factory( 9, false ); // $ExpectError
103
- pdf.factory( 5, '5' ); // $ExpectError
104
- pdf.factory( 8, [] ); // $ExpectError
105
- pdf.factory( 9, {} ); // $ExpectError
106
- pdf.factory( 8, ( x: number ): number => x ); // $ExpectError
107
-
108
- pdf.factory( [], true ); // $ExpectError
109
- pdf.factory( {}, false ); // $ExpectError
110
- pdf.factory( false, '5' ); // $ExpectError
111
- pdf.factory( {}, [] ); // $ExpectError
112
- pdf.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
- pdf.factory( 0 ); // $ExpectError
118
- pdf.factory( 0, 4, 8 ); // $ExpectError
119
- }
File without changes