@stdlib/stats-base-dists-geometric-pmf 0.2.2 → 0.3.0

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2024 The Stdlib Authors.
+Copyright (c) 2016-2026 The Stdlib Authors.

package/README.md

@@ -131,27 +131,120 @@ y = mypmf( 1.0 );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var randu = require( '@stdlib/random-base-randu' );
-var round = require( '@stdlib/math-base-special-round' );
+var uniform = require( '@stdlib/random-array-uniform' );
+var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
+var logEachMap = require( '@stdlib/console-log-each-map' );
 var pmf = require( '@stdlib/stats-base-dists-geometric-pmf' );
 
-var p;
-var x;
-var y;
-var i;
+var opts = {
+    'dtype': 'float64'
+};
+var x = discreteUniform( 10, 0, 5, opts );
+var p = uniform( 10, 0.0, 1.0, opts );
 
-for ( i = 0; i < 10; i++ ) {
-    x = round( randu() * 5.0 );
-    p = randu();
-    y = pmf( x, p );
-    console.log( 'x: %d, p: %d, P( X = x; p ): %d', x, p.toFixed( 4 ), y.toFixed( 4 ) );
-}
+logEachMap( 'x: %d, p: %0.4f, P( X = x; p ): %0.4f', x, p, pmf );
 ```
 
 </section>
 
 <!-- /.examples -->
 
+<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="references">
+
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/stats/base/dists/geometric/pmf.h"
+```
+
+#### stdlib_base_dists_geometric_pmf( x, p )
+
+Evaluates the [probability mass function][pmf] (PMF) of a [geometric][geometric-distribution] distribution with success probability `0 <= p <= 1`.
+
+```c
+double out = stdlib_base_dists_geometric_pmf( 4.0, 0.3 );
+// returns ~0.072
+```
+
+The function accepts the following arguments:
+
+-   **x**: `[in] double` input value.
+-   **p**: `[in] double` probability of success.
+
+```c
+double stdlib_base_dists_geometric_pmf( const double x, const double p );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/stats/base/dists/geometric/pmf.h"
+#include "stdlib/math/base/special/round.h"
+#include <stdlib.h>
+#include <stdio.h>
+
+static double random_uniform( const double min, const double max ) {
+    double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
+    return min + ( v*(max-min) );
+}
+
+int main( void ) {
+    double x;
+    double p;
+    double y;
+    int i;
+
+    for ( i = 0; i < 25; i++ ) {
+        x = stdlib_base_round( random_uniform( 0, 40 ) );
+        p = random_uniform( 0.0, 1.0 );
+        y = stdlib_base_dists_geometric_pmf( x, p );
+        printf( "x: %lf, p: %lf, P(X=x;p): %lf\n", x, p, y );
+    }
+}
+```
+
+</section>
+
+<!-- /.references -->
+
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
 <section class="related">
@@ -186,7 +279,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -199,8 +292,8 @@ Copyright &copy; 2016-2024. 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.2.2
-[test-url]: https://github.com/stdlib-js/stats-base-dists-geometric-pmf/actions/workflows/test.yml?query=branch:v0.2.2
+[test-image]: https://github.com/stdlib-js/stats-base-dists-geometric-pmf/actions/workflows/test.yml/badge.svg?branch=v0.3.0
+[test-url]: https://github.com/stdlib-js/stats-base-dists-geometric-pmf/actions/workflows/test.yml?query=branch:v0.3.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
@@ -212,8 +305,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 -->
 
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
+[chat-url]: https://stdlib.zulipchat.com
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 

package/include/stdlib/stats/base/dists/geometric/pmf.h

@@ -0,0 +1,38 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+*/
+
+#ifndef STDLIB_STATS_BASE_DISTS_GEOMETRIC_PMF_H
+#define STDLIB_STATS_BASE_DISTS_GEOMETRIC_PMF_H
+
+/*
+* If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler.
+*/
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+* Evaluates the probability mass function (PMF) for a geometric distribution with success probability `p` at a value `x`.
+*/
+double stdlib_base_dists_geometric_pmf( const double x, const double p );
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // !STDLIB_STATS_BASE_DISTS_GEOMETRIC_PMF_H

package/lib/native.js

@@ -0,0 +1,68 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var addon = require( './../src/addon.node' );
+
+
+// MAIN //
+
+/**
+* Evaluates the probability mass function (PMF) for a geometric distribution with success probability `p` at a value `x`.
+*
+* @private
+* @param {number} x - input value
+* @param {Probability} p - success probability
+* @returns {Probability} evaluated PMF
+*
+* @example
+* var y = pmf( 4.0, 0.3 );
+* // returns ~0.072
+*
+* @example
+* var y = pmf( 2.0, 0.7 );
+* // returns ~0.063
+*
+* @example
+* var y = pmf( -1.0, 0.5 );
+* // returns 0.0
+*
+* @example
+* var y = pmf( 0.0, NaN );
+* // returns NaN
+*
+* @example
+* var y = pmf( NaN, 0.5 );
+* // returns NaN
+*
+* @example
+* // Invalid success probability:
+* var y = pmf( 2.0, 1.5 );
+* // returns NaN
+*/
+function pmf( x, p ) {
+	return addon( x, p );
+}
+
+
+// EXPORTS //
+
+module.exports = pmf;

package/manifest.json

@@ -0,0 +1,84 @@
+{
+  "options": {
+    "task": "build",
+    "wasm": false
+  },
+  "fields": [
+    {
+      "field": "src",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "include",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "libraries",
+      "resolve": false,
+      "relative": false
+    },
+    {
+      "field": "libpath",
+      "resolve": true,
+      "relative": false
+    }
+  ],
+  "confs": [
+    {
+      "task": "build",
+      "wasm": false,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math-base-napi-binary",
+        "@stdlib/math-base-assert-is-nonnegative-integer",
+        "@stdlib/math-base-assert-is-nan",
+        "@stdlib/math-base-special-pow"
+      ]
+    },
+    {
+      "task": "benchmark",
+      "wasm": false,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math-base-assert-is-nonnegative-integer",
+        "@stdlib/math-base-assert-is-nan",
+        "@stdlib/math-base-special-pow",
+        "@stdlib/math-base-special-round"
+      ]
+    },
+    {
+      "task": "examples",
+      "wasm": false,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math-base-assert-is-nonnegative-integer",
+        "@stdlib/math-base-assert-is-nan",
+        "@stdlib/math-base-special-pow",
+        "@stdlib/math-base-special-round"
+      ]
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/stats-base-dists-geometric-pmf",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "description": "Geometric distribution probability mass function (PMF).",
   "license": "Apache-2.0",
   "author": {
@@ -14,9 +14,12 @@
     }
   ],
   "main": "./lib",
+  "gypfile": false,
   "directories": {
     "doc": "./docs",
+    "include": "./include",
     "lib": "./lib",
+    "src": "./src",
     "dist": "./dist"
   },
   "types": "./docs/types",
@@ -31,10 +34,12 @@
   },
   "dependencies": {
     "@stdlib/math-base-assert-is-nan": "^0.2.2",
-    "@stdlib/math-base-assert-is-nonnegative-integer": "^0.2.1",
+    "@stdlib/math-base-assert-is-nonnegative-integer": "^0.2.2",
+    "@stdlib/math-base-napi-binary": "^0.3.1",
     "@stdlib/math-base-special-pow": "^0.3.0",
     "@stdlib/utils-constant-function": "^0.2.2",
-    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2"
+    "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2",
+    "@stdlib/utils-library-manifest": "^0.2.3"
   },
   "devDependencies": {},
   "engines": {

package/src/addon.c

@@ -0,0 +1,22 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+*/
+
+#include "stdlib/stats/base/dists/geometric/pmf.h"
+#include "stdlib/math/base/napi/binary.h"
+
+STDLIB_MATH_BASE_NAPI_MODULE_DD_D( stdlib_base_dists_geometric_pmf )

package/src/main.c

@@ -0,0 +1,48 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 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.
+*/
+
+#include "stdlib/stats/base/dists/geometric/pmf.h"
+#include "stdlib/math/base/assert/is_nonnegative_integer.h"
+#include "stdlib/math/base/assert/is_nan.h"
+#include "stdlib/math/base/special/pow.h"
+
+/**
+* Returns the probability mass function of a geometric distribution.
+*
+* @param x   input value
+* @param p   success probability
+* @return    evaluated PMF
+*
+* @example
+* double y = stdlib_base_dists_geometric_pmf( 4.0, 0.3 );
+* // returns ~0.072
+*/
+double stdlib_base_dists_geometric_pmf( const double x, const double p ) {
+	if (
+		stdlib_base_is_nan( x ) ||
+		stdlib_base_is_nan( p ) ||
+		p < 0.0 ||
+		p > 1.0
+	) {
+		return 0.0/0.0; // NaN
+	}
+	if ( stdlib_base_is_nonnegative_integer( x ) ) {
+		return p * stdlib_base_pow( ( 1.0 - p ), x );
+	}
+	return 0.0;
+}