Skip to content

Commit e7b3a48

Browse files
PlaneshifterPlaneshifter
committed
feat: add C implementation for gamma CDF
Closes: #3617 --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent b7f644e commit e7b3a48

File tree

16 files changed

+1225
-0
lines changed

16 files changed

+1225
-0
lines changed

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

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,93 @@ y = mycdf( 8.0 );
132132

133133
<!-- /.usage -->
134134

135+
* * *
136+
137+
<section class="c">
138+
139+
## C APIs
140+
141+
<section class="intro">
142+
143+
</section>
144+
145+
<!-- /.intro -->
146+
147+
<section class="usage">
148+
149+
### Usage
150+
151+
```c
152+
#include "stdlib/stats/base/dists/gamma/cdf.h"
153+
```
154+
155+
#### stdlib_base_dists_gamma_cdf( x, alpha, beta )
156+
157+
Evaluates the [cumulative distribution function][cdf] (CDF) for a [gamma][gamma-distribution] distribution with parameters `alpha` (shape parameter) and `beta` (rate parameter).
158+
159+
```c
160+
double out = stdlib_base_dists_gamma_cdf( 2.0, 1.0, 1.0 );
161+
// returns ~0.865
162+
163+
out = stdlib_base_dists_gamma_cdf( 2.0, 3.0, 1.0 );
164+
// returns ~0.323
165+
```
166+
167+
The function accepts the following arguments:
168+
169+
- **x**: `[in] double` input value.
170+
- **alpha**: `[in] double` shape parameter.
171+
- **beta**: `[in] double` rate parameter.
172+
173+
```c
174+
double stdlib_base_dists_gamma_cdf( const double x, const double alpha, const double beta );
175+
```
176+
177+
</section>
178+
179+
<!-- /.usage -->
180+
181+
<section class="examples">
182+
183+
### Examples
184+
185+
```c
186+
#include "stdlib/stats/base/dists/gamma/cdf.h"
187+
#include <stdlib.h>
188+
#include <stdio.h>
189+
190+
static double random_uniform( double min, double max ) {
191+
double scale = rand() / (double) RAND_MAX;
192+
return min + ( scale * ( max - min ) );
193+
}
194+
195+
int main( void ) {
196+
double x;
197+
double alpha;
198+
double beta;
199+
double y;
200+
int i;
201+
202+
for ( i = 0; i < 25; i++ ) {
203+
x = random_uniform( 0.0, 3.0 );
204+
alpha = random_uniform( 0.1, 5.0 );
205+
beta = random_uniform( 0.1, 5.0 );
206+
y = stdlib_base_dists_gamma_cdf( x, alpha, beta );
207+
printf( "x: %lf, α: %lf, β: %lf, F(x;α,β): %lf\n", x, alpha, beta, y );
208+
}
209+
}
210+
```
211+
212+
</section>
213+
214+
<!-- /.examples -->
215+
216+
</section>
217+
218+
<!-- /.c -->
219+
220+
* * *
221+
135222
<section class="examples">
136223

137224
## Examples

‎lib/node_modules/@stdlib/stats/base/dists/gamma/cdf/benchmark/benchmark.native.js

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
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 uniform = require( '@stdlib/random/array/uniform' );
26+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
27+
var tryRequire = require( '@stdlib/utils/try-require' );
28+
var pkg = require( './../package.json' ).name;
29+
30+
31+
// VARIABLES //
32+
33+
var cdf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
34+
var opts = {
35+
'skip': ( cdf instanceof Error )
36+
};
37+
38+
39+
// MAIN //
40+
41+
bench( pkg + '::native', opts, function benchmark( b ) {
42+
var alpha;
43+
var beta;
44+
var x;
45+
var y;
46+
var i;
47+
48+
x = uniform( 100, 0.0, 2.0, {
49+
'dtype': 'float64'
50+
});
51+
alpha = uniform( 100, 1.0, 10.0, {
52+
'dtype': 'float64'
53+
});
54+
beta = uniform( 100, 1.0, 10.0, {
55+
'dtype': 'float64'
56+
});
57+
58+
b.tic();
59+
for ( i = 0; i < b.iterations; i++ ) {
60+
y = cdf( x[ i % x.length ], alpha[ i % alpha.length ], beta[ i % beta.length ] );
61+
if ( isnan( y ) ) {
62+
b.fail( 'should not return NaN' );
63+
}
64+
}
65+
b.toc();
66+
if ( isnan( y ) ) {
67+
b.fail( 'should not return NaN' );
68+
}
69+
b.pass( 'benchmark finished' );
70+
b.end();
71+
});

‎lib/node_modules/@stdlib/stats/base/dists/gamma/cdf/benchmark/c/Makefile

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
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+
# VARIABLES #
20+
21+
ifndef VERBOSE
22+
QUIET := @
23+
else
24+
QUIET :=
25+
endif
26+
27+
# Determine the OS ([1][1], [2][2]).
28+
#
29+
# [1]: https://en.wikipedia.org/wiki/Uname#Examples
30+
# [2]: http://stackoverflow.com/a/27776822/2225624
31+
OS ?= $(shell uname)
32+
ifneq (, $(findstring MINGW,$(OS)))
33+
OS := WINNT
34+
else
35+
ifneq (, $(findstring MSYS,$(OS)))
36+
OS := WINNT
37+
else
38+
ifneq (, $(findstring CYGWIN,$(OS)))
39+
OS := WINNT
40+
else
41+
ifneq (, $(findstring Windows_NT,$(OS)))
42+
OS := WINNT
43+
endif
44+
endif
45+
endif
46+
endif
47+
48+
49+
# RULES #
50+
51+
#/
52+
# Removes generated files.
53+
#
54+
# @example
55+
# make clean
56+
#/
57+
clean:
58+
$(QUIET) -rm -f *.o *.node
59+
60+
.PHONY: clean

‎lib/node_modules/@stdlib/stats/base/dists/gamma/cdf/benchmark/c/benchmark.c

Lines changed: 142 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,142 @@
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+
#include "stdlib/stats/base/dists/gamma/cdf.h"
20+
#include <stdlib.h>
21+
#include <stdio.h>
22+
#include <math.h>
23+
#include <time.h>
24+
#include <sys/time.h>
25+
26+
#define NAME "gamma-cdf"
27+
#define ITERATIONS 1000000
28+
#define REPEATS 3
29+
30+
/**
31+
* Prints the TAP version.
32+
*/
33+
static void print_version( void ) {
34+
printf( "TAP version 13\n" );
35+
}
36+
37+
/**
38+
* Prints the TAP summary.
39+
*
40+
* @param total total number of tests
41+
* @param passing total number of passing tests
42+
*/
43+
static void print_summary( int total, int passing ) {
44+
printf( "#\n" );
45+
printf( "1..%d\n", total ); // TAP plan
46+
printf( "# total %d\n", total );
47+
printf( "# pass %d\n", passing );
48+
printf( "#\n" );
49+
printf( "# ok\n" );
50+
}
51+
52+
/**
53+
* Prints benchmarks results.
54+
*
55+
* @param elapsed elapsed time in seconds
56+
*/
57+
static void print_results( double elapsed ) {
58+
double rate = (double)ITERATIONS / elapsed;
59+
printf( " ---\n" );
60+
printf( " iterations: %d\n", ITERATIONS );
61+
printf( " elapsed: %0.9f\n", elapsed );
62+
printf( " rate: %0.9f\n", rate );
63+
printf( " ...\n" );
64+
}
65+
66+
/**
67+
* Returns a clock time.
68+
*
69+
* @return clock time
70+
*/
71+
static double tic( void ) {
72+
struct timeval now;
73+
gettimeofday( &now, NULL );
74+
return (double)now.tv_sec + (double)now.tv_usec / 1.0e6;
75+
}
76+
77+
/**
78+
* Generates a random number on the interval [min,max).
79+
*
80+
* @param min minimum value (inclusive)
81+
* @param max maximum value (exclusive)
82+
* @return random number
83+
*/
84+
static double random_uniform( const double min, const double max ) {
85+
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
86+
return min + ( v * ( max - min ) );
87+
}
88+
89+
/**
90+
* Runs a benchmark.
91+
*
92+
* @return elapsed time in seconds
93+
*/
94+
static double benchmark( void ) {
95+
double elapsed;
96+
double alpha[ 100 ];
97+
double beta[ 100 ];
98+
double x[ 100 ];
99+
double y;
100+
double t;
101+
int i;
102+
103+
for ( i = 0; i < 100; i++ ) {
104+
alpha[ i ] = random_uniform( 1.0, 10.0 );
105+
beta[ i ] = random_uniform( 1.0, 10.0 );
106+
x[ i ] = random_uniform( 0.0, 2.0 );
107+
}
108+
109+
t = tic();
110+
for ( i = 0; i < ITERATIONS; i++ ) {
111+
y = stdlib_base_dists_gamma_cdf( x[ i % 100 ], alpha[ i % 100 ], beta[ i % 100 ] );
112+
if ( y != y ) {
113+
printf( "should not return NaN\n" );
114+
break;
115+
}
116+
}
117+
elapsed = tic() - t;
118+
if ( y != y ) {
119+
printf( "should not return NaN\n" );
120+
}
121+
return elapsed;
122+
}
123+
124+
/**
125+
* Main execution sequence.
126+
*/
127+
int main( void ) {
128+
double elapsed;
129+
int i;
130+
131+
// Use the current time to seed the random number generator:
132+
srand( time( NULL ) );
133+
134+
print_version();
135+
for ( i = 0; i < REPEATS; i++ ) {
136+
printf( "# c::%s\n", NAME );
137+
elapsed = benchmark();
138+
print_results( elapsed );
139+
printf( "ok %d benchmark finished\n", i + 1 );
140+
}
141+
print_summary( REPEATS, REPEATS );
142+
}

0 commit comments

Comments
 (0)