Skip to content

Commit 3eff83f

Browse files
Vinit-Panditstdlib-botPlaneshifter
authored
feat: add C implementation of stats/base/dists/gumbel/mgf
PR-URL: #4168 Closes: #3650 Ref: #3567 Signed-off-by: Vinit Pandit <[email protected]> Signed-off-by: Philipp Burckhardt <[email protected]> Co-authored-by: stdlib-bot <[email protected]> Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent 00b23b3 commit 3eff83f

File tree

17 files changed

+1327
-1
lines changed

17 files changed

+1327
-1
lines changed

‎lib/node_modules/@stdlib/stats/base/dists/gumbel/mgf/README.md

+99
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,105 @@ for ( i = 0; i < 10; i++ ) {
158158

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

161+
<!-- C interface documentation. -->
162+
163+
* * *
164+
165+
<section class="c">
166+
167+
## C APIs
168+
169+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
170+
171+
<section class="intro">
172+
173+
</section>
174+
175+
<!-- /.intro -->
176+
177+
<!-- C usage documentation. -->
178+
179+
<section class="usage">
180+
181+
### Usage
182+
183+
```c
184+
#include "stdlib/stats/base/dists/gumbel/mgf.h"
185+
```
186+
187+
#### stdlib_base_dists_gumbel_median( t, mu, beta )
188+
189+
Evaluates the [moment-generating function][mgf] (MGF) for a [Gumbel][gumbel-distribution] distribution with parameters `mu` (location parameter) and `beta > 0` (scale parameter).
190+
191+
192+
```c
193+
double out = stdlib_base_dists_gumbel_mgf( -1.0, 0.0, 1.0 );
194+
// returns ~6.0
195+
```
196+
197+
The function accepts the following arguments:
198+
199+
- **t**: `[in] double` input value.
200+
- **mu**: `[in] double` location parameter.
201+
- **beta**: `[in] double` scale parameter.
202+
203+
```c
204+
double stdlib_base_dists_gumbel_mgf( const double t, const double mu, const double beta );
205+
```
206+
207+
</section>
208+
209+
<!-- /.usage -->
210+
211+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
212+
213+
<section class="notes">
214+
215+
</section>
216+
217+
<!-- /.notes -->
218+
219+
<!-- C API usage examples. -->
220+
221+
<section class="examples">
222+
223+
### Examples
224+
225+
```c
226+
#include "stdlib/stats/base/dists/gumbel/mgf.h"
227+
#include <stdlib.h>
228+
#include <stdio.h>
229+
230+
static double random_uniform( const double min, const double max ) {
231+
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
232+
return min + ( v*(max-min) );
233+
}
234+
235+
int main( void ) {
236+
double beta;
237+
double mu;
238+
double t;
239+
double y;
240+
int i;
241+
242+
for ( i = 0; i < 25; i++ ) {
243+
t = random_uniform( 0.0, 1.0 );
244+
mu = random_uniform( 0.0, 10.0 );
245+
beta = random_uniform( 0.0, 10.0 );
246+
y = stdlib_base_dists_gumbel_mgf( t, mu, beta );
247+
printf( "t: %lf, µ: %lf, β: %lf, M_X(t;µ,β): %lf\n", t, mu, beta, y );
248+
}
249+
}
250+
```
251+
252+
</section>
253+
254+
<!-- /.examples -->
255+
256+
</section>
257+
258+
<!-- /.c -->
259+
161260
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
162261

163262
<section class="references">

‎lib/node_modules/@stdlib/stats/base/dists/gumbel/mgf/benchmark/benchmark.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ bench( pkg, function benchmark( b ) {
4646
for ( i = 0; i < len; i++ ) {
4747
mu[ i ] = uniform( -50.0, 50.0 );
4848
beta[ i ] = uniform( EPS, 20.0 );
49-
t[ i ] = uniform( 0.0, 1.0/beta[ i ] );
49+
t[ i ] = uniform( 0.0, ( 1.0 / beta[ i ] ) );
5050
}
5151

5252
b.tic();

‎lib/node_modules/@stdlib/stats/base/dists/gumbel/mgf/benchmark/benchmark.native.js

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

‎lib/node_modules/@stdlib/stats/base/dists/gumbel/mgf/benchmark/c/Makefile

+146
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
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+
# Define the program used for compiling C source files:
49+
ifdef C_COMPILER
50+
CC := $(C_COMPILER)
51+
else
52+
CC := gcc
53+
endif
54+
55+
# Define the command-line options when compiling C files:
56+
CFLAGS ?= \
57+
-std=c99 \
58+
-O3 \
59+
-Wall \
60+
-pedantic
61+
62+
# Determine whether to generate position independent code ([1][1], [2][2]).
63+
#
64+
# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options
65+
# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option
66+
ifeq ($(OS), WINNT)
67+
fPIC ?=
68+
else
69+
fPIC ?= -fPIC
70+
endif
71+
72+
# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`):
73+
INCLUDE ?=
74+
75+
# List of source files:
76+
SOURCE_FILES ?=
77+
78+
# List of libraries (e.g., `-lopenblas -lpthread`):
79+
LIBRARIES ?=
80+
81+
# List of library paths (e.g., `-L /foo/bar -L /beep/boop`):
82+
LIBPATH ?=
83+
84+
# List of C targets:
85+
c_targets := benchmark.out
86+
87+
88+
# RULES #
89+
90+
#/
91+
# Compiles source files.
92+
#
93+
# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`)
94+
# @param {string} [CFLAGS] - C compiler options
95+
# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
96+
# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`)
97+
# @param {string} [SOURCE_FILES] - list of source files
98+
# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`)
99+
# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`)
100+
#
101+
# @example
102+
# make
103+
#
104+
# @example
105+
# make all
106+
#/
107+
all: $(c_targets)
108+
109+
.PHONY: all
110+
111+
#/
112+
# Compiles C source files.
113+
#
114+
# @private
115+
# @param {string} CC - C compiler (e.g., `gcc`)
116+
# @param {string} CFLAGS - C compiler options
117+
# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`)
118+
# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`)
119+
# @param {string} SOURCE_FILES - list of source files
120+
# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`)
121+
# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`)
122+
#/
123+
$(c_targets): %.out: %.c
124+
$(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES)
125+
126+
#/
127+
# Runs compiled benchmarks.
128+
#
129+
# @example
130+
# make run
131+
#/
132+
run: $(c_targets)
133+
$(QUIET) ./$<
134+
135+
.PHONY: run
136+
137+
#/
138+
# Removes generated files.
139+
#
140+
# @example
141+
# make clean
142+
#/
143+
clean:
144+
$(QUIET) -rm -f *.o *.out
145+
146+
.PHONY: clean

0 commit comments

Comments
 (0)