@stdlib/stats-base-dists-degenerate-logcdf
v0.3.1TypeScript
Degenerate distribution logarithm of cumulative distribution function (logCDF).
2.1K/weekUpdated 3 days agoApache-2.0Unpacked: 50.8 KB
Published by The Stdlib Authors
npm install @stdlib/stats-base-dists-degenerate-logcdfWe 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...
Logarithm of Cumulative Distribution Function
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> [Degenerate distribution][degenerate-distribution] logarithm of [cumulative distribution function][cdf].
The [cumulative distribution function][cdf] for a [degenerate][degenerate-distribution] random variable is
where µ is the constant value of the distribution.
Installation
``bash`
npm install @stdlib/stats-base-dists-degenerate-logcdf
Usage
`javascript`
var logcdf = require( '@stdlib/stats-base-dists-degenerate-logcdf' );
#### logcdf( x, mu )
Evaluates the natural logarithm of the [CDF][cdf] of a [degenerate distribution][degenerate-distribution] centered at mu.
`javascript
var y = logcdf( 2.0, 8.0 );
// returns -Infinity
y = logcdf( 8.0, 8.0 );
// returns 0.0
y = logcdf( 10.0, 8.0 );
// returns 0.0
`
#### logcdf.factory( mu )
Returns a function for evaluating the natural logarithm of the [cumulative distribution function][cdf] of a [degenerate distribution][degenerate-distribution] centered at mu.
`javascript
var mylogcdf = logcdf.factory( 10.0 );
var y = mylogcdf( 10.0 );
// returns 0.0
y = mylogcdf( 8.0 );
// returns -Infinity
`
Examples
`javascript
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var logEachMap = require( '@stdlib/console-log-each-map' );
var logcdf = require( '@stdlib/stats-base-dists-degenerate-logcdf' );
var opts = {
'dtype': 'float64'
};
var x = discreteUniform( 10, 0, 10, opts );
var mu = discreteUniform( 10, 0, 10, opts );
logEachMap( 'x: %d, µ: %d, ln(F(x;µ)): %0.4f', x, mu, logcdf );
`
*
C APIs
$3
`c`
#include "stdlib/stats/base/dists/degenerate/logcdf.h"
#### stdlib_base_dists_degenerate_logcdf( x, mu )
Evaluates the natural logarithm of the [CDF][cdf] of a [degenerate distribution][degenerate-distribution] centered at mu.
`c`
double y = stdlib_base_dists_degenerate_logcdf( 2.0, 3.0 );
// returns -Infinity
The function accepts the following arguments:
- x: [in] double input value.[in] double
- mu: constant value of distribution.
`c`
double stdlib_base_dists_degenerate_logcdf( const double x, const double mu );
$3
`c
#include "stdlib/stats/base/dists/degenerate/logcdf.h"
#include "stdlib/math/base/special/round.h"
#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 mu;
double x;
double y;
int i;
for ( i = 0; i < 10; i++ ) {
x = stdlib_base_round( random_uniform( 0.0, 10.0 ) );
mu = stdlib_base_round( random_uniform( 0.0, 10.0 ) );
y = stdlib_base_dists_degenerate_logcdf( x, mu );
printf( "x: %lf, µ: %lf, ln(F(x;µ)): %lf\n", x, mu, 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-degenerate-logcdf.svg
[npm-url]: https://npmjs.org/package/@stdlib/stats-base-dists-degenerate-logcdf
[test-image]: https://github.com/stdlib-js/stats-base-dists-degenerate-logcdf/actions/workflows/test.yml/badge.svg?branch=v0.3.1
[test-url]: https://github.com/stdlib-js/stats-base-dists-degenerate-logcdf/actions/workflows/test.yml?query=branch:v0.3.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/stats-base-dists-degenerate-logcdf/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/stats-base-dists-degenerate-logcdf?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-degenerate-logcdf/tree/deno
[deno-readme]: https://github.com/stdlib-js/stats-base-dists-degenerate-logcdf/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/stats-base-dists-degenerate-logcdf/tree/umd
[umd-readme]: https://github.com/stdlib-js/stats-base-dists-degenerate-logcdf/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/stats-base-dists-degenerate-logcdf/tree/esm
[esm-readme]: https://github.com/stdlib-js/stats-base-dists-degenerate-logcdf/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/stats-base-dists-degenerate-logcdf/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/stats-base-dists-degenerate-logcdf/main/LICENSE
[cdf]: https://en.wikipedia.org/wiki/Cumulative_distribution_function
[degenerate-distribution]: https://en.wikipedia.org/wiki/Degenerate_distribution