feat: add stats/base/dists/planck/pmf

lib/node_modules/@stdlib/stats/base/dists/planck/lib/index.js

@@ -0,0 +1,51 @@
+/**
+* @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';
+
+/*
+* When adding modules to the namespace, ensure that they are added in alphabetical order according to module name.
+*/
+
+// MODULES //
+
+var setReadOnly = require( '@stdlib/utils/define-read-only-property' );
+
+
+// MAIN //
+
+/**
+* Top-level namespace.
+*
+* @namespace planck
+*/
+var planck = {};
+
+/**
+* @name pmf
+* @memberof planck
+* @readonly
+* @type {Function}
+* @see {@link module:@stdlib/stats/base/dists/planck/pmf}
+*/
+setReadOnly( planck, 'pmf', require( '@stdlib/stats/base/dists/planck/pmf' ) );
+
+
+// EXPORTS //
+
+module.exports = planck;

lib/node_modules/@stdlib/stats/base/dists/planck/pmf/README.md

@@ -0,0 +1,144 @@
+<!--
+
+@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.
+
+-->
+
+# Probability Mass Function
+
+> Planck distribution [probability mass function][pmf] (PMF).
+
+<section class="intro">
+
+The [probability mass function][pmf] (PMF) for a planck random variable is defined as
+
+<!-- <equation class="equation" label="eq:planck_pmf" align="center" raw="\Pr(X = x, \lambda) = \begin{cases}(1 - e^{-\lambda})e^{-\lambda x} & \text{for } x = 0, 1, 2, \ldots \\ 0 & \text{otherwise} \end{cases}" alt="Probability mass function (PMF) for a Planck distribution."> -->
+
+```math
+\Pr(X = x, \lambda) = \begin{cases}(1 - e^{-\lambda})e^{-\lambda x} & \text{for } x = 0, 1, 2, \ldots \\ 0 & \text{otherwise} \end{cases}
+```
+
+<!-- </equation> -->
+
+where `lambda > 0` is the shape parameter. The random variable `X` denotes the count of events in a quantized system.
+
+</section>
+
+<!-- /.intro -->
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var pmf = require( '@stdlib/stats/base/dists/planck/pmf' );
+```
+
+#### pmf( x, p )
+
+Evaluates the [probability mass function][pmf] (PMF) of a planck distribution with shape parameter `lambda`.
+
+```javascript
+var y = pmf( 4.0, 0.3 );
+// returns ~0.0781
+
+y = pmf( 2.0, 1.7 );
+// returns ~0.0273
+
+y = pmf( -1.0, 2.5 );
+// returns 0.0
+```
+
+If provided `NaN` as any argument, the function returns `NaN`.
+
+```javascript
+var y = pmf( NaN, 0.0 );
+// returns NaN
+
+y = pmf( 0.0, NaN );
+// returns NaN
+```
+
+If provided a shape parameter `lambda` which is negative number, the function returns `NaN`.
+
+```javascript
+var y = pmf( 2.0, -1.0 );
+// returns NaN
+```
+
+#### pmf.factory( p )
+
+Returns a function for evaluating the [probability mass function][pmf] (PMF) of a planck distribution with shape parameter `lambda`.
+
+```javascript
+var mypmf = pmf.factory( 0.5 );
+var y = mypmf( 3.0 );
+// returns ~0.0878
+
+y = mypmf( 1.0 );
+// returns ~0.2387
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var randu = require( '@stdlib/random/base/randu' );
+var round = require( '@stdlib/math/base/special/round' );
+var pmf = require( '@stdlib/stats/base/dists/planck/pmf' );
+
+var lambda;
+var x;
+var y;
+var i;
+
+for ( i = 0; i < 10; i++ ) {
+    x = round( randu() * 5.0 );
+    lambda = randu();
+    y = pmf( x, lambda );
+    console.log( 'x: %d, lambda: %d, P( X = x; lambda ): %d', x, lambda.toFixed( 4 ), y.toFixed( 4 ) );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[pmf]: https://en.wikipedia.org/wiki/Probability_mass_function
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/stats/base/dists/planck/pmf/benchmark/benchmark.js

@@ -0,0 +1,81 @@
+/**
+* @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 bench = require( '@stdlib/bench' );
+var randu = require( '@stdlib/random/base/randu' );
+var round = require( '@stdlib/math/base/special/round' );
+var isnan = require( '@stdlib/math/base/assert/is-nan' );
+var EPS = require( '@stdlib/constants/float64/eps' );
+var pkg = require( './../package.json' ).name;
+var pmf = require( './../lib' );
+
+
+// MAIN //
+
+bench( pkg, function benchmark( b ) {
+	var lambda;
+	var x;
+	var y;
+	var i;
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		x = round( randu()*40.0 );
+		lambda = ( randu()*1.0 ) + EPS;
+		y = pmf( x, lambda );
+		if ( isnan( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});
+
+bench( pkg+':factory', function benchmark( b ) {
+	var lambda;
+	var mypmf;
+	var x;
+	var y;
+	var i;
+
+	lambda = 0.3;
+	mypmf = pmf.factory( lambda );
+
+	b.tic();
+	for ( i = 0; i < b.iterations; i++ ) {
+		x = randu() * 40.0;
+		y = mypmf( x );
+		if ( isnan( y ) ) {
+			b.fail( 'should not return NaN' );
+		}
+	}
+	b.toc();
+	if ( isnan( y ) ) {
+		b.fail( 'should not return NaN' );
+	}
+	b.pass( 'benchmark finished' );
+	b.end();
+});

lib/node_modules/@stdlib/stats/base/dists/planck/pmf/docs/repl.txt

@@ -0,0 +1,63 @@
+
+{{alias}}( x, lambda )
+    Evaluates the probability mass function (PMF) for a planck distribution
+    with shape parameter `lambda` at a value `x`.
+
+    If provided `NaN` as any argument, the function returns `NaN`.
+
+    If `lambda < 0`, the function returns `NaN`.
+
+    Parameters
+    ----------
+    x: number
+        Input value.
+
+    lambda: number
+        Shape parameter.
+
+    Returns
+    -------
+    out: number
+        Evaluated PMF.
+
+    Examples
+    --------
+    > var y = {{alias}}( 4.0, 0.3 )
+    ~0.0781
+    > y = {{alias}}( 2.0, 1.7 )
+    ~0.0273
+    > y = {{alias}}( -1.0, 0.5 )
+    0.0
+    > y = {{alias}}( 0.0, NaN )
+    NaN
+    > y = {{alias}}( NaN, 0.5 )
+    NaN
+    // Invalid shape parameter:
+    > y = {{alias}}( 2.0, -1.0 )
+    NaN
+
+
+{{alias}}.factory( lambda )
+    Returns a function for evaluating the probability mass function (PMF) of a
+    planck distribution with shape parameter `lambda`.
+
+    Parameters
+    ----------
+    lambda: number
+        Shape parameter.
+
+    Returns
+    -------
+    pmf: Function
+        Probability mass function (PMF).
+
+    Examples
+    --------
+    > var mypmf = {{alias}}.factory( 0.5 );
+    > var y = mypmf( 3.0 )
+    ~0.0878
+    > y = mypmf( 1.0 )
+    ~0.2387
+
+    See Also
+    --------