@stdlib/stats-base-dists-chi-logpdf 0.0.7 → 0.1.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/CITATION.cff ADDED
@@ -0,0 +1,30 @@
1
+ cff-version: 1.2.0
2
+ title: stdlib
3
+ message: >-
4
+ If you use this software, please cite it using the
5
+ metadata from this file.
6
+
7
+ type: software
8
+
9
+ authors:
10
+ - name: The Stdlib Authors
11
+ url: https://github.com/stdlib-js/stdlib/graphs/contributors
12
+
13
+ repository-code: https://github.com/stdlib-js/stdlib
14
+ url: https://stdlib.io
15
+
16
+ abstract: |
17
+ Standard library for JavaScript and Node.js.
18
+
19
+ keywords:
20
+ - JavaScript
21
+ - Node.js
22
+ - TypeScript
23
+ - standard library
24
+ - scientific computing
25
+ - numerical computing
26
+ - statistical computing
27
+
28
+ license: Apache-2.0 AND BSL-1.0
29
+
30
+ date-released: 2016
package/NOTICE CHANGED
@@ -1 +1 @@
1
- Copyright (c) 2016-2022 The Stdlib Authors.
1
+ Copyright (c) 2016-2023 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] -->
@@ -182,7 +193,7 @@ See [LICENSE][stdlib-license].
182
193
 
183
194
  ## Copyright
184
195
 
185
- Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
196
+ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
186
197
 
187
198
  </section>
188
199
 
@@ -195,8 +206,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
195
206
  [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-chi-logpdf.svg
196
207
  [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-chi-logpdf
197
208
 
198
- [test-image]: https://github.com/stdlib-js/stats-base-dists-chi-logpdf/actions/workflows/test.yml/badge.svg?branch=v0.0.7
199
- [test-url]: https://github.com/stdlib-js/stats-base-dists-chi-logpdf/actions/workflows/test.yml?query=branch:v0.0.7
209
+ [test-image]: https://github.com/stdlib-js/stats-base-dists-chi-logpdf/actions/workflows/test.yml/badge.svg?branch=v0.1.0
210
+ [test-url]: https://github.com/stdlib-js/stats-base-dists-chi-logpdf/actions/workflows/test.yml?query=branch:v0.1.0
200
211
 
201
212
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-chi-logpdf/main.svg
202
213
  [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-chi-logpdf?branch=main
@@ -209,7 +220,7 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
209
220
  -->
210
221
 
211
222
  [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
212
- [chat-url]: https://gitter.im/stdlib-js/stdlib/
223
+ [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
213
224
 
214
225
  [stdlib]: https://github.com/stdlib-js/stdlib
215
226
 
@@ -0,0 +1,3 @@
1
+ /// <reference path="../docs/types/index.d.ts" />
2
+ import logPDF from '../docs/types/index';
3
+ export = logPDF;
package/dist/index.js ADDED
@@ -0,0 +1,7 @@
1
+ "use strict";var n=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var N=n(function(A,o){
2
+ var v=require('@stdlib/math-base-assert-is-nan/dist'),g=require('@stdlib/math-base-special-gammaln/dist'),p=require('@stdlib/math-base-special-ln/dist'),q=require('@stdlib/constants-float64-ninf/dist'),f=require('@stdlib/constants-float64-pinf/dist'),y=require('@stdlib/constants-float64-ln-two/dist');function F(r,e){var a,i;return v(r)||v(e)||e<0?NaN:e===0?r===0?f:q:r<0||r===f?q:(i=e/2,a=(1-i)*y+(e-1)*p(r)-r*r/2,a-=g(i),a)}o.exports=F
3
+ });var l=n(function(B,c){
4
+ var d=require('@stdlib/utils-constant-function/dist'),I=require('@stdlib/stats-base-dists-degenerate-logpdf/dist').factory,s=require('@stdlib/math-base-assert-is-nan/dist'),h=require('@stdlib/math-base-special-gammaln/dist'),L=require('@stdlib/math-base-special-ln/dist'),P=require('@stdlib/constants-float64-ninf/dist'),O=require('@stdlib/constants-float64-pinf/dist'),R=require('@stdlib/constants-float64-ln-two/dist');function b(r){var e,a;if(s(r)||r<0)return d(NaN);if(r===0)return I(0);return a=r/2,e=r-1,i;function i(u){var t;return s(u)?NaN:u<0||u===O?P:(t=(1-a)*R+e*L(u)-u*u/2,t-=h(a),t)}}c.exports=b
5
+ });var j=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),m=N(),w=l();j(m,"factory",w);module.exports=m;
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 gammaln = require( '@stdlib/math-base-special-gammaln' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\nvar PINF = require( '@stdlib/constants-float64-pinf' );\nvar LN2 = require( '@stdlib/constants-float64-ln-two' );\n\n\n// MAIN //\n\n/**\n* Evaluates the natural logarithm of the probability density function (PDF) for a chi distribution with degrees of freedom `k` at a value `x`.\n*\n* @param {number} x - input value\n* @param {NonNegativeNumber} k - degrees of freedom\n* @returns {number} evaluated logPDF\n*\n* @example\n* var y = logpdf( 0.3, 4.0 );\n* // returns ~-4.35\n*\n* @example\n* var y = logpdf( 0.7, 0.7 );\n* // returns ~-0.622\n*\n* @example\n* var y = logpdf( -1.0, 0.5 );\n* // returns -Infinity\n*\n* @example\n* var y = logpdf( 0.0, NaN );\n* // returns NaN\n*\n* @example\n* var y = logpdf( NaN, 2.0 );\n* // returns NaN\n*\n* @example\n* // Negative degrees of freedom:\n* var y = logpdf( 2.0, -1.0 );\n* // returns NaN\n*/\nfunction logpdf( x, k ) {\n\tvar out;\n\tvar kh;\n\tif (\n\t\tisnan( x ) ||\n\t\tisnan( k ) ||\n\t\tk < 0.0\n\t) {\n\t\treturn NaN;\n\t}\n\tif ( k === 0.0 ) {\n\t\t// Point mass at 0...\n\t\treturn ( x === 0.0 ) ? PINF : NINF;\n\t}\n\tif ( x < 0.0 || x === PINF ) {\n\t\treturn NINF;\n\t}\n\tkh = k / 2.0;\n\tout = ( ( 1.0-kh ) * LN2 ) + ( ( k-1.0 ) * ln( x ) ) - ( (x*x) / 2.0 );\n\tout -= gammaln( kh );\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 degenerate = require( '@stdlib/stats-base-dists-degenerate-logpdf' ).factory;\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar gammaln = require( '@stdlib/math-base-special-gammaln' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\nvar PINF = require( '@stdlib/constants-float64-pinf' );\nvar LN2 = require( '@stdlib/constants-float64-ln-two' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the natural logarithm of the probability density function (PDF) for a chi distribution with degrees of freedom `k`.\n*\n* @param {NonNegativeNumber} k - degrees of freedom\n* @returns {Function} logPDF\n*\n* @example\n* var logpdf = factory( 0.5 );\n*\n* var y = logpdf( 2.0 );\n* // returns ~-3.115\n*\n* y = logpdf( 1.0 );\n* // returns ~-1.268\n*/\nfunction factory( k ) {\n\tvar km1;\n\tvar kh;\n\n\tif ( isnan( k ) || k < 0.0 ) {\n\t\treturn constantFunction( NaN );\n\t}\n\tif ( k === 0.0 ) {\n\t\treturn degenerate( 0.0 );\n\t}\n\n\tkh = k / 2.0;\n\tkm1 = k - 1.0;\n\treturn logpdf;\n\n\t/**\n\t* Evaluates the natural logarithm of the probability density function (PDF) for a chi distribution with degrees of freedom `k`.\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( 1.0 );\n\t* // returns <number>\n\t*/\n\tfunction logpdf( x ) {\n\t\tvar out;\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 NINF;\n\t\t}\n\t\tout = ( ( 1.0-kh ) * LN2 ) + ( km1 * ln( x ) ) - ( (x*x) / 2.0 );\n\t\tout -= gammaln( kh );\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* Natural logarithm of the probability density function (PDF) for a chi distribution.\n*\n* @module @stdlib/stats-base-dists-chi-logpdf\n*\n* @example\n* var logpdf = require( '@stdlib/stats-base-dists-chi-logpdf' );\n*\n* var y = logpdf( 2.0, 1.0 );\n* // returns ~-2.226\n*\n* @example\n* var factory = require( '@stdlib/stats-base-dists-chi-logpdf' ).factory;\n*\n* var logpdf = factory( 6.0 );\n*\n* var y = logpdf( 3.0 );\n* // returns ~-1.088\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,EAAU,QAAS,mCAAoC,EACvDC,EAAK,QAAS,8BAA+B,EAC7CC,EAAO,QAAS,gCAAiC,EACjDC,EAAO,QAAS,gCAAiC,EACjDC,EAAM,QAAS,kCAAmC,EAqCtD,SAASC,EAAQC,EAAGC,EAAI,CACvB,IAAIC,EACAC,EACJ,OACCV,EAAOO,CAAE,GACTP,EAAOQ,CAAE,GACTA,EAAI,EAEG,IAEHA,IAAM,EAEDD,IAAM,EAAQH,EAAOD,EAE1BI,EAAI,GAAOA,IAAMH,EACdD,GAERO,EAAKF,EAAI,EACTC,GAAU,EAAIC,GAAOL,GAAYG,EAAE,GAAQN,EAAIK,CAAE,EAASA,EAAEA,EAAK,EACjEE,GAAOR,EAASS,CAAG,EACZD,EACR,CAKAV,EAAO,QAAUO,IC1FjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAa,QAAS,4CAA6C,EAAE,QACrEC,EAAQ,QAAS,iCAAkC,EACnDC,EAAU,QAAS,mCAAoC,EACvDC,EAAK,QAAS,8BAA+B,EAC7CC,EAAO,QAAS,gCAAiC,EACjDC,EAAO,QAAS,gCAAiC,EACjDC,EAAM,QAAS,kCAAmC,EAoBtD,SAASC,EAASC,EAAI,CACrB,IAAIC,EACAC,EAEJ,GAAKT,EAAOO,CAAE,GAAKA,EAAI,EACtB,OAAOT,EAAkB,GAAI,EAE9B,GAAKS,IAAM,EACV,OAAOR,EAAY,CAAI,EAGxB,OAAAU,EAAKF,EAAI,EACTC,EAAMD,EAAI,EACHG,EAaP,SAASA,EAAQC,EAAI,CACpB,IAAIC,EACJ,OAAKZ,EAAOW,CAAE,EACN,IAEHA,EAAI,GAAOA,IAAMP,EACdD,GAERS,GAAU,EAAIH,GAAOJ,EAAUG,EAAMN,EAAIS,CAAE,EAASA,EAAEA,EAAK,EAC3DC,GAAOX,EAASQ,CAAG,EACZG,EACR,CACD,CAKAf,EAAO,QAAUS,IClDjB,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", "gammaln", "ln", "NINF", "PINF", "LN2", "logpdf", "x", "k", "out", "kh", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "degenerate", "isnan", "gammaln", "ln", "NINF", "PINF", "LN2", "factory", "k", "km1", "kh", "logpdf", "x", "out", "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 natural logarithm of the probability density function (logPDF) for a chi distribution.
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 logpdf = require( './logpdf.js' );
44
+ var main = require( './main.js' );
45
45
  var factory = require( './factory.js' );
46
46
 
47
47
 
48
48
  // MAIN //
49
49
 
50
- setReadOnly( logpdf, 'factory', factory );
50
+ setReadOnly( main, 'factory', factory );
51
51
 
52
52
 
53
53
  // EXPORTS //
54
54
 
55
- module.exports = logpdf;
55
+ module.exports = main;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/stats-base-dists-chi-logpdf",
3
- "version": "0.0.7",
3
+ "version": "0.1.0",
4
4
  "description": "Natural logarithm of the probability density function (PDF) for a chi distribution.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -37,25 +37,25 @@
37
37
  "url": "https://github.com/stdlib-js/stdlib/issues"
38
38
  },
39
39
  "dependencies": {
40
- "@stdlib/constants-float64-ln-two": "^0.0.x",
41
- "@stdlib/constants-float64-ninf": "^0.0.x",
42
- "@stdlib/constants-float64-pinf": "^0.0.x",
43
- "@stdlib/math-base-assert-is-nan": "^0.0.x",
44
- "@stdlib/math-base-special-gammaln": "^0.0.x",
45
- "@stdlib/math-base-special-ln": "^0.0.x",
46
- "@stdlib/stats-base-dists-degenerate-logpdf": "^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-ln-two": "^0.1.0",
41
+ "@stdlib/constants-float64-ninf": "^0.1.0",
42
+ "@stdlib/constants-float64-pinf": "^0.1.0",
43
+ "@stdlib/math-base-assert-is-nan": "^0.1.0",
44
+ "@stdlib/math-base-special-gammaln": "^0.1.0",
45
+ "@stdlib/math-base-special-ln": "^0.1.0",
46
+ "@stdlib/stats-base-dists-degenerate-logpdf": "^0.1.0",
47
+ "@stdlib/utils-constant-function": "^0.1.0",
48
+ "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0"
49
49
  },
50
50
  "devDependencies": {
51
- "@stdlib/bench": "^0.0.x",
52
- "@stdlib/constants-float64-eps": "^0.0.x",
53
- "@stdlib/math-base-special-abs": "^0.0.x",
54
- "@stdlib/math-base-special-ceil": "^0.0.x",
55
- "@stdlib/random-base-randu": "^0.0.x",
51
+ "@stdlib/bench": "^0.1.0",
52
+ "@stdlib/constants-float64-eps": "^0.1.0",
53
+ "@stdlib/math-base-special-abs": "^0.1.0",
54
+ "@stdlib/math-base-special-ceil": "^0.1.0",
55
+ "@stdlib/random-base-randu": "^0.0.8",
56
56
  "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
57
57
  "istanbul": "^0.4.1",
58
- "tap-spec": "5.x.x"
58
+ "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
59
59
  },
60
60
  "engines": {
61
61
  "node": ">=0.10.0",
@@ -92,7 +92,7 @@
92
92
  "continuous"
93
93
  ],
94
94
  "funding": {
95
- "type": "patreon",
96
- "url": "https://www.patreon.com/athan"
95
+ "type": "opencollective",
96
+ "url": "https://opencollective.com/stdlib"
97
97
  }
98
98
  }
package/docs/repl.txt DELETED
@@ -1,69 +0,0 @@
1
-
2
- {{alias}}( x, k )
3
- Evaluates the natural logarithm of the probability density function (PDF)
4
- for a chi distribution with degrees of freedom `k` at a value `x`.
5
-
6
- If provided `NaN` as any argument, the function returns `NaN`.
7
-
8
- If provided `k < 0`, the function returns `NaN`.
9
-
10
- Parameters
11
- ----------
12
- x: number
13
- Input value.
14
-
15
- k: number
16
- Degrees of freedom.
17
-
18
- Returns
19
- -------
20
- out: number
21
- Evaluated logPDF.
22
-
23
- Examples
24
- --------
25
- > var y = {{alias}}( 0.3, 4.0 )
26
- ~-4.35
27
- > y = {{alias}}( 0.7, 0.7 )
28
- ~-0.622
29
- > y = {{alias}}( -1.0, 0.5 )
30
- -Infinity
31
- > y = {{alias}}( 0.0, NaN )
32
- NaN
33
- > y = {{alias}}( NaN, 2.0 )
34
- NaN
35
-
36
- // Negative degrees of freedom:
37
- > y = {{alias}}( 2.0, -1.0 )
38
- NaN
39
-
40
- // Degenerate distribution when `k = 0`:
41
- > y = {{alias}}( 2.0, 0.0, 2.0 )
42
- -Infinity
43
- > y = {{alias}}( 0.0, 0.0, 2.0 )
44
- Infinity
45
-
46
-
47
- {{alias}}.factory( k )
48
- Returns a function for evaluating the natural logarithm of the probability
49
- density function (PDF) of a chi distribution with degrees of freedom `k`.
50
-
51
- Parameters
52
- ----------
53
- k: number
54
- Degrees of freedom.
55
-
56
- Returns
57
- -------
58
- logpdf: Function
59
- Logarithm of probability density function (PDF).
60
-
61
- Examples
62
- --------
63
- > var mylogPDF = {{alias}}.factory( 6.0 );
64
- > var y = mylogPDF( 3.0 )
65
- ~-1.086
66
-
67
- See Also
68
- --------
69
-
@@ -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 logpdf = require( './index' );
20
-
21
-
22
- // TESTS //
23
-
24
- // The function returns a number...
25
- {
26
- logpdf( 2, 4 ); // $ExpectType number
27
- logpdf( 1, 2 ); // $ExpectType number
28
- }
29
-
30
- // The compiler throws an error if the function is provided values other than two numbers...
31
- {
32
- logpdf( true, 3 ); // $ExpectError
33
- logpdf( false, 2 ); // $ExpectError
34
- logpdf( '5', 1 ); // $ExpectError
35
- logpdf( [], 1 ); // $ExpectError
36
- logpdf( {}, 4 ); // $ExpectError
37
- logpdf( ( x: number ): number => x, 2 ); // $ExpectError
38
-
39
- logpdf( 9, true ); // $ExpectError
40
- logpdf( 9, false ); // $ExpectError
41
- logpdf( 5, '5' ); // $ExpectError
42
- logpdf( 8, [] ); // $ExpectError
43
- logpdf( 9, {} ); // $ExpectError
44
- logpdf( 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
- logpdf(); // $ExpectError
50
- logpdf( 2 ); // $ExpectError
51
- logpdf( 2, 0, 4 ); // $ExpectError
52
- }
53
-
54
- // Attached to main export is a `factory` method which returns a function...
55
- {
56
- logpdf.factory( 4 ); // $ExpectType Unary
57
- }
58
-
59
- // The `factory` method returns a function which returns a number...
60
- {
61
- const fcn = logpdf.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 = logpdf.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 = logpdf.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
- logpdf.factory( true ); // $ExpectError
87
- logpdf.factory( false ); // $ExpectError
88
- logpdf.factory( '5' ); // $ExpectError
89
- logpdf.factory( [] ); // $ExpectError
90
- logpdf.factory( {} ); // $ExpectError
91
- logpdf.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
- logpdf.factory( 0, 2 ); // $ExpectError
97
- logpdf.factory( 0, 4, 8 ); // $ExpectError
98
- }
File without changes