@stdlib/stats-base-dists-uniform-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 +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 +15 -14
- package/docs/repl.txt +0 -74
- package/docs/types/test.ts +0 -120
- /package/lib/{mgf.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
|
# 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] -->
|
|
@@ -201,7 +212,7 @@ See [LICENSE][stdlib-license].
|
|
|
201
212
|
|
|
202
213
|
## Copyright
|
|
203
214
|
|
|
204
|
-
Copyright © 2016-
|
|
215
|
+
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
|
|
205
216
|
|
|
206
217
|
</section>
|
|
207
218
|
|
|
@@ -214,8 +225,8 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
214
225
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-uniform-mgf.svg
|
|
215
226
|
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-uniform-mgf
|
|
216
227
|
|
|
217
|
-
[test-image]: https://github.com/stdlib-js/stats-base-dists-uniform-mgf/actions/workflows/test.yml/badge.svg?branch=v0.0
|
|
218
|
-
[test-url]: https://github.com/stdlib-js/stats-base-dists-uniform-mgf/actions/workflows/test.yml?query=branch:v0.0
|
|
228
|
+
[test-image]: https://github.com/stdlib-js/stats-base-dists-uniform-mgf/actions/workflows/test.yml/badge.svg?branch=v0.2.0
|
|
229
|
+
[test-url]: https://github.com/stdlib-js/stats-base-dists-uniform-mgf/actions/workflows/test.yml?query=branch:v0.2.0
|
|
219
230
|
|
|
220
231
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-uniform-mgf/main.svg
|
|
221
232
|
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-uniform-mgf?branch=main
|
|
@@ -228,7 +239,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
228
239
|
-->
|
|
229
240
|
|
|
230
241
|
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
231
|
-
[chat-url]: https://gitter.im
|
|
242
|
+
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
|
|
232
243
|
|
|
233
244
|
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
234
245
|
|
|
@@ -238,8 +249,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
238
249
|
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
|
|
239
250
|
|
|
240
251
|
[deno-url]: https://github.com/stdlib-js/stats-base-dists-uniform-mgf/tree/deno
|
|
252
|
+
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-uniform-mgf/blob/deno/README.md
|
|
241
253
|
[umd-url]: https://github.com/stdlib-js/stats-base-dists-uniform-mgf/tree/umd
|
|
254
|
+
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-uniform-mgf/blob/umd/README.md
|
|
242
255
|
[esm-url]: https://github.com/stdlib-js/stats-base-dists-uniform-mgf/tree/esm
|
|
256
|
+
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-uniform-mgf/blob/esm/README.md
|
|
243
257
|
[branches-url]: https://github.com/stdlib-js/stats-base-dists-uniform-mgf/blob/main/branches.md
|
|
244
258
|
|
|
245
259
|
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-uniform-mgf/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 o=f(function(F,c){
|
|
2
|
+
var t=require('@stdlib/math-base-assert-is-nan/dist'),s=require('@stdlib/math-base-special-exp/dist');function x(e,r,i){var n;return t(e)||t(r)||t(i)||r>=i?NaN:e===0?1:(n=s(e*i)-s(e*r),n/=e*(i-r),n)}c.exports=x
|
|
3
|
+
});var N=f(function(O,q){
|
|
4
|
+
var y=require('@stdlib/utils-constant-function/dist'),a=require('@stdlib/math-base-assert-is-nan/dist'),v=require('@stdlib/math-base-special-exp/dist');function m(e,r){if(a(e)||a(r)||e>=r)return y(NaN);return i;function i(n){var u;return a(n)?NaN:n===0?1:(u=v(n*r)-v(n*e),u/=n*(r-e),u)}}q.exports=m
|
|
5
|
+
});var g=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),p=o(),d=N();g(p,"factory",d);module.exports=p;
|
|
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' );\n\n\n// MAIN //\n\n/**\n* Evaluates the moment-generating function (MGF) of a uniform distribution with minimum support `a` and maximum support `b` at a value `t`.\n*\n* @param {number} t - input value\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @returns {number} evaluated MGF\n*\n* @example\n* var y = mgf( 2.0, 0.0, 4.0 );\n* // returns ~372.495\n*\n* @example\n* var y = mgf( -0.2, 0.0, 4.0 );\n* // returns ~0.688\n*\n* @example\n* var y = mgf( 2.0, 0.0, 1.0 );\n* // returns ~3.195\n*\n* @example\n* var y = mgf( 0.5, 3.0, 2.0 );\n* // returns NaN\n*\n* @example\n* var y = mgf( 0.5, 3.0, 3.0 );\n* // returns NaN\n*\n* @example\n* var y = mgf( NaN, 0.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, 0.0, NaN );\n* // returns NaN\n*/\nfunction mgf( t, a, b ) {\n\tvar ret;\n\tif (\n\t\tisnan( t ) ||\n\t\tisnan( a ) ||\n\t\tisnan( b ) ||\n\t\ta >= b\n\t) {\n\t\treturn NaN;\n\t}\n\tif ( t === 0.0 ) {\n\t\treturn 1.0;\n\t}\n\t// Case: t not equal to zero\n\tret = exp( t * b ) - exp( t * a );\n\tret /= t * ( b - a );\n\treturn ret;\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 exp = require( '@stdlib/math-base-special-exp' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the moment-generating function (MGF) of a uniform distribution with minimum support `a` and maximum support `b`.\n*\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @returns {Function} MGF\n*\n* @example\n* var mgf = factory( 6.0, 7.0 );\n* var y = mgf( 0.1 );\n* // returns ~1.916\n*\n* y = mgf( 1.1 );\n* // returns ~1339.321\n*/\nfunction factory( a, b ) {\n\tif (\n\t\tisnan( a ) ||\n\t\tisnan( b ) ||\n\t\ta >= b\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 uniform 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 ret;\n\t\tif ( isnan( t ) ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tif ( t === 0.0 ) {\n\t\t\treturn 1.0;\n\t\t}\n\t\t// Case: t not equal to zero\n\t\tret = exp( t * b ) - exp( t * a );\n\t\tret /= t * ( b - a );\n\t\treturn ret;\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 uniform distribution.\n*\n* @module @stdlib/stats-base-dists-uniform-mgf\n*\n* @example\n* var mgf = require( '@stdlib/stats-base-dists-uniform-mgf' );\n*\n* var y = mgf( 2.0, 0.0, 4.0 );\n* // returns ~372.495\n*\n* y = mgf( -0.2, 0.0, 4.0 );\n* // returns ~0.688\n*\n* y = mgf( 2.0, 0.0, 1.0 );\n* // returns ~3.195\n*\n* var mymgf = mgf.factory( 6.0, 7.0 );\n* y = mymgf( 0.1 );\n* // returns ~1.916\n*\n* y = mymgf( 1.1 );\n* // returns ~1339.321\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,EA6CnD,SAASC,EAAKC,EAAGC,EAAGC,EAAI,CACvB,IAAIC,EACJ,OACCN,EAAOG,CAAE,GACTH,EAAOI,CAAE,GACTJ,EAAOK,CAAE,GACTD,GAAKC,EAEE,IAEHF,IAAM,EACH,GAGRG,EAAML,EAAKE,EAAIE,CAAE,EAAIJ,EAAKE,EAAIC,CAAE,EAChCE,GAAOH,GAAME,EAAID,GACVE,EACR,CAKAP,EAAO,QAAUG,IC1FjB,IAAAK,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAoBnD,SAASC,EAASC,EAAGC,EAAI,CACxB,GACCJ,EAAOG,CAAE,GACTH,EAAOI,CAAE,GACTD,GAAKC,EAEL,OAAOL,EAAkB,GAAI,EAE9B,OAAOM,EAaP,SAASA,EAAKC,EAAI,CACjB,IAAIC,EACJ,OAAKP,EAAOM,CAAE,EACN,IAEHA,IAAM,EACH,GAGRC,EAAMN,EAAKK,EAAIF,CAAE,EAAIH,EAAKK,EAAIH,CAAE,EAChCI,GAAOD,GAAMF,EAAID,GACVI,EACR,CACD,CAKAT,EAAO,QAAUI,ICpCjB,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", "mgf", "t", "a", "b", "ret", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "isnan", "exp", "factory", "a", "b", "mgf", "t", "ret", "setReadOnly", "main", "factory"]
|
|
7
|
+
}
|
package/docs/types/index.d.ts
CHANGED
package/lib/index.js
CHANGED
|
@@ -46,15 +46,15 @@
|
|
|
46
46
|
// MODULES //
|
|
47
47
|
|
|
48
48
|
var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
|
|
49
|
-
var
|
|
49
|
+
var main = require( './main.js' );
|
|
50
50
|
var factory = require( './factory.js' );
|
|
51
51
|
|
|
52
52
|
|
|
53
53
|
// MAIN //
|
|
54
54
|
|
|
55
|
-
setReadOnly(
|
|
55
|
+
setReadOnly( main, 'factory', factory );
|
|
56
56
|
|
|
57
57
|
|
|
58
58
|
// EXPORTS //
|
|
59
59
|
|
|
60
|
-
module.exports =
|
|
60
|
+
module.exports = main;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@stdlib/stats-base-dists-uniform-mgf",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Uniform 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
|
|
41
|
-
"@stdlib/math-base-special-exp": "^0.0
|
|
42
|
-
"@stdlib/utils-constant-function": "^0.0
|
|
43
|
-
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.0
|
|
40
|
+
"@stdlib/math-base-assert-is-nan": "^0.2.0",
|
|
41
|
+
"@stdlib/math-base-special-exp": "^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/
|
|
47
|
-
"@stdlib/constants-float64-
|
|
48
|
-
"@stdlib/constants-float64-
|
|
49
|
-
"@stdlib/
|
|
50
|
-
"@stdlib/
|
|
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-
|
|
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": "
|
|
87
|
-
"url": "https://
|
|
87
|
+
"type": "opencollective",
|
|
88
|
+
"url": "https://opencollective.com/stdlib"
|
|
88
89
|
}
|
|
89
90
|
}
|
package/docs/repl.txt
DELETED
|
@@ -1,74 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
{{alias}}( t, a, b )
|
|
3
|
-
Evaluates the moment-generating function (MGF) for a uniform
|
|
4
|
-
distribution with minimum support `a` and maximum support `b` at a value
|
|
5
|
-
`t`.
|
|
6
|
-
|
|
7
|
-
If provided `NaN` as any argument, the function returns `NaN`.
|
|
8
|
-
|
|
9
|
-
If provided `a >= b`, the function returns `NaN`.
|
|
10
|
-
|
|
11
|
-
Parameters
|
|
12
|
-
----------
|
|
13
|
-
t: number
|
|
14
|
-
Input value.
|
|
15
|
-
|
|
16
|
-
a: number
|
|
17
|
-
Minimum support.
|
|
18
|
-
|
|
19
|
-
b: number
|
|
20
|
-
Maximum support.
|
|
21
|
-
|
|
22
|
-
Returns
|
|
23
|
-
-------
|
|
24
|
-
out: number
|
|
25
|
-
Evaluated MGF.
|
|
26
|
-
|
|
27
|
-
Examples
|
|
28
|
-
--------
|
|
29
|
-
> var y = {{alias}}( 2.0, 0.0, 4.0 )
|
|
30
|
-
~372.495
|
|
31
|
-
> y = {{alias}}( -0.2, 0.0, 4.0 )
|
|
32
|
-
~0.688
|
|
33
|
-
> y = {{alias}}( 2.0, 0.0, 1.0 )
|
|
34
|
-
~3.195
|
|
35
|
-
> y = {{alias}}( 0.5, 3.0, 2.0 )
|
|
36
|
-
NaN
|
|
37
|
-
> y = {{alias}}( 0.5, 3.0, 3.0 )
|
|
38
|
-
NaN
|
|
39
|
-
> y = {{alias}}( NaN, 0.0, 1.0 )
|
|
40
|
-
NaN
|
|
41
|
-
> y = {{alias}}( 0.0, NaN, 1.0 )
|
|
42
|
-
NaN
|
|
43
|
-
> y = {{alias}}( 0.0, 0.0, NaN )
|
|
44
|
-
NaN
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
{{alias}}.factory( a, b )
|
|
48
|
-
Returns a function for evaluating the moment-generating function (MGF)
|
|
49
|
-
of a uniform distribution with minimum support `a` and maximum support `b`.
|
|
50
|
-
|
|
51
|
-
Parameters
|
|
52
|
-
----------
|
|
53
|
-
a: number
|
|
54
|
-
Minimum support.
|
|
55
|
-
|
|
56
|
-
b: number
|
|
57
|
-
Maximum support.
|
|
58
|
-
|
|
59
|
-
Returns
|
|
60
|
-
-------
|
|
61
|
-
mgf: Function
|
|
62
|
-
Moment-generating function (MGF).
|
|
63
|
-
|
|
64
|
-
Examples
|
|
65
|
-
--------
|
|
66
|
-
> var mymgf = {{alias}}.factory( 6.0, 7.0 );
|
|
67
|
-
> var y = mymgf( 0.1 )
|
|
68
|
-
~1.916
|
|
69
|
-
> y = mymgf( 1.1 )
|
|
70
|
-
~1339.321
|
|
71
|
-
|
|
72
|
-
See Also
|
|
73
|
-
--------
|
|
74
|
-
|
package/docs/types/test.ts
DELETED
|
@@ -1,120 +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
|
-
|
|
68
|
-
// The `factory` method returns a function which returns a number...
|
|
69
|
-
{
|
|
70
|
-
const fcn = mgf.factory( 3, 4 );
|
|
71
|
-
fcn( 2 ); // $ExpectType number
|
|
72
|
-
}
|
|
73
|
-
|
|
74
|
-
// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments...
|
|
75
|
-
{
|
|
76
|
-
const fcn = mgf.factory( 3, 4 );
|
|
77
|
-
fcn( true ); // $ExpectError
|
|
78
|
-
fcn( false ); // $ExpectError
|
|
79
|
-
fcn( '5' ); // $ExpectError
|
|
80
|
-
fcn( [] ); // $ExpectError
|
|
81
|
-
fcn( {} ); // $ExpectError
|
|
82
|
-
fcn( ( x: number ): number => x ); // $ExpectError
|
|
83
|
-
}
|
|
84
|
-
|
|
85
|
-
// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments...
|
|
86
|
-
{
|
|
87
|
-
const fcn = mgf.factory( 3, 4 );
|
|
88
|
-
fcn(); // $ExpectError
|
|
89
|
-
fcn( 2, 0 ); // $ExpectError
|
|
90
|
-
fcn( 2, 0, 1 ); // $ExpectError
|
|
91
|
-
}
|
|
92
|
-
|
|
93
|
-
// The compiler throws an error if the `factory` method is provided values other than two numbers...
|
|
94
|
-
{
|
|
95
|
-
mgf.factory( true, 3 ); // $ExpectError
|
|
96
|
-
mgf.factory( false, 2 ); // $ExpectError
|
|
97
|
-
mgf.factory( '5', 1 ); // $ExpectError
|
|
98
|
-
mgf.factory( [], 1 ); // $ExpectError
|
|
99
|
-
mgf.factory( {}, 2 ); // $ExpectError
|
|
100
|
-
mgf.factory( ( x: number ): number => x, 2 ); // $ExpectError
|
|
101
|
-
|
|
102
|
-
mgf.factory( 9, true ); // $ExpectError
|
|
103
|
-
mgf.factory( 9, false ); // $ExpectError
|
|
104
|
-
mgf.factory( 5, '5' ); // $ExpectError
|
|
105
|
-
mgf.factory( 8, [] ); // $ExpectError
|
|
106
|
-
mgf.factory( 9, {} ); // $ExpectError
|
|
107
|
-
mgf.factory( 8, ( x: number ): number => x ); // $ExpectError
|
|
108
|
-
|
|
109
|
-
mgf.factory( [], true ); // $ExpectError
|
|
110
|
-
mgf.factory( {}, false ); // $ExpectError
|
|
111
|
-
mgf.factory( false, '5' ); // $ExpectError
|
|
112
|
-
mgf.factory( {}, [] ); // $ExpectError
|
|
113
|
-
mgf.factory( '5', ( x: number ): number => x ); // $ExpectError
|
|
114
|
-
}
|
|
115
|
-
|
|
116
|
-
// The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
|
|
117
|
-
{
|
|
118
|
-
mgf.factory( 0 ); // $ExpectError
|
|
119
|
-
mgf.factory( 0, 4, 8 ); // $ExpectError
|
|
120
|
-
}
|
/package/lib/{mgf.js → main.js}
RENAMED
|
File without changes
|