@stdlib/stats-base-dists-geometric-cdf
v0.3.1TypeScript
Geometric distribution cumulative distribution function (CDF).
stdlibstdmathstatisticsstatsdistributiondistprobabilitycdfcumulative distributiondistribution function
183/weekUpdated yesterdayApache-2.0Unpacked: 58.6 KB
Published by The Stdlib Authors
npm install @stdlib/stats-base-dists-geometric-cdfWe 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. 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. 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. To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
About stdlib...
Cumulative Distribution Function
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> [Geometric][geometric-distribution] distribution [cumulative distribution function][cdf].
The [cumulative distribution function][cdf] for a [geometric][geometric-distribution] random variable is
where 0 <= p <= 1 is the success probability. x denotes the number of _failures_ before the first success.
Installation
``bash`
npm install @stdlib/stats-base-dists-geometric-cdf
Usage
`javascript`
var cdf = require( '@stdlib/stats-base-dists-geometric-cdf' );
#### cdf( x, p )
Evaluates the [cumulative distribution function][cdf] for a [geometric][geometric-distribution] distribution with success probability p.
`javascript
var y = cdf( 2.0, 0.5 );
// returns 0.875
y = cdf( 2.0, 0.1 );
// returns ~0.271
`
If provided NaN as any argument, the function returns NaN.
`javascript
var y = cdf( NaN, 0.5 );
// returns NaN
y = cdf( 0.0, NaN );
// returns NaN
`
If provided a success probability p outside of [0,1], the function returns NaN.
`javascript
var y = cdf( 2.0, -1.0 );
// returns NaN
y = cdf( 2.0, 1.5 );
// returns NaN
`
#### cdf.factory( p )
Returns a function for evaluating the [cumulative distribution function][cdf] of a [geometric][geometric-distribution] distribution with success probability p
`javascript
var mycdf = cdf.factory( 0.5 );
var y = mycdf( 3.0 );
// returns 0.9375
y = mycdf( 1.0 );
// returns 0.75
`
Examples
`javascript
var uniform = require( '@stdlib/random-array-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var cdf = require( '@stdlib/stats-base-dists-geometric-cdf' );
var opts = {
'dtype': 'float64'
};
var p = uniform( 10, 0.0, 1.0, opts );
var x = uniform( 10, 0.0, 5.0, opts );
logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, cdf );
`
*
C APIs
$3
`c`
#include "stdlib/stats/base/dists/geometric/cdf.h"
#### stdlib_base_dists_geometric_cdf( x, p )
Evaluates the [cumulative distribution function][cdf] of a [geometric][geometric-distribution] distribution with success probability p.
`c`
double out = stdlib_base_dists_geometric_cdf( 2.0, 0.5 );
// returns 0.875
The function accepts the following arguments:
- x: [in] double input value.[in] double
- p: probability of success.
`c`
double stdlib_base_dists_geometric_cdf( const double x, const double p );
$3
`c
#include "stdlib/stats/base/dists/geometric/cdf.h"
#include
#include
#include
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 = random_uniform( 0.0, 40.0 );
p = random_uniform( 0.0, 1.0 );
y = stdlib_base_dists_geometric_cdf( x, p );
printf( "x: %lf, p: %lf, F(x;p): %lf\n", x, p, y );
}
}
`
*
Notice
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
License
See [LICENSE][stdlib-license].
Copyright
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/stats-base-dists-geometric-cdf.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-geometric-cdf
[test-image]: https://github.com/stdlib-js/stats-base-dists-geometric-cdf/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/stats-base-dists-geometric-cdf/actions/workflows/test.yml?query=branch:v0.3.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-geometric-cdf/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-geometric-cdf?branch=main
[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
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/stats-base-dists-geometric-cdf/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-geometric-cdf/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-base-dists-geometric-cdf/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-geometric-cdf/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-base-dists-geometric-cdf/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-geometric-cdf/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-base-dists-geometric-cdf/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-geometric-cdf/main/LICENSE
[cdf]: https://en.wikipedia.org/wiki/Cumulative_distribution_function
[geometric-distribution]: https://en.wikipedia.org/wiki/Geometric_distribution