Skip to content

Commit 2366eb1

Browse files
vivekmaurya001Planeshifterstdlib-bot
authored
feat: add C implementation for stats/base/dists/erlang/mean
PR-URL: #4246 Closes: #3572 Co-authored-by: Philipp Burckhardt <[email protected]> Co-authored-by: stdlib-bot <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]> Signed-off-by: Philipp Burckhardt <[email protected]> Signed-off-by: Vivek maurya <[email protected]>
1 parent 3656652 commit 2366eb1

File tree

17 files changed

+1340
-3
lines changed

17 files changed

+1340
-3
lines changed

Diff for: ‎lib/node_modules/@stdlib/stats/base/dists/erlang/mean/README.md

+98
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,104 @@ for ( i = 0; i < 10; i++ ) {
145145

146146
<!-- /.examples -->
147147

148+
<!-- C interface documentation. -->
149+
150+
* * *
151+
152+
<section class="c">
153+
154+
## C APIs
155+
156+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
157+
158+
<section class="intro">
159+
160+
</section>
161+
162+
<!-- /.intro -->
163+
164+
<!-- C usage documentation. -->
165+
166+
<section class="usage">
167+
168+
### Usage
169+
170+
```c
171+
#include "stdlib/stats/base/dists/erlang/mean.h"
172+
```
173+
174+
#### stdlib_base_dists_erlang_mean( k, lambda )
175+
176+
Evaluates the [expected value][expected-value] of an [Erlang][erlang-distribution] distribution with parameters `k` (shape parameter) and `lambda` (rate parameter).
177+
178+
```c
179+
double out = stdlib_base_dists_erlang_mean( 1, 1.0 );
180+
// returns 1.0
181+
```
182+
183+
The function accepts the following arguments:
184+
185+
- **k**: `[in] int32_t` shape parameter.
186+
- **lambda**: `[in] double` rate parameter.
187+
188+
```c
189+
double stdlib_base_dists_erlang_mean( const int32_t k, const double lambda );
190+
```
191+
192+
</section>
193+
194+
<!-- /.usage -->
195+
196+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
197+
198+
<section class="notes">
199+
200+
</section>
201+
202+
<!-- /.notes -->
203+
204+
<!-- C API usage examples. -->
205+
206+
<section class="examples">
207+
208+
### Examples
209+
210+
```c
211+
#include "stdlib/stats/base/dists/erlang/mean.h"
212+
#include "stdlib/constants/float64/eps.h"
213+
#include "stdlib/math/base/special/round.h"
214+
#include <stdlib.h>
215+
#include <stdint.h>
216+
#include <stdio.h>
217+
218+
static double random_uniform( const double min, const double max ) {
219+
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
220+
return min + ( v*(max-min) );
221+
}
222+
223+
int main( void ) {
224+
double lambda;
225+
int32_t k;
226+
double y;
227+
int i;
228+
229+
for ( i = 0; i < 25; i++ ) {
230+
k = stdlib_base_round( random_uniform( 0.0, 10.0 ) );
231+
lambda = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 10.0 );
232+
y = stdlib_base_dists_erlang_mean( k, lambda );
233+
printf( "k: %d, λ: %lf, E(X;k,λ): %lf\n", k, lambda, y );
234+
}
235+
}
236+
```
237+
238+
</section>
239+
240+
<!-- /.examples -->
241+
242+
</section>
243+
244+
<!-- /.c -->
245+
148246
<!-- 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. -->
149247

150248
<section class="references">

Diff for: ‎lib/node_modules/@stdlib/stats/base/dists/erlang/mean/benchmark/benchmark.js

+4-3
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,11 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var Float64Array = require( '@stdlib/array/float64' );
2524
var uniform = require( '@stdlib/random/base/uniform' );
2625
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
2726
var isnan = require( '@stdlib/math/base/assert/is-nan' );
27+
var Float64Array = require( '@stdlib/array/float64' );
28+
var Int32Array = require( '@stdlib/array/int32' );
2829
var EPS = require( '@stdlib/constants/float64/eps' );
2930
var pkg = require( './../package.json' ).name;
3031
var mean = require( './../lib' );
@@ -40,10 +41,10 @@ bench( pkg, function benchmark( b ) {
4041
var i;
4142

4243
len = 100;
43-
k = new Float64Array( len );
4444
lambda = new Float64Array( len );
45+
k = new Int32Array( len );
4546
for ( i = 0; i < len; i++ ) {
46-
k[ i ] = discreteUniform( 0, 10 );
47+
k[ i ] = discreteUniform( 1, 10 );
4748
lambda[ i ] = uniform( EPS, 10.0 );
4849
}
4950

Diff for: ‎lib/node_modules/@stdlib/stats/base/dists/erlang/mean/benchmark/benchmark.native.js

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

Diff for: ‎lib/node_modules/@stdlib/stats/base/dists/erlang/mean/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)