@stdlib/stats-base-dists-gamma-mgf 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
  # Moment-Generating 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 &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
230
+ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
220
231
 
221
232
  </section>
222
233
 
@@ -229,8 +240,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
229
240
  [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-gamma-mgf.svg
230
241
  [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-gamma-mgf
231
242
 
232
- [test-image]: https://github.com/stdlib-js/stats-base-dists-gamma-mgf/actions/workflows/test.yml/badge.svg?branch=v0.0.7
233
- [test-url]: https://github.com/stdlib-js/stats-base-dists-gamma-mgf/actions/workflows/test.yml?query=branch:v0.0.7
243
+ [test-image]: https://github.com/stdlib-js/stats-base-dists-gamma-mgf/actions/workflows/test.yml/badge.svg?branch=v0.2.0
244
+ [test-url]: https://github.com/stdlib-js/stats-base-dists-gamma-mgf/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-gamma-mgf/main.svg
236
247
  [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-gamma-mgf?branch=main
@@ -243,7 +254,7 @@ Copyright &copy; 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/stdlib-js/stdlib/
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 &copy; 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-gamma-mgf/tree/deno
267
+ [deno-readme]: https://github.com/stdlib-js/stats-base-dists-gamma-mgf/blob/deno/README.md
256
268
  [umd-url]: https://github.com/stdlib-js/stats-base-dists-gamma-mgf/tree/umd
269
+ [umd-readme]: https://github.com/stdlib-js/stats-base-dists-gamma-mgf/blob/umd/README.md
257
270
  [esm-url]: https://github.com/stdlib-js/stats-base-dists-gamma-mgf/tree/esm
271
+ [esm-readme]: https://github.com/stdlib-js/stats-base-dists-gamma-mgf/blob/esm/README.md
258
272
  [branches-url]: https://github.com/stdlib-js/stats-base-dists-gamma-mgf/blob/main/branches.md
259
273
 
260
274
  [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-gamma-mgf/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 mgf from '../docs/types/index';
3
+ export = mgf;
package/dist/index.js ADDED
@@ -0,0 +1,7 @@
1
+ "use strict";var s=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var c=s(function(F,o){
2
+ var u=require('@stdlib/math-base-assert-is-nan/dist'),N=require('@stdlib/math-base-special-pow/dist');function y(e,r,n){var i;return u(e)||u(r)||u(n)||r<0||n<=0||e>=n?NaN:(i=1-e/n,N(i,-r))}o.exports=y
3
+ });var a=s(function(O,v){
4
+ var m=require('@stdlib/utils-constant-function/dist'),f=require('@stdlib/math-base-assert-is-nan/dist'),x=require('@stdlib/math-base-special-pow/dist');function g(e,r){if(f(e)||f(r)||e<0||r<=0)return m(NaN);return n;function n(i){var t;return i>=r?NaN:(t=1-i/r,x(t,-e))}}v.exports=g
5
+ });var w=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),q=c(),d=a();w(q,"factory",d);module.exports=q;
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' );\n\n\n// MAIN //\n\n/**\n* Evaluates the moment-generating function (MGF) for a gamma distribution.\n*\n* @param {number} t - input value\n* @param {NonNegativeNumber} alpha - shape parameter\n* @param {PositiveNumber} beta - rate parameter\n* @returns {number} evaluated MGF\n*\n* @example\n* var y = mgf( 0.5, 0.5, 1.0 );\n* // returns ~1.414\n*\n* @example\n* var y = mgf( 0.1, 1.0, 1.0 );\n* // returns ~1.111\n*\n* @example\n* var y = mgf( -1.0, 4.0, 2.0 );\n* // returns ~0.198\n*\n* @example\n* var y = mgf( NaN, 1.0, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = mgf( 0.0, NaN, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = mgf( 0.0, 1.0, NaN );\n* // returns NaN\n*\n* @example\n* var y = mgf( 2.0, 4.0, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = mgf( 2.0, -0.5, 1.0 );\n* // returns NaN\n*\n* @example\n* var y = mgf( 2.0, 1.0, 0.0 );\n* // returns NaN\n*\n* @example\n* var y = mgf( 2.0, 1.0, -1.0 );\n* // returns NaN\n*/\nfunction mgf( t, alpha, beta ) {\n\tvar base;\n\tif (\n\t\tisnan( t ) ||\n\t\tisnan( alpha ) ||\n\t\tisnan( beta ) ||\n\t\talpha < 0.0 ||\n\t\tbeta <= 0.0 ||\n\t\tt >= beta\n\t) {\n\t\treturn NaN;\n\t}\n\tbase = 1.0 - (t / beta);\n\treturn pow( base, -alpha );\n}\n\n\n// EXPORTS //\n\nmodule.exports = mgf;\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' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the moment-generating function (MGF) of a gamma distribution with shape `alpha` and rate `beta`.\n*\n* @param {NonNegativeNumber} alpha - shape parameter\n* @param {PositiveNumber} beta - rate parameter\n* @returns {Function} MGF\n*\n* @example\n* var mgf = factory( 3.0, 1.5 );\n*\n* var y = mgf( 1.0 );\n* // returns ~27.0\n*\n* y = mgf( 0.5 );\n* // returns ~3.375\n*/\nfunction factory( alpha, beta ) {\n\tif (\n\t\tisnan( alpha ) ||\n\t\tisnan( beta ) ||\n\t\talpha < 0.0 ||\n\t\tbeta <= 0.0\n\t) {\n\t\treturn constantFunction( NaN );\n\t}\n\treturn mgf;\n\n\t/**\n\t* Evaluates the moment-generating function (MGF) of a gamma distribution.\n\t*\n\t* @private\n\t* @param {number} t - input value\n\t* @returns {number} evaluated MGF\n\t*\n\t* @example\n\t* var y = mgf( 0.5 );\n\t* // returns <number>\n\t*/\n\tfunction mgf( t ) {\n\t\tvar base;\n\t\tif ( t >= beta ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tbase = 1.0 - (t / beta);\n\t\treturn pow( base, -alpha );\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 moment-generating function (MGF) of a gamma distribution.\n*\n* @module @stdlib/stats-base-dists-gamma-mgf\n*\n* @example\n* var mgf = require( '@stdlib/stats-base-dists-gamma-mgf' );\n*\n* var y = mgf( 0.5, 0.5, 1.0 );\n* // returns ~1.414\n*\n* y = mgf( 0.1, 1.0, 1.0 );\n* // returns ~1.111\n*\n* y = mgf( -1.0, 4.0, 2.0 );\n* // returns ~0.198\n*\n* var mymgf = mgf.factory( 3.0, 1.5 );\n*\n* y = mymgf( 1.0 );\n* // returns ~26.999\n*\n* y = mymgf( 0.5 );\n* // returns ~3.375\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,EAqDnD,SAASC,EAAKC,EAAGC,EAAOC,EAAO,CAC9B,IAAIC,EACJ,OACCN,EAAOG,CAAE,GACTH,EAAOI,CAAM,GACbJ,EAAOK,CAAK,GACZD,EAAQ,GACRC,GAAQ,GACRF,GAAKE,EAEE,KAERC,EAAO,EAAOH,EAAIE,EACXJ,EAAKK,EAAM,CAACF,CAAM,EAC1B,CAKAL,EAAO,QAAUG,IC/FjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAqBnD,SAASC,EAASC,EAAOC,EAAO,CAC/B,GACCJ,EAAOG,CAAM,GACbH,EAAOI,CAAK,GACZD,EAAQ,GACRC,GAAQ,EAER,OAAOL,EAAkB,GAAI,EAE9B,OAAOM,EAaP,SAASA,EAAKC,EAAI,CACjB,IAAIC,EACJ,OAAKD,GAAKF,EACF,KAERG,EAAO,EAAOD,EAAIF,EACXH,EAAKM,EAAM,CAACJ,CAAM,EAC1B,CACD,CAKAL,EAAO,QAAUI,IChCjB,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", "mgf", "t", "alpha", "beta", "base", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "isnan", "pow", "factory", "alpha", "beta", "mgf", "t", "base", "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 moment-generating function (MGF) of a gamma distribution.
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 mgf = require( './mgf.js' );
50
+ var main = require( './main.js' );
51
51
  var factory = require( './factory.js' );
52
52
 
53
53
 
54
54
  // MAIN //
55
55
 
56
- setReadOnly( mgf, 'factory', factory );
56
+ setReadOnly( main, 'factory', factory );
57
57
 
58
58
 
59
59
  // EXPORTS //
60
60
 
61
- module.exports = mgf;
61
+ module.exports = main;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/stats-base-dists-gamma-mgf",
3
- "version": "0.0.7",
3
+ "version": "0.2.0",
4
4
  "description": "Gamma distribution moment-generating function (MGF).",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -37,21 +37,22 @@
37
37
  "url": "https://github.com/stdlib-js/stdlib/issues"
38
38
  },
39
39
  "dependencies": {
40
- "@stdlib/math-base-assert-is-nan": "^0.0.x",
41
- "@stdlib/math-base-special-pow": "^0.0.x",
42
- "@stdlib/utils-constant-function": "^0.0.x",
43
- "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
40
+ "@stdlib/math-base-assert-is-nan": "^0.2.0",
41
+ "@stdlib/math-base-special-pow": "^0.2.0",
42
+ "@stdlib/utils-constant-function": "^0.2.0",
43
+ "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0"
44
44
  },
45
45
  "devDependencies": {
46
- "@stdlib/bench": "^0.0.x",
47
- "@stdlib/constants-float64-eps": "^0.0.x",
48
- "@stdlib/constants-float64-ninf": "^0.0.x",
49
- "@stdlib/constants-float64-pinf": "^0.0.x",
50
- "@stdlib/math-base-special-abs": "^0.0.x",
51
- "@stdlib/random-base-randu": "^0.0.x",
46
+ "@stdlib/constants-float64-eps": "^0.1.1",
47
+ "@stdlib/constants-float64-ninf": "^0.1.1",
48
+ "@stdlib/constants-float64-pinf": "^0.1.1",
49
+ "@stdlib/math-base-special-abs": "^0.1.1",
50
+ "@stdlib/random-base-randu": "^0.1.0",
52
51
  "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
53
52
  "istanbul": "^0.4.1",
54
- "tap-spec": "5.x.x"
53
+ "tap-min": "git+https://github.com/Planeshifter/tap-min.git",
54
+ "@stdlib/bench-harness": "^0.2.0",
55
+ "@stdlib/bench": "^0.3.1"
55
56
  },
56
57
  "engines": {
57
58
  "node": ">=0.10.0",
@@ -83,7 +84,7 @@
83
84
  "univariate"
84
85
  ],
85
86
  "funding": {
86
- "type": "patreon",
87
- "url": "https://www.patreon.com/athan"
87
+ "type": "opencollective",
88
+ "url": "https://opencollective.com/stdlib"
88
89
  }
89
90
  }
package/docs/repl.txt DELETED
@@ -1,79 +0,0 @@
1
-
2
- {{alias}}( t, α, β )
3
- Evaluates the moment-generating function (MGF) for a gamma distribution with
4
- shape parameter `α` and rate parameter `β` at a value `t`.
5
-
6
- If `α <= 0` or `β <= 0`, the function returns `NaN`.
7
-
8
- If `α` or `β` is `NaN`, the function returns `NaN`.
9
-
10
- Parameters
11
- ----------
12
- t: number
13
- Input value.
14
-
15
- α: number
16
- Shape parameter.
17
-
18
- β: number
19
- Rate parameter.
20
-
21
- Returns
22
- -------
23
- out: number
24
- Evaluated MGF.
25
-
26
- Examples
27
- --------
28
- > var y = {{alias}}( 0.5, 0.5, 1.0 )
29
- ~1.414
30
- > y = {{alias}}( 0.1, 1.0, 1.0 )
31
- ~1.111
32
- > y = {{alias}}( -1.0, 4.0, 2.0 )
33
- ~0.198
34
-
35
- > y = {{alias}}( NaN, 1.0, 1.0 )
36
- NaN
37
- > y = {{alias}}( 0.0, NaN, 1.0 )
38
- NaN
39
- > y = {{alias}}( 0.0, 1.0, NaN )
40
- NaN
41
-
42
- > y = {{alias}}( 2.0, 4.0, 1.0 )
43
- NaN
44
- > y = {{alias}}( 2.0, -0.5, 1.0 )
45
- NaN
46
- > y = {{alias}}( 2.0, 1.0, 0.0 )
47
- NaN
48
- > y = {{alias}}( 2.0, 1.0, -1.0 )
49
- NaN
50
-
51
-
52
- {{alias}}.factory( α, β )
53
- Returns a function for evaluating the moment-generating function (MGF) of a
54
- gamma distribution with shape parameter `α` and rate parameter `β`.
55
-
56
- Parameters
57
- ----------
58
- α: number
59
- Shape parameter.
60
-
61
- β: number
62
- Rate parameter.
63
-
64
- Returns
65
- -------
66
- mgf: Function
67
- Moment-generating function (MGF).
68
-
69
- Examples
70
- --------
71
- > var myMGF = {{alias}}.factory( 3.0, 1.5 );
72
- > var y = myMGF( 1.0 )
73
- ~27.0
74
- > y = myMGF( 0.5 )
75
- ~3.375
76
-
77
- See Also
78
- --------
79
-
@@ -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 mgf = require( './index' );
20
-
21
-
22
- // TESTS //
23
-
24
- // The function returns a number...
25
- {
26
- mgf( 2, 2, 4 ); // $ExpectType number
27
- mgf( 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
- mgf( true, 3, 6 ); // $ExpectError
33
- mgf( false, 2, 4 ); // $ExpectError
34
- mgf( '5', 1, 2 ); // $ExpectError
35
- mgf( [], 1, 2 ); // $ExpectError
36
- mgf( {}, 2, 4 ); // $ExpectError
37
- mgf( ( x: number ): number => x, 2, 4 ); // $ExpectError
38
-
39
- mgf( 9, true, 12 ); // $ExpectError
40
- mgf( 9, false, 12 ); // $ExpectError
41
- mgf( 5, '5', 10 ); // $ExpectError
42
- mgf( 8, [], 16 ); // $ExpectError
43
- mgf( 9, {}, 18 ); // $ExpectError
44
- mgf( 8, ( x: number ): number => x, 16 ); // $ExpectError
45
-
46
- mgf( 9, 5, true ); // $ExpectError
47
- mgf( 9, 5, false ); // $ExpectError
48
- mgf( 5, 2, '5' ); // $ExpectError
49
- mgf( 8, 4, [] ); // $ExpectError
50
- mgf( 9, 4, {} ); // $ExpectError
51
- mgf( 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
- mgf(); // $ExpectError
57
- mgf( 2 ); // $ExpectError
58
- mgf( 2, 0 ); // $ExpectError
59
- mgf( 2, 0, 4, 1 ); // $ExpectError
60
- }
61
-
62
- // Attached to main export is a `factory` method which returns a function...
63
- {
64
- mgf.factory( 3, 4 ); // $ExpectType Unary
65
- }
66
-
67
- // The `factory` method returns a function which returns a number...
68
- {
69
- const fcn = mgf.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 = mgf.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 = mgf.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
- mgf.factory( true, 3 ); // $ExpectError
95
- mgf.factory( false, 2 ); // $ExpectError
96
- mgf.factory( '5', 1 ); // $ExpectError
97
- mgf.factory( [], 1 ); // $ExpectError
98
- mgf.factory( {}, 2 ); // $ExpectError
99
- mgf.factory( ( x: number ): number => x, 2 ); // $ExpectError
100
-
101
- mgf.factory( 9, true ); // $ExpectError
102
- mgf.factory( 9, false ); // $ExpectError
103
- mgf.factory( 5, '5' ); // $ExpectError
104
- mgf.factory( 8, [] ); // $ExpectError
105
- mgf.factory( 9, {} ); // $ExpectError
106
- mgf.factory( 8, ( x: number ): number => x ); // $ExpectError
107
-
108
- mgf.factory( [], true ); // $ExpectError
109
- mgf.factory( {}, false ); // $ExpectError
110
- mgf.factory( false, '5' ); // $ExpectError
111
- mgf.factory( {}, [] ); // $ExpectError
112
- mgf.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
- mgf.factory( 0 ); // $ExpectError
118
- mgf.factory( 0, 4, 8 ); // $ExpectError
119
- }
File without changes