@stdlib/stats-base-dists-erlang-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 +18 -17
- package/docs/repl.txt +0 -82
- package/docs/types/test.ts +0 -119
- /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] -->
|
|
@@ -213,7 +224,7 @@ See [LICENSE][stdlib-license].
|
|
|
213
224
|
|
|
214
225
|
## Copyright
|
|
215
226
|
|
|
216
|
-
Copyright © 2016-
|
|
227
|
+
Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].
|
|
217
228
|
|
|
218
229
|
</section>
|
|
219
230
|
|
|
@@ -226,8 +237,8 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
226
237
|
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-erlang-mgf.svg
|
|
227
238
|
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-erlang-mgf
|
|
228
239
|
|
|
229
|
-
[test-image]: https://github.com/stdlib-js/stats-base-dists-erlang-mgf/actions/workflows/test.yml/badge.svg?branch=v0.0
|
|
230
|
-
[test-url]: https://github.com/stdlib-js/stats-base-dists-erlang-mgf/actions/workflows/test.yml?query=branch:v0.0
|
|
240
|
+
[test-image]: https://github.com/stdlib-js/stats-base-dists-erlang-mgf/actions/workflows/test.yml/badge.svg?branch=v0.2.0
|
|
241
|
+
[test-url]: https://github.com/stdlib-js/stats-base-dists-erlang-mgf/actions/workflows/test.yml?query=branch:v0.2.0
|
|
231
242
|
|
|
232
243
|
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-erlang-mgf/main.svg
|
|
233
244
|
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-erlang-mgf?branch=main
|
|
@@ -240,7 +251,7 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
240
251
|
-->
|
|
241
252
|
|
|
242
253
|
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
|
|
243
|
-
[chat-url]: https://gitter.im
|
|
254
|
+
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
|
|
244
255
|
|
|
245
256
|
[stdlib]: https://github.com/stdlib-js/stdlib
|
|
246
257
|
|
|
@@ -250,8 +261,11 @@ Copyright © 2016-2022. The Stdlib [Authors][stdlib-authors].
|
|
|
250
261
|
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
|
|
251
262
|
|
|
252
263
|
[deno-url]: https://github.com/stdlib-js/stats-base-dists-erlang-mgf/tree/deno
|
|
264
|
+
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-erlang-mgf/blob/deno/README.md
|
|
253
265
|
[umd-url]: https://github.com/stdlib-js/stats-base-dists-erlang-mgf/tree/umd
|
|
266
|
+
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-erlang-mgf/blob/umd/README.md
|
|
254
267
|
[esm-url]: https://github.com/stdlib-js/stats-base-dists-erlang-mgf/tree/esm
|
|
268
|
+
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-erlang-mgf/blob/esm/README.md
|
|
255
269
|
[branches-url]: https://github.com/stdlib-js/stats-base-dists-erlang-mgf/blob/main/branches.md
|
|
256
270
|
|
|
257
271
|
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-erlang-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 t=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=t(function(R,o){
|
|
2
|
+
var q=require('@stdlib/math-base-assert-is-nonnegative-integer/dist'),u=require('@stdlib/math-base-assert-is-nan/dist'),N=require('@stdlib/math-base-special-pow/dist');function g(e,r,i){return u(e)||!q(r)||u(i)||i<0||e>=i?NaN:N(1-e/i,-r)}o.exports=g
|
|
3
|
+
});var c=t(function(h,a){
|
|
4
|
+
var p=require('@stdlib/math-base-assert-is-nonnegative-integer/dist'),v=require('@stdlib/math-base-assert-is-nan/dist'),y=require('@stdlib/utils-constant-function/dist'),x=require('@stdlib/math-base-special-pow/dist');function w(e,r){if(!p(e)||v(r)||r<0)return y(NaN);return i;function i(n){return v(n)||n>=r?NaN:x(1-n/r,-e)}}a.exports=w
|
|
5
|
+
});var I=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),f=s(),F=c();I(f,"factory",F);module.exports=f;
|
|
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 isNonNegativeInteger = require( '@stdlib/math-base-assert-is-nonnegative-integer' );\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 an Erlang distribution with shape parameter `k` and rate parameter `lambda` at a value `t`.\n*\n* @param {number} t - input value\n* @param {NonNegativeInteger} k - shape parameter\n* @param {PositiveNumber} lambda - rate parameter\n* @returns {number} evaluated MGF\n*\n* @example\n* var y = mgf( 0.3, 1, 1.0 );\n* // returns ~1.429\n*\n* @example\n* var y = mgf( 2.0, 2, 3.0 );\n* // returns ~9.0\n*\n* @example\n* var y = mgf( -1.0, 2, 2.0 );\n* // returns ~0.444\n*\n* @example\n* var y = mgf( NaN, 1, 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, NaN );\n* // returns NaN\n*\n* @example\n* var y = mgf( 0.2, -2, 0.5 );\n* // returns NaN\n*\n* @example\n* var y = mgf( 0.2, 0.5, 0.5 );\n* // returns NaN\n*\n* @example\n* var y = mgf( 0.2, 1, 0.0 );\n* // returns NaN\n*\n* @example\n* var y = mgf( 0.2, 1, -5.0 );\n* // returns NaN\n*/\nfunction mgf( t, k, lambda ) {\n\tif (\n\t\tisnan( t ) ||\n\t\t!isNonNegativeInteger( k ) ||\n\t\tisnan( lambda )||\n\t\tlambda < 0.0 ||\n\t\tt >= lambda\n\t) {\n\t\treturn NaN;\n\t}\n\treturn pow( 1.0 - (t/lambda), -k );\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 isNonNegativeInteger = require( '@stdlib/math-base-assert-is-nonnegative-integer' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar constantFunction = require( '@stdlib/utils-constant-function' );\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 an Erlang distribution with shape parameter `k` and rate parameter `lambda`.\n*\n* @param {NonNegativeInteger} k - shape parameter\n* @param {PositiveNumber} lambda - rate parameter\n* @returns {Function} MGF\n*\n* @example\n* var mgf = factory( 2, 0.5 );\n*\n* var y = mgf( 0.2 );\n* // returns ~2.778\n*\n* y = mgf( -0.5 );\n* // returns 0.25\n*/\nfunction factory( k, lambda ) {\n\tif (\n\t\t!isNonNegativeInteger( k ) ||\n\t\tisnan( lambda ) ||\n\t\tlambda < 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) for an Erlang 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\tif ( isnan( t ) || t >= lambda ) {\n\t\t\treturn NaN;\n\t\t}\n\t\treturn pow( 1.0 - (t/lambda), -k );\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) for an Erlang distribution.\n*\n* @module @stdlib/stats-base-dists-erlang-mgf\n*\n* @example\n* var mgf = require( '@stdlib/stats-base-dists-erlang-mgf' );\n*\n* var y = mgf( 0.3, 1, 1.0 );\n* // returns ~1.429\n*\n* var myMGF = mgf.factory( 2, 0.5 );\n*\n* y = myMGF( 0.2 );\n* // returns ~2.778\n*\n* y = myMGF( -0.5 );\n* // returns 0.25\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,EAAuB,QAAS,iDAAkD,EAClFC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAqDnD,SAASC,EAAKC,EAAGC,EAAGC,EAAS,CAC5B,OACCL,EAAOG,CAAE,GACT,CAACJ,EAAsBK,CAAE,GACzBJ,EAAOK,CAAO,GACdA,EAAS,GACTF,GAAKE,EAEE,IAEDJ,EAAK,EAAOE,EAAEE,EAAS,CAACD,CAAE,CAClC,CAKAN,EAAO,QAAUI,IC7FjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAuB,QAAS,iDAAkD,EAClFC,EAAQ,QAAS,iCAAkC,EACnDC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAM,QAAS,+BAAgC,EAqBnD,SAASC,EAASC,EAAGC,EAAS,CAC7B,GACC,CAACN,EAAsBK,CAAE,GACzBJ,EAAOK,CAAO,GACdA,EAAS,EAET,OAAOJ,EAAkB,GAAI,EAE9B,OAAOK,EAaP,SAASA,EAAKC,EAAI,CACjB,OAAKP,EAAOO,CAAE,GAAKA,GAAKF,EAChB,IAEDH,EAAK,EAAOK,EAAEF,EAAS,CAACD,CAAE,CAClC,CACD,CAKAN,EAAO,QAAUK,ICpCjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
|
|
6
|
+
"names": ["require_main", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "isnan", "pow", "mgf", "t", "k", "lambda", "require_factory", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "isnan", "constantFunction", "pow", "factory", "k", "lambda", "mgf", "t", "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-erlang-mgf",
|
|
3
|
-
"version": "0.0
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Erlang distribution moment-generating function (MGF).",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": {
|
|
@@ -37,24 +37,25 @@
|
|
|
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-assert-is-nonnegative-integer": "^0.0
|
|
42
|
-
"@stdlib/math-base-special-pow": "^0.0
|
|
43
|
-
"@stdlib/utils-constant-function": "^0.0
|
|
44
|
-
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.0
|
|
40
|
+
"@stdlib/math-base-assert-is-nan": "^0.2.0",
|
|
41
|
+
"@stdlib/math-base-assert-is-nonnegative-integer": "^0.2.0",
|
|
42
|
+
"@stdlib/math-base-special-pow": "^0.2.0",
|
|
43
|
+
"@stdlib/utils-constant-function": "^0.2.0",
|
|
44
|
+
"@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0"
|
|
45
45
|
},
|
|
46
46
|
"devDependencies": {
|
|
47
|
-
"@stdlib/
|
|
48
|
-
"@stdlib/constants-float64-
|
|
49
|
-
"@stdlib/constants-float64-
|
|
50
|
-
"@stdlib/
|
|
51
|
-
"@stdlib/math-base-special-
|
|
52
|
-
"@stdlib/math-base-special-
|
|
53
|
-
"@stdlib/
|
|
54
|
-
"@stdlib/random-base-randu": "^0.0.x",
|
|
47
|
+
"@stdlib/constants-float64-eps": "^0.1.1",
|
|
48
|
+
"@stdlib/constants-float64-ninf": "^0.1.1",
|
|
49
|
+
"@stdlib/constants-float64-pinf": "^0.1.1",
|
|
50
|
+
"@stdlib/math-base-special-abs": "^0.1.1",
|
|
51
|
+
"@stdlib/math-base-special-ceil": "^0.1.1",
|
|
52
|
+
"@stdlib/math-base-special-round": "^0.1.1",
|
|
53
|
+
"@stdlib/random-base-randu": "^0.1.0",
|
|
55
54
|
"tape": "git+https://github.com/kgryte/tape.git#fix/globby",
|
|
56
55
|
"istanbul": "^0.4.1",
|
|
57
|
-
"tap-
|
|
56
|
+
"tap-min": "git+https://github.com/Planeshifter/tap-min.git",
|
|
57
|
+
"@stdlib/bench-harness": "^0.2.0",
|
|
58
|
+
"@stdlib/bench": "^0.3.1"
|
|
58
59
|
},
|
|
59
60
|
"engines": {
|
|
60
61
|
"node": ">=0.10.0",
|
|
@@ -86,7 +87,7 @@
|
|
|
86
87
|
"univariate"
|
|
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,82 +0,0 @@
|
|
|
1
|
-
|
|
2
|
-
{{alias}}( t, k, λ )
|
|
3
|
-
Evaluates the moment-generating function (MGF) for an Erlang distribution
|
|
4
|
-
with shape parameter `k` and rate parameter `λ` at a value `t`.
|
|
5
|
-
|
|
6
|
-
If provided `NaN` as any argument, the function returns `NaN`.
|
|
7
|
-
|
|
8
|
-
If not provided a nonnegative integer for `k`, the function returns `NaN`.
|
|
9
|
-
|
|
10
|
-
If provided a non-positive value for `λ`, the function returns `NaN`.
|
|
11
|
-
|
|
12
|
-
Parameters
|
|
13
|
-
----------
|
|
14
|
-
t: number
|
|
15
|
-
Input value.
|
|
16
|
-
|
|
17
|
-
k: number
|
|
18
|
-
Shape parameter.
|
|
19
|
-
|
|
20
|
-
λ: number
|
|
21
|
-
Rate parameter.
|
|
22
|
-
|
|
23
|
-
Returns
|
|
24
|
-
-------
|
|
25
|
-
out: number
|
|
26
|
-
Evaluated MGF.
|
|
27
|
-
|
|
28
|
-
Examples
|
|
29
|
-
--------
|
|
30
|
-
> var y = {{alias}}( 0.3, 1, 1.0 )
|
|
31
|
-
~1.429
|
|
32
|
-
> y = {{alias}}( 2.0, 2, 3.0 )
|
|
33
|
-
~9.0
|
|
34
|
-
> y = {{alias}}( -1.0, 2, 2.0 )
|
|
35
|
-
~0.444
|
|
36
|
-
|
|
37
|
-
> y = {{alias}}( NaN, 1, 1.0 )
|
|
38
|
-
NaN
|
|
39
|
-
> y = {{alias}}( 0.0, NaN, 1.0 )
|
|
40
|
-
NaN
|
|
41
|
-
> y = {{alias}}( 0.0, 1, NaN )
|
|
42
|
-
NaN
|
|
43
|
-
|
|
44
|
-
> y = {{alias}}( 0.2, -2, 0.5 )
|
|
45
|
-
NaN
|
|
46
|
-
> y = {{alias}}( 0.2, 0.5, 0.5 )
|
|
47
|
-
NaN
|
|
48
|
-
|
|
49
|
-
> y = {{alias}}( 0.2, 1, 0.0 )
|
|
50
|
-
NaN
|
|
51
|
-
> y = {{alias}}( 0.2, 1, -5.0 )
|
|
52
|
-
NaN
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
{{alias}}.factory( k, λ )
|
|
56
|
-
Returns a function for evaluating the moment-generating function (MGF) of an
|
|
57
|
-
Erlang distribution with shape parameter `k` and rate parameter `λ`.
|
|
58
|
-
|
|
59
|
-
Parameters
|
|
60
|
-
----------
|
|
61
|
-
k: number
|
|
62
|
-
Shape parameter.
|
|
63
|
-
|
|
64
|
-
λ: number
|
|
65
|
-
Rate parameter.
|
|
66
|
-
|
|
67
|
-
Returns
|
|
68
|
-
-------
|
|
69
|
-
mgf: Function
|
|
70
|
-
Moment-generating function (MGF).
|
|
71
|
-
|
|
72
|
-
Examples
|
|
73
|
-
--------
|
|
74
|
-
> var myMGF = {{alias}}.factory( 2, 0.5 );
|
|
75
|
-
> var y = myMGF( 0.2 )
|
|
76
|
-
~2.778
|
|
77
|
-
> y = myMGF( -0.5 )
|
|
78
|
-
0.25
|
|
79
|
-
|
|
80
|
-
See Also
|
|
81
|
-
--------
|
|
82
|
-
|
package/docs/types/test.ts
DELETED
|
@@ -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
|
-
}
|
/package/lib/{mgf.js → main.js}
RENAMED
|
File without changes
|