@stdlib/stats-base-dists-geometric-logpmf 0.0.7 → 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>
+
 # Logarithm of 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] -->
@@ -185,7 +196,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>
 
@@ -198,8 +209,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-geometric-logpmf.svg
 [npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-geometric-logpmf
 
-[test-image]: https://github.com/stdlib-js/stats-base-dists-geometric-logpmf/actions/workflows/test.yml/badge.svg?branch=v0.0.7
-[test-url]: https://github.com/stdlib-js/stats-base-dists-geometric-logpmf/actions/workflows/test.yml?query=branch:v0.0.7
+[test-image]: https://github.com/stdlib-js/stats-base-dists-geometric-logpmf/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/stats-base-dists-geometric-logpmf/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-geometric-logpmf/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-geometric-logpmf?branch=main
@@ -212,7 +223,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 logPMF from '../docs/types/index';
+export = logPMF;

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 N=n(function(h,v){
+var g=require('@stdlib/math-base-assert-is-nonnegative-integer/dist'),a=require('@stdlib/math-base-assert-is-nan/dist'),u=require('@stdlib/math-base-special-ln/dist'),l=require('@stdlib/constants-float64-ninf/dist');function y(e,r){var i;return a(e)||a(r)?NaN:r<0||r>1?NaN:g(e)?(i=1-r,u(r)+e*u(i)):l}v.exports=y
+});var q=n(function(j,f){
+var I=require('@stdlib/utils-constant-function/dist'),m=require('@stdlib/math-base-assert-is-nonnegative-integer/dist'),o=require('@stdlib/math-base-assert-is-nan/dist'),s=require('@stdlib/math-base-special-ln/dist'),F=require('@stdlib/constants-float64-ninf/dist');function d(e){if(o(e)||e<0||e>1)return I(NaN);return r;function r(i){var t;return o(i)?NaN:m(i)?(t=1-e,s(e)+i*s(t)):F}}f.exports=d
+});var O=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),c=N(),R=q();O(c,"factory",R);module.exports=c;
+/** @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 ln = require( '@stdlib/math-base-special-ln' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\n\n\n// MAIN //\n\n/**\n* Evaluates the logarithm of 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 {NonPositiveNumber} logarithm of PMF\n*\n* @example\n* var y = logpmf( 4.0, 0.3 );\n* // returns ~-2.631\n*\n* @example\n* var y = logpmf( 2.0, 0.7 );\n* // returns ~-2.765\n*\n* @example\n* var y = logpmf( -1.0, 0.5 );\n* // returns -Infinity\n*\n* @example\n* var y = logpmf( 0.0, NaN );\n* // returns NaN\n*\n* @example\n* var y = logpmf( NaN, 0.5 );\n* // returns NaN\n*\n* @example\n* // Invalid success probability:\n* var y = logpmf( 2.0, 1.5 );\n* // returns NaN\n*/\nfunction logpmf( x, p ) {\n\tvar q;\n\tif ( isnan( x ) || isnan( p ) ) {\n\t\treturn NaN;\n\t}\n\tif ( p < 0.0 || p > 1.0 ) {\n\t\treturn NaN;\n\t}\n\tif ( isNonNegativeInteger( x ) ) {\n\t\tq = 1.0 - p;\n\t\treturn ln( p ) + (x * ln( q ));\n\t}\n\treturn NINF;\n}\n\n\n// EXPORTS //\n\nmodule.exports = logpmf;\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 isNonNegativeInteger = require( '@stdlib/math-base-assert-is-nonnegative-integer' );\nvar isnan = require( '@stdlib/math-base-assert-is-nan' );\nvar ln = require( '@stdlib/math-base-special-ln' );\nvar NINF = require( '@stdlib/constants-float64-ninf' );\n\n\n// MAIN //\n\n/**\n* Returns a function for evaluating the logarithm of the probability mass function (PMF) for a geometric distribution with success probability `p`.\n*\n* @param {Probability} p - success probability\n* @returns {Function} logPMF\n*\n* @example\n* var logpmf = factory( 0.5 );\n* var y = logpmf( 3.0 );\n* // returns ~-2.773\n*\n* y = logpmf( 1.0 );\n* // returns ~-1.386\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 logpmf;\n\n\t/**\n\t* Evaluates the logarithm of the probability mass function (PMF) for a geometric distribution.\n\t*\n\t* @private\n\t* @param {number} x - input value\n\t* @returns {NonPositiveNumber} evaluated logPMF\n\t*\n\t* @example\n\t* var y = logpmf( 2.0 );\n\t* // returns <number>\n\t*/\n\tfunction logpmf( 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 ln( p ) + (x * ln( q ));\n\t\t}\n\t\treturn NINF;\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 logarithm of probability mass function (PMF).\n*\n* @module @stdlib/stats-base-dists-geometric-logpmf\n*\n* @example\n* var logpmf = require( '@stdlib/stats-base-dists-geometric-logpmf' );\n*\n* var y = logpmf( 4.0, 0.3 );\n* // returns ~-2.631\n*\n* y = logpmf( 2.0, 0.7 );\n* // returns ~-2.765\n*\n* var mylogpmf = logpmf.factory( 0.5 );\n* y = mylogpmf( 3.0 );\n* // returns ~-2.773\n*\n* y = mylogpmf( 1.0 );\n* // returns ~-1.386\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,EAAK,QAAS,8BAA+B,EAC7CC,EAAO,QAAS,gCAAiC,EAqCrD,SAASC,EAAQC,EAAGC,EAAI,CACvB,IAAIC,EACJ,OAAKN,EAAOI,CAAE,GAAKJ,EAAOK,CAAE,EACpB,IAEHA,EAAI,GAAOA,EAAI,EACZ,IAEHN,EAAsBK,CAAE,GAC5BE,EAAI,EAAMD,EACHJ,EAAII,CAAE,EAAKD,EAAIH,EAAIK,CAAE,GAEtBJ,CACR,CAKAJ,EAAO,QAAUK,IChFjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAmB,QAAS,iCAAkC,EAC9DC,EAAuB,QAAS,iDAAkD,EAClFC,EAAQ,QAAS,iCAAkC,EACnDC,EAAK,QAAS,8BAA+B,EAC7CC,EAAO,QAAS,gCAAiC,EAmBrD,SAASC,EAASC,EAAI,CACrB,GACCJ,EAAOI,CAAE,GACTA,EAAI,GACJA,EAAI,EAEJ,OAAON,EAAkB,GAAI,EAE9B,OAAOO,EAaP,SAASA,EAAQC,EAAI,CACpB,IAAIC,EACJ,OAAKP,EAAOM,CAAE,EACN,IAEHP,EAAsBO,CAAE,GAC5BC,EAAI,EAAMH,EACHH,EAAIG,CAAE,EAAKE,EAAIL,EAAIM,CAAE,GAEtBL,CACR,CACD,CAKAL,EAAO,QAAUM,ICtCjB,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", "ln", "NINF", "logpmf", "x", "p", "q", "require_factory", "__commonJSMin", "exports", "module", "constantFunction", "isNonNegativeInteger", "isnan", "ln", "NINF", "factory", "p", "logpmf", "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 natural logarithm of the probability mass function (PMF) for a geometric distribution.

package/lib/index.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-geometric-logpmf",
-  "version": "0.0.7",
+  "version": "0.1.0",
   "description": "Geometric distribution logarithm of probability mass function (PMF).",
   "license": "Apache-2.0",
   "author": {
@@ -37,23 +37,23 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/constants-float64-ninf": "^0.0.x",
-    "@stdlib/math-base-assert-is-nan": "^0.0.x",
-    "@stdlib/math-base-assert-is-nonnegative-integer": "^0.0.x",
-    "@stdlib/math-base-special-ln": "^0.0.x",
-    "@stdlib/utils-constant-function": "^0.0.x",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
+    "@stdlib/constants-float64-ninf": "^0.1.0",
+    "@stdlib/math-base-assert-is-nan": "^0.1.0",
+    "@stdlib/math-base-assert-is-nonnegative-integer": "^0.1.0",
+    "@stdlib/math-base-special-ln": "^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-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/bench": "^0.1.0",
+    "@stdlib/constants-float64-eps": "^0.1.0",
+    "@stdlib/constants-float64-pinf": "^0.1.0",
+    "@stdlib/math-base-special-abs": "^0.0.6",
+    "@stdlib/math-base-special-round": "^0.1.0",
+    "@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",
@@ -87,7 +87,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 logarithm of 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 logPMF.
-
-    Examples
-    --------
-    > var y = {{alias}}( 4.0, 0.3 )
-    ~-2.631
-    > y = {{alias}}( 2.0, 0.7 )
-    ~-2.765
-    > y = {{alias}}( -1.0, 0.5 )
-    -Infinity
-    > 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 logarithm of the probability mass
-    function (PMF) of a geometric distribution with success probability `p`.
-
-    Parameters
-    ----------
-    p: number
-        Success probability.
-
-    Returns
-    -------
-    logpmf: Function
-        Logarithm of probability mass function (PMF).
-
-    Examples
-    --------
-    > var mylogpmf = {{alias}}.factory( 0.5 );
-    > var y = mylogpmf( 3.0 )
-    ~-2.773
-    > y = mylogpmf( 1.0 )
-    ~-1.386
-
-    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 logpmf = require( './index' );
-
-
-// TESTS //
-
-// The function returns a number...
-{
-	logpmf( 2, 0.4 ); // $ExpectType number
-	logpmf( 1, 0.2 ); // $ExpectType number
-}
-
-// The compiler throws an error if the function is provided values other than two numbers...
-{
-	logpmf( true, 0.3 ); // $ExpectError
-	logpmf( false, 0.2 ); // $ExpectError
-	logpmf( '5', 0.1 ); // $ExpectError
-	logpmf( [], 0.1 ); // $ExpectError
-	logpmf( {}, 0.4 ); // $ExpectError
-	logpmf( ( x: number ): number => x, 0.2 ); // $ExpectError
-
-	logpmf( 0, true ); // $ExpectError
-	logpmf( 1, false ); // $ExpectError
-	logpmf( 0, '5' ); // $ExpectError
-	logpmf( 1, [] ); // $ExpectError
-	logpmf( 2, {} ); // $ExpectError
-	logpmf( 3, ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the function is provided an unsupported number of arguments...
-{
-	logpmf(); // $ExpectError
-	logpmf( 0 ); // $ExpectError
-	logpmf( 1, 0.3, 4 ); // $ExpectError
-}
-
-// Attached to main export is a `factory` method which returns a function...
-{
-	logpmf.factory( 0.4 ); // $ExpectType Unary
-}
-
-// The `factory` method returns a function which returns a number...
-{
-	const fcn = logpmf.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 = logpmf.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 = logpmf.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...
-{
-	logpmf.factory( true ); // $ExpectError
-	logpmf.factory( false ); // $ExpectError
-	logpmf.factory( '5' ); // $ExpectError
-	logpmf.factory( [] ); // $ExpectError
-	logpmf.factory( {} ); // $ExpectError
-	logpmf.factory( ( x: number ): number => x ); // $ExpectError
-}
-
-// The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
-{
-	logpmf.factory( 0, 0.2 ); // $ExpectError
-	logpmf.factory( 0, 0.4, 8 ); // $ExpectError
-}