@stdlib/stats-base-dists-geometric-pmf 0.0.7 → 0.2.0

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2022 The Stdlib Authors.
+Copyright (c) 2016-2024 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>
+
 # Probability Mass Function
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -175,7 +186,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -188,8 +199,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-geometric-pmf.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-geometric-pmf
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-geometric-pmf/actions/workflows/test.yml/badge.svg?branch=v0.0.7
-[test-url]: https://github.com/stdlib-js/stats-base-dists-geometric-pmf/actions/workflows/test.yml?query=branch:v0.0.7
+[test-image]: https://github.com/stdlib-js/stats-base-dists-geometric-pmf/actions/workflows/test.yml/badge.svg?branch=v0.2.0
+[test-url]: https://github.com/stdlib-js/stats-base-dists-geometric-pmf/actions/workflows/test.yml?query=branch:v0.2.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-geometric-pmf/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-geometric-pmf?branch=main
@@ -202,7 +213,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
 
@@ -212,8 +223,11 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 
 [deno-url]: https://github.com/stdlib-js/stats-base-dists-geometric-pmf/tree/deno
+[deno-readme]: https://github.com/stdlib-js/stats-base-dists-geometric-pmf/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/stats-base-dists-geometric-pmf/tree/umd
+[umd-readme]: https://github.com/stdlib-js/stats-base-dists-geometric-pmf/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/stats-base-dists-geometric-pmf/tree/esm
+[esm-readme]: https://github.com/stdlib-js/stats-base-dists-geometric-pmf/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/stats-base-dists-geometric-pmf/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-geometric-pmf/main/LICENSE

package/SECURITY.md

@@ -0,0 +1,5 @@
+# Security
+
+> Policy for reporting security vulnerabilities.
+
+See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";var n=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var o=n(function(O,u){
+var c=require('@stdlib/math-base-assert-is-nonnegative-integer/dist'),a=require('@stdlib/math-base-assert-is-nan/dist'),N=require('@stdlib/math-base-special-pow/dist');function g(e,r){var t;return a(e)||a(r)||r<0||r>1?NaN:c(e)?(t=1-r,r*N(t,e)):0}u.exports=g
+});var f=n(function(R,v){
+var y=require('@stdlib/math-base-assert-is-nonnegative-integer/dist'),m=require('@stdlib/utils-constant-function/dist'),s=require('@stdlib/math-base-assert-is-nan/dist'),w=require('@stdlib/math-base-special-pow/dist');function I(e){if(s(e)||e<0||e>1)return m(NaN);return r;function r(t){var i;return s(t)?NaN:y(t)?(i=1-e,e*w(i,t)):0}}v.exports=I
+});var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),q=o(),l=f();d(q,"factory",l);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 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 probability mass function (PMF) for a geometric distribution with success probability `p` at a value `x`.\n*\n* @param {number} x - input value\n* @param {Probability} p - success probability\n* @returns {Probability} evaluated PMF\n*\n* @example\n* var y = pmf( 4.0, 0.3 );\n* // returns ~0.072\n*\n* @example\n* var y = pmf( 2.0, 0.7 );\n* // returns ~0.063\n*\n* @example\n* var y = pmf( -1.0, 0.5 );\n* // returns 0.0\n*\n* @example\n* var y = pmf( 0.0, NaN );\n* // returns NaN\n*\n* @example\n* var y = pmf( NaN, 0.5 );\n* // returns NaN\n*\n* @example\n* // Invalid success probability:\n* var y = pmf( 2.0, 1.5 );\n* // returns NaN\n*/\nfunction pmf( x, p ) {\n\tvar q;\n\tif (\n\t\tisnan( x ) ||\n\t\tisnan( p ) ||\n\t\tp < 0.0 ||\n\t\tp > 1.0\n\t) {\n\t\treturn NaN;\n\t}\n\tif ( isNonNegativeInteger( x ) ) {\n\t\tq = 1.0 - p;\n\t\treturn p * pow( q, x );\n\t}\n\treturn 0.0;\n}\n\n\n// EXPORTS //\n\nmodule.exports = pmf;\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 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 probability mass function (PMF) for a geometric distribution with success probability `p`.\n*\n* @param {Probability} p - success probability\n* @returns {Function} PMF\n*\n* @example\n* var pmf = factory( 0.5 );\n* var y = pmf( 3.0 );\n* // returns 0.0625\n*\n* y = pmf( 1.0 );\n* // returns 0.25\n*/\nfunction factory( p ) {\n\tif (\n\t\tisnan( p ) ||\n\t\tp < 0.0 ||\n\t\tp > 1.0\n\t) {\n\t\treturn constantFunction( NaN );\n\t}\n\treturn pmf;\n\n\t/**\n\t* Evaluates the probability mass function (PMF) for a geometric distribution.\n\t*\n\t* @private\n\t* @param {number} x - input value\n\t* @returns {Probability} evaluated PMF\n\t*\n\t* @example\n\t* var y = pmf( 2.0 );\n\t* // returns <number>\n\t*/\n\tfunction pmf( x ) {\n\t\tvar q;\n\t\tif ( isnan( x ) ) {\n\t\t\treturn NaN;\n\t\t}\n\t\tif ( isNonNegativeInteger( x ) ) {\n\t\t\tq = 1.0 - p;\n\t\t\treturn p * pow( q, x );\n\t\t}\n\t\treturn 0.0;\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* Geometric distribution probability mass function (PMF).\n*\n* @module @stdlib/stats-base-dists-geometric-pmf\n*\n* @example\n* var pmf = require( '@stdlib/stats-base-dists-geometric-pmf' );\n*\n* var y = pmf( 4.0, 0.3 );\n* // returns ~0.072\n*\n* y = pmf( 2.0, 0.7 );\n* // returns ~0.063\n*\n* y = pmf( -1.0, 0.5 );\n* // returns 0.0\n*\n* var mypmf = pmf.factory( 0.5 );\n* y = mypmf( 3.0 );\n* // returns 0.0625\n*\n* y = mypmf( 1.0 );\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"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAuB,QAAS,iDAAkD,EAClFC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAqCnD,SAASC,EAAKC,EAAGC,EAAI,CACpB,IAAIC,EACJ,OACCL,EAAOG,CAAE,GACTH,EAAOI,CAAE,GACTA,EAAI,GACJA,EAAI,EAEG,IAEHL,EAAsBI,CAAE,GAC5BE,EAAI,EAAMD,EACHA,EAAIH,EAAKI,EAAGF,CAAE,GAEf,CACR,CAKAL,EAAO,QAAUI,ICjFjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAuB,QAAS,iDAAkD,EAClFC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAQ,QAAS,iCAAkC,EACnDC,EAAM,QAAS,+BAAgC,EAmBnD,SAASC,EAASC,EAAI,CACrB,GACCH,EAAOG,CAAE,GACTA,EAAI,GACJA,EAAI,EAEJ,OAAOJ,EAAkB,GAAI,EAE9B,OAAOK,EAaP,SAASA,EAAKC,EAAI,CACjB,IAAIC,EACJ,OAAKN,EAAOK,CAAE,EACN,IAEHP,EAAsBO,CAAE,GAC5BC,EAAI,EAAMH,EACHA,EAAIF,EAAKK,EAAGD,CAAE,GAEf,CACR,CACD,CAKAR,EAAO,QAAUK,IClCjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "isnan", "pow", "pmf", "x", "p", "q", "require_factory", "__commonJSMin", "exports", "module", "isNonNegativeInteger", "constantFunction", "isnan", "pow", "factory", "p", "pmf", "x", "q", "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 probability mass function (PMF) for a geometric distribution.

package/lib/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-geometric-pmf",
-  "version": "0.0.7",
+  "version": "0.2.0",
   "description": "Geometric distribution probability mass function (PMF).",
   "license": "Apache-2.0",
   "author": {
@@ -37,22 +37,23 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/math-base-assert-is-nonnegative-integer": "^0.0.x",
-    "@stdlib/math-base-special-pow": "^0.0.x",
-    "@stdlib/utils-constant-function": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
+    "@stdlib/math-base-assert-is-nan": "^0.2.0",
+    "@stdlib/math-base-assert-is-nonnegative-integer": "^0.2.0",
+    "@stdlib/math-base-special-pow": "^0.2.0",
+    "@stdlib/utils-constant-function": "^0.2.0",
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0"
   },
   "devDependencies": {
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/constants-float64-eps": "^0.0.x",
-    "@stdlib/constants-float64-pinf": "^0.0.x",
-    "@stdlib/math-base-special-abs": "^0.0.x",
-    "@stdlib/math-base-special-round": "^0.0.x",
-    "@stdlib/random-base-randu": "^0.0.x",
+    "@stdlib/constants-float64-eps": "^0.1.1",
+    "@stdlib/constants-float64-pinf": "^0.1.1",
+    "@stdlib/math-base-special-abs": "^0.1.1",
+    "@stdlib/math-base-special-round": "^0.1.1",
+    "@stdlib/random-base-randu": "^0.1.0",
     "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",
+    "@stdlib/bench-harness": "^0.2.0",
+    "@stdlib/bench": "^0.3.1"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -84,7 +85,7 @@
     "discrete"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/docs/repl.txt

@@ -1,64 +0,0 @@
-
-{{alias}}( x, p )
-    Evaluates the probability mass function (PMF) for a geometric distribution
-    with success probability `p` at a value `x`.
-
-    If provided `NaN` as any argument, the function returns `NaN`.
-
-    If `p < 0` or `p > 1`, the function returns `NaN`.
-
-    Parameters
-    ----------
-    x: number
-        Input value.
-
-    p: number
-        Success probability.
-
-    Returns
-    -------
-    out: number
-        Evaluated PMF.
-
-    Examples
-    --------
-    > var y = {{alias}}( 4.0, 0.3 )
-    ~0.072
-    > y = {{alias}}( 2.0, 0.7 )
-    ~0.063
-    > y = {{alias}}( -1.0, 0.5 )
-    0.0
-    > y = {{alias}}( 0.0, NaN )
-    NaN
-    > y = {{alias}}( NaN, 0.5 )
-    NaN
-    // Invalid success probability:
-    > y = {{alias}}( 2.0, 1.5 )
-    NaN
-
-
-{{alias}}.factory( p )
-    Returns a function for evaluating the probability mass function (PMF) of a
-    geometric distribution with success probability `p`.
-
-    Parameters
-    ----------
-    p: number
-        Success probability.
-
-    Returns
-    -------
-    pmf: Function
-        Probability mass function (PMF).
-
-    Examples
-    --------
-    > var mypmf = {{alias}}.factory( 0.5 );
-    > var y = mypmf( 3.0 )
-    0.0625
-    > y = mypmf( 1.0 )
-    0.25
-
-    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 pmf = require( './index' );
-
-
-// TESTS //
-
-// The function returns a number...
-{
-	pmf( 2, 0.4 ); // $ExpectType number
-	pmf( 1, 0.2 ); // $ExpectType number
-}
-
-// The compiler throws an error if the function is provided values other than two numbers...
-{
-	pmf( true, 0.3 ); // $ExpectError
-	pmf( false, 0.2 ); // $ExpectError
-	pmf( '5', 0.1 ); // $ExpectError
-	pmf( [], 0.1 ); // $ExpectError
-	pmf( {}, 0.4 ); // $ExpectError
-	pmf( ( x: number ): number => x, 0.2 ); // $ExpectError
-
-	pmf( 0, true ); // $ExpectError
-	pmf( 1, false ); // $ExpectError
-	pmf( 0, '5' ); // $ExpectError
-	pmf( 1, [] ); // $ExpectError
-	pmf( 2, {} ); // $ExpectError
-	pmf( 3, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an unsupported number of arguments...
-{
-	pmf(); // $ExpectError
-	pmf( 0 ); // $ExpectError
-	pmf( 1, 0.3, 4 ); // $ExpectError
-}
-
-// Attached to main export is a `factory` method which returns a function...
-{
-	pmf.factory( 0.4 ); // $ExpectType Unary
-}
-
-// The `factory` method returns a function which returns a number...
-{
-	const fcn = pmf.factory( 0.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 = pmf.factory( 0.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 = pmf.factory( 0.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...
-{
-	pmf.factory( true ); // $ExpectError
-	pmf.factory( false ); // $ExpectError
-	pmf.factory( '5' ); // $ExpectError
-	pmf.factory( [] ); // $ExpectError
-	pmf.factory( {} ); // $ExpectError
-	pmf.factory( ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
-{
-	pmf.factory( 0, 0.2 ); // $ExpectError
-	pmf.factory( 0, 0.4, 8 ); // $ExpectError
-}