Skip to content

Commit 455bd11

Browse files
feat: add C implementation base/dists/hypergeometric/cdf
1 parent 77c2bfd commit 455bd11

File tree

18 files changed

+1675
-42
lines changed

18 files changed

+1675
-42
lines changed

lib/node_modules/@stdlib/stats/base/dists/hypergeometric/cdf/README.md

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,108 @@ for ( i = 0; i < 10; i++ ) {
157157

158158
<!-- /.examples -->
159159

160+
<!-- C interface documentation. -->
161+
162+
* * *
163+
164+
<section class="c">
165+
166+
## C APIs
167+
168+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
169+
170+
<section class="intro">
171+
172+
</section>
173+
174+
<!-- /.intro -->
175+
176+
<!-- C usage documentation. -->
177+
178+
<section class="usage">
179+
180+
### Usage
181+
182+
```c
183+
#include "stdlib/stats/base/dists/hypergeometric/cdf.h"
184+
```
185+
186+
#### stdlib_base_dists_hypergeometric_cdf( x, N, K, n )
187+
188+
Evaluates the [probability mass function][cdf] (cdf) for a [hypergeometric][hypergeometric-distribution] distribution with parameters `N` (population size), `K` (subpopulation size), and `n` (number of draws).
189+
190+
```c
191+
double out = stdlib_base_dists_hypergeometric_cdf( 1.0, 8, 4, 2 );
192+
// returns ~0.786
193+
```
194+
195+
The function accepts the following arguments:
196+
197+
- **x**: `[in] double` input value.
198+
- **N**: `[in] int32_t` population size.
199+
- **K**: `[in] int32_t` subpopulation size.
200+
- **n**: `[in] int32_t` number of draws.
201+
202+
```c
203+
double stdlib_base_dists_hypergeometric_cdf( const double x, const int32_t N, const int32_t K, const int32_t n );
204+
```
205+
206+
</section>
207+
208+
<!-- /.usage -->
209+
210+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
211+
212+
<section class="notes">
213+
214+
</section>
215+
216+
<!-- /.notes -->
217+
218+
<!-- C API usage examples. -->
219+
220+
<section class="examples">
221+
222+
### Examples
223+
224+
```c
225+
#include "stdlib/stats/base/dists/hypergeometric/cdf.h"
226+
#include "stdlib/math/base/special/round.h"
227+
#include <stdlib.h>
228+
#include <stdint.h>
229+
#include <stdio.h>
230+
231+
static double random_uniform( const double min, const double max ) {
232+
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
233+
return min + ( v * ( max - min ) );
234+
}
235+
236+
int main( void ) {
237+
int32_t N;
238+
int32_t K;
239+
int32_t n;
240+
double x;
241+
double y;
242+
int i;
243+
for ( i = 0; i < 10; i++ ) {
244+
x = stdlib_base_round( random_uniform( 0.0, 5.0 ) );
245+
N = stdlib_base_round( random_uniform( 0.0, 20.0 ) );
246+
K = stdlib_base_round( random_uniform( 0.0, N ) );
247+
n = stdlib_base_round( random_uniform( 0.0, N ) );
248+
y = stdlib_base_dists_hypergeometric_cdf( x, N, K, n );
249+
printf( "x: %lf, N: %d, K: %d, n: %d, P(X=x;N,K,n): %lf\n", x, N, K, n, y );
250+
}
251+
}
252+
```
253+
254+
</section>
255+
256+
<!-- /.examples -->
257+
258+
</section>
259+
260+
<!-- /.c -->
261+
160262
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
161263

162264
<section class="related">
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
/**
2+
* @license Apache-2.0
3+
*
4+
* Copyright (c) 2025 The Stdlib Authors.
5+
*
6+
* Licensed under the Apache License, Version 2.0 (the "License");
7+
* you may not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing, software
13+
* distributed under the License is distributed on an "AS IS" BASIS,
14+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15+
* See the License for the specific language governing permissions and
16+
* limitations under the License.
17+
*/
18+
19+
'use strict';
20+
21+
// MODULES //
22+
23+
var resolve = require( 'path' ).resolve;
24+
var bench = require( '@stdlib/bench' );
25+
var Float64Array = require( '@stdlib/array/float64' );
26+
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
27+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
28+
var tryRequire = require( '@stdlib/utils/try-require' );
29+
var pkg = require( './../package.json' ).name;
30+
31+
32+
// VARIABLES //
33+
34+
var cdf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
35+
var opts = {
36+
'skip': ( cdf instanceof Error )
37+
};
38+
39+
40+
// MAIN //
41+
42+
bench( pkg+'::native', opts, function benchmark( b ) {
43+
var len;
44+
var N;
45+
var K;
46+
var n;
47+
var x;
48+
var y;
49+
var i;
50+
51+
len = 100;
52+
N = new Float64Array( len );
53+
K = new Float64Array( len );
54+
n = new Float64Array( len );
55+
x = new Float64Array( len );
56+
for ( i = 0; i < len; i++ ) {
57+
x[ i ] = discreteUniform( 1, 10 );
58+
N[ i ] = discreteUniform( 1, 100 );
59+
K[ i ] = discreteUniform( 1, N[ i ] );
60+
n[ i ] = discreteUniform( 1, N[ i ] );
61+
}
62+
63+
b.tic();
64+
for ( i = 0; i < b.iterations; i++ ) {
65+
y = cdf( x[ i%len ], N[ i%len ], K[ i%len ], n[ i%len ] );
66+
if ( isnan( y ) ) {
67+
b.fail( 'should not return NaN' );
68+
}
69+
}
70+
b.toc();
71+
if ( isnan( y ) ) {
72+
b.fail( 'should not return NaN' );
73+
}
74+
b.pass( 'benchmark finished' );
75+
b.end();
76+
});

0 commit comments

Comments
 (0)