@stdlib/stats-base-dists-exponential-mgf 0.0.8 → 0.1.0

package/CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2022 The Stdlib Authors.
+Copyright (c) 2016-2023 The Stdlib Authors.

package/README.md

@@ -18,6 +18,17 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <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>
+  <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>
+  <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>
+  <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>
+</details>
+
 # Moment-Generating Function
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -190,7 +201,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -203,8 +214,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-exponential-mgf.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-exponential-mgf
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-exponential-mgf/actions/workflows/test.yml/badge.svg?branch=v0.0.8
-[test-url]: https://github.com/stdlib-js/stats-base-dists-exponential-mgf/actions/workflows/test.yml?query=branch:v0.0.8
+[test-image]: https://github.com/stdlib-js/stats-base-dists-exponential-mgf/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/stats-base-dists-exponential-mgf/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-exponential-mgf/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-exponential-mgf?branch=main
@@ -217,7 +228,7 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 -->
 
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import mgf from '../docs/types/index';
+export = mgf;

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";var i=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var s=i(function(P,u){
+var t=require('@stdlib/math-base-assert-is-nan/dist'),v=require('@stdlib/constants-float64-pinf/dist');function N(e,r){return t(e)||t(r)||r<=0||r===v||e>=r?NaN:r/(r-e)}u.exports=N
+});var o=i(function(O,f){
+var y=require('@stdlib/utils-constant-function/dist'),c=require('@stdlib/math-base-assert-is-nan/dist'),p=require('@stdlib/constants-float64-pinf/dist');function x(e){if(c(e)||e<=0||e===p)return y(NaN);return r;function r(n){return c(n)||n>=e?NaN:e/(e-n)}}f.exports=x
+});var F=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),q=s(),g=o();F(q,"factory",g);module.exports=q;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/main.js", "../lib/factory.js", "../lib/index.js"],
+  "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 PINF = require( '@stdlib/constants-float64-pinf' );\n\n\n// MAIN //\n\n/**\n* Evaluates the moment-generating function (MGF) for an exponential distribution with rate parameter `lambda` at a value `t`.\n*\n* @param {number} t - input value\n* @param {PositiveNumber} lambda - rate parameter\n* @returns {number} evaluated MGF\n*\n* @example\n* var v = mgf( 2.0, 3.0 );\n* // returns 3.0\n*\n* @example\n* var v = mgf( 0.4, 1.2 );\n* // returns 1.5\n*\n* @example\n* var v = mgf( 0.8, 1.6 );\n* // returns 2.0\n*\n* @example\n* var v = mgf( 4.0, 3.0 );\n* // returns NaN\n*\n* @example\n* var v = mgf( NaN, 3.0 );\n* // returns NaN\n*\n* @example\n* var v = mgf( 2.0, NaN );\n* // returns NaN\n*/\nfunction mgf( t, lambda ) {\n\tif (\n\t\tisnan( t ) ||\n\t\tisnan( lambda ) ||\n\t\tlambda <= 0.0 ||\n\t\tlambda === PINF ||\n\t\tt >= lambda\n\t) {\n\t\treturn NaN;\n\t}\n\treturn lambda / ( lambda - t );\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 PINF = require( '@stdlib/constants-float64-pinf' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the moment-generating function (MGF) of an exponential distribution with rate parameter `lambda`.\n*\n* @param {PositiveNumber} lambda - rate parameter\n* @returns {Function} MGF\n*\n* @example\n* var mgf = factory( 4.0 );\n* var y = mgf( 3.0 );\n* // returns 4.0\n*\n* y = mgf( 0.5 );\n* // returns ~1.143\n*/\nfunction factory( lambda ) {\n\tif (\n\t\tisnan( lambda ) ||\n\t\tlambda <= 0.0 ||\n\t\tlambda === PINF\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 exponential 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 lambda / ( lambda - t );\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 exponential distribution.\n*\n* @module @stdlib/stats-base-dists-exponential-mgf\n*\n* @example\n* var mgf = require( '@stdlib/stats-base-dists-exponential-mgf' );\n*\n* var v = mgf( 2.0, 3.0 );\n* // returns 3.0\n*\n* var mymgf = mgf.factory( 4.0 );\n* v = mymgf( 3.0 );\n* // returns 4.0\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"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,iCAAkC,EACnDC,EAAO,QAAS,gCAAiC,EAoCrD,SAASC,EAAKC,EAAGC,EAAS,CACzB,OACCJ,EAAOG,CAAE,GACTH,EAAOI,CAAO,GACdA,GAAU,GACVA,IAAWH,GACXE,GAAKC,EAEE,IAEDA,GAAWA,EAASD,EAC5B,CAKAJ,EAAO,QAAUG,IC3EjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAQ,QAAS,iCAAkC,EACnDC,EAAO,QAAS,gCAAiC,EAmBrD,SAASC,EAASC,EAAS,CAC1B,GACCH,EAAOG,CAAO,GACdA,GAAU,GACVA,IAAWF,EAEX,OAAOF,EAAkB,GAAI,EAE9B,OAAOK,EAaP,SAASA,EAAKC,EAAI,CACjB,OAAKL,EAAOK,CAAE,GAAKA,GAAKF,EAChB,IAEDA,GAAWA,EAASE,EAC5B,CACD,CAKAP,EAAO,QAAUI,ICrCjB,IAAII,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isnan", "PINF", "mgf", "t", "lambda", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "isnan", "PINF", "factory", "lambda", "mgf", "t", "setReadOnly", "main", "factory"]
+}

package/docs/types/index.d.ts

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
 * Evaluates the moment-generating function (MGF) of an exponential distribution.

package/lib/index.js

@@ -37,15 +37,15 @@
 // MODULES //
 
 var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
-var mgf = require( './mgf.js' );
+var main = require( './main.js' );
 var factory = require( './factory.js' );
 
 
 // MAIN //
 
-setReadOnly( mgf, 'factory', factory );
+setReadOnly( main, 'factory', factory );
 
 
 // EXPORTS //
 
-module.exports = mgf;
+module.exports = main;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-exponential-mgf",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "description": "Exponential distribution moment-generating function (MGF).",
   "license": "Apache-2.0",
   "author": {
@@ -37,20 +37,20 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/constants-float64-pinf": "^0.0.x",
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/utils-constant-function": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
+    "@stdlib/constants-float64-pinf": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/utils-constant-function": "^0.1.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/constants-float64-eps": "^0.0.x",
-    "@stdlib/constants-float64-ninf": "^0.0.x",
-    "@stdlib/math-base-special-abs": "^0.0.x",
-    "@stdlib/random-base-randu": "^0.0.x",
+    "@stdlib/bench": "^0.1.0",
+    "@stdlib/constants-float64-eps": "^0.0.8",
+    "@stdlib/constants-float64-ninf": "^0.0.8",
+    "@stdlib/math-base-special-abs": "^0.0.6",
+    "@stdlib/random-base-randu": "^0.0.8",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -84,7 +84,7 @@
     "univariate"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,63 +0,0 @@
-
-{{alias}}( t, λ )
-    Evaluates the moment-generating function (MGF) for an exponential
-    distribution with rate parameter `λ` at a value `t`.
-
-    If provided `NaN` as any argument, the function returns `NaN`.
-
-    If provided a negative value for `λ`, the function returns `NaN`.
-
-    Parameters
-    ----------
-    t: number
-        Input value.
-
-    λ: number
-        Rate parameter.
-
-    Returns
-    -------
-    out: number
-        Evaluated MGF.
-
-    Examples
-    --------
-    > var v = {{alias}}( 2.0, 3.0 )
-    3.0
-    > v = {{alias}}( 0.4, 1.2 )
-    1.5
-    > v = {{alias}}( 0.8, 1.6 )
-    2.0
-    > v = {{alias}}( 4.0, 3.0 )
-    NaN
-    > v = {{alias}}( NaN, 3.0 )
-    NaN
-    > v = {{alias}}( 2.0, NaN )
-    NaN
-
-
-{{alias}}.factory( λ )
-    Returns a function for evaluating the moment-generating function (MGF) for
-    an exponential distribution with rate parameter `λ`.
-
-    Parameters
-    ----------
-    λ: number
-        Rate parameter.
-
-    Returns
-    -------
-    mg: Function
-        Moment-generating function (MGF).
-
-    Examples
-    --------
-    > var myMGF = {{alias}}.factory( 4.0 );
-    > var y = myMGF( 3.0 )
-    4.0
-    > y = myMGF( 0.5 )
-    ~1.143
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,98 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2019 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-import mgf = require( './index' );
-
-
-// TESTS //
-
-// The function returns a number...
-{
-	mgf( 2, 4 ); // $ExpectType number
-	mgf( 1, 2 ); // $ExpectType number
-}
-
-// The compiler throws an error if the function is provided values other than two numbers...
-{
-	mgf( true, 3 ); // $ExpectError
-	mgf( false, 2 ); // $ExpectError
-	mgf( '5', 1 ); // $ExpectError
-	mgf( [], 1 ); // $ExpectError
-	mgf( {}, 4 ); // $ExpectError
-	mgf( ( x: number ): number => x, 2 ); // $ExpectError
-
-	mgf( 9, true ); // $ExpectError
-	mgf( 9, false ); // $ExpectError
-	mgf( 5, '5' ); // $ExpectError
-	mgf( 8, [] ); // $ExpectError
-	mgf( 9, {} ); // $ExpectError
-	mgf( 8, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an unsupported number of arguments...
-{
-	mgf(); // $ExpectError
-	mgf( 2 ); // $ExpectError
-	mgf( 2, 0, 4 ); // $ExpectError
-}
-
-// Attached to main export is a `factory` method which returns a function...
-{
-	mgf.factory( 4 ); // $ExpectType Unary
-}
-
-// The `factory` method returns a function which returns a number...
-{
-	const fcn = mgf.factory( 4 );
-	fcn( 2 ); // $ExpectType number
-}
-
-// The compiler throws an error if the function returned by the `factory` method is provided an invalid argument...
-{
-	const fcn = mgf.factory( 4 );
-	fcn( true ); // $ExpectError
-	fcn( false ); // $ExpectError
-	fcn( '5' ); // $ExpectError
-	fcn( [] ); // $ExpectError
-	fcn( {} ); // $ExpectError
-	fcn( ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments...
-{
-	const fcn = mgf.factory( 4 );
-	fcn(); // $ExpectError
-	fcn( 2, 0 ); // $ExpectError
-	fcn( 2, 0, 1 ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided a value other than a number...
-{
-	mgf.factory( true ); // $ExpectError
-	mgf.factory( false ); // $ExpectError
-	mgf.factory( '5' ); // $ExpectError
-	mgf.factory( [] ); // $ExpectError
-	mgf.factory( {} ); // $ExpectError
-	mgf.factory( ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
-{
-	mgf.factory( 0, 2 ); // $ExpectError
-	mgf.factory( 0, 4, 8 ); // $ExpectError
-}