Skip to content
Open
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
252 changes: 252 additions & 0 deletions lib/node_modules/@stdlib/stats/base/dists/anglit/cdf/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,252 @@
<!--

@license Apache-2.0

Copyright (c) 2026 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.

-->

# Cumulative Distribution Function

> [Anglit][anglit-distribution] distribution [cumulative distribution function][cdf].

<section class="intro">

The [cumulative distribution function][cdf] for an [anglit][anglit-distribution] random variable is

<!-- <equation class="equation" label="eq:anglit_cdf" align="center" raw="F(x) = \sin^2\left( \frac{x-\mu}{\sigma} + \frac{\pi}{4} \right)" alt="Cumulative distribution function for an anglit distribution."> -->

```math
F(x) = \sin^2\left( \frac{x-\mu}{\sigma} + \frac{\pi}{4} \right)
```

<!-- </equation> -->

where `μ` is the location parameter and `σ > 0` is the scale parameter.

</section>

<!-- /.intro -->

<section class="usage">

## Usage

```javascript
var cdf = require( '@stdlib/stats/base/dists/anglit/cdf' );
```

#### cdf( x, mu, sigma )

Evaluates the [cumulative distribution function][cdf] for an [anglit][anglit-distribution] distribution with location parameter `μ` and scale parameter `σ > 0`.

```javascript
var y = cdf( 0.0, 0.0, 1.0 );
// returns 0.5

y = cdf( 0.5, 0.0, 1.0 );
// returns ~0.921

y = cdf( 2.0, 0.0, 1.0 );
// returns 1.0

y = cdf( -2.0, 0.0, 1.0 );
// returns 0.0
```

If provided `NaN` as any argument, the function returns `NaN`.

```javascript
var y = cdf( NaN, 0.0, 1.0 );
// returns NaN

y = cdf( 0.0, NaN, 1.0 );
// returns NaN

y = cdf( 0.0, 0.0, NaN );
// returns NaN
```

If provided `σ <= 0`, the function returns `NaN`.

```javascript
var y = cdf( 0.0, 0.0, -1.0 );
// returns NaN

y = cdf( 0.0, 0.0, 0.0 );
// returns NaN
```

#### cdf.factory( mu, sigma )

Returns a `function` for evaluating the [CDF][cdf] of an [anglit][anglit-distribution] distribution with location parameter `μ` and scale parameter `σ`.

```javascript
var myCDF = cdf.factory( 0.0, 1.0 );

var y = myCDF( 0.0 );
// returns 0.5

y = myCDF( 2.0 );
// returns 1.0
```

</section>

<!-- /.usage -->

<section class="examples">

## Examples

<!-- eslint no-undef: "error" -->

```javascript
var uniform = require( '@stdlib/random/array/uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var cdf = require( '@stdlib/stats/base/dists/anglit/cdf' );

var opts = {
'dtype': 'float64'
};

var x = uniform( 10, -5.0, 5.0, opts );
var mu = uniform( x.length, -5.0, 5.0, opts );
var sigma = uniform( x.length, 0.5, 5.0, opts );

logEachMap( 'x: %lf, mu: %lf, σ: %lf, F(x;mu,σ): %lf', x, mu, sigma, cdf );
```

</section>

<!-- /.examples -->

<!-- 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/anglit/cdf.h"
```

#### stdlib_base_dists_anglit_cdf( x, mu, sigma )

Evaluates the cumulative distribution function (CDF) for an Anglit distribution with location parameter `mu` and scale parameter `sigma` at a value `x`.

```c
double out = stdlib_base_dists_anglit_cdf( 0.0, 0.0, 1.0 );
// returns 0.5
```

The function accepts the following arguments:

- **x**: `[in] double` input value.
- **mu**: `[in] double` location parameter.
- **sigma**: `[in] double` scale parameter.

```c
double stdlib_base_dists_anglit_cdf( const double x, const double mu, const double sigma );
```

</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/anglit/cdf.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 sigma;
double mu;
double x;
double y;
int i;

for ( i = 0; i < 25; i++ ) {
x = random_uniform( -10.0, 10.0 );
mu = random_uniform( -5.0, 5.0 );
sigma = random_uniform( 0.1, 5.0 );
y = stdlib_base_dists_anglit_cdf( x, mu, sigma );
printf( "x: %lf, mu: %lf, σ: %lf, F(x;mu,σ): %lf\n", x, mu, sigma, y );
}
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- 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">

[cdf]: https://en.wikipedia.org/wiki/Cumulative_distribution_function

[anglit-distribution]: https://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.anglit.html

</section>

<!-- /.links -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 uniform = require( '@stdlib/random/array/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var cdf = require( './../lib' );


// MAIN //

bench( pkg, function benchmark( b ) {
var sigma;
var opts;
var mu;
var x;
var y;
var i;

opts = {
'dtype': 'float64'
};
x = uniform( 100, -10.0, 10.0, opts );
mu = uniform( 100, -5.0, 5.0, opts );
sigma = uniform( 100, 0.1, 10.0, opts );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
y = cdf( x[ i % x.length ], mu[ i % mu.length ], sigma[ i % sigma.length ] );

Check warning on line 50 in lib/node_modules/@stdlib/stats/base/dists/anglit/cdf/benchmark/benchmark.js

View workflow job for this annotation

GitHub Actions / Lint Changed Files

This line has a length of 85. Maximum allowed is 80
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( format( '%s::factory', pkg ), function benchmark( b ) {
var mycdf;
var sigma;
var opts;
var mu;
var x;
var y;
var i;

opts = {
'dtype': 'float64'
};
mu = 0.0;
sigma = 2.0;
mycdf = cdf.factory( mu, sigma );
x = uniform( 100, -5.0, 5.0, opts );

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
y = mycdf( x[ i % x.length ] );
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();
});
Loading