Skip to content

Commit d657500

Browse files
rautelaKamalNeerajpathak07Planeshifter
authored
feat: add C implementation for stats/base/dists/erlang/logpdf
PR-URL: #10719 Closes: #3571 Co-authored-by: Neeraj Pathak <neerajrpathak710@gmail.com> Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Assisted-by: Claude <noreply@anthropic.com>
1 parent 8498df4 commit d657500

19 files changed

Lines changed: 1412 additions & 77 deletions

File tree

‎lib/node_modules/@stdlib/stats/base/dists/erlang/logpdf/README.md‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,101 @@ y = mylogpdf( 4.0 );
129129

130130
<!-- /.usage -->
131131

132+
<section class="c">
133+
134+
## C APIs
135+
136+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
137+
138+
<section class="intro">
139+
140+
</section>
141+
142+
<!-- /.intro -->
143+
144+
<!-- C usage documentation. -->
145+
146+
<section class="usage">
147+
148+
### Usage
149+
150+
```c
151+
#include "stdlib/stats/base/dists/erlang/logpdf.h"
152+
```
153+
154+
#### stdlib_base_dists_erlang_logpdf( x, k, lambda )
155+
156+
Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for an [Erlang][erlang-distribution] distribution with shape parameter `k` and rate parameter `lambda` at a value `x`.
157+
158+
```c
159+
double y = stdlib_base_dists_erlang_logpdf( 1.0, 3.0, 1.5 );
160+
// returns ~-0.977
161+
```
162+
163+
The function accepts the following arguments:
164+
165+
- **x**: `[in] double` input value.
166+
- **k**: `[in] double` shape parameter.
167+
- **lambda**: `[in] double` rate parameter.
168+
169+
```c
170+
double stdlib_base_dists_erlang_logpdf( const double x, const double k, const double lambda );
171+
```
172+
173+
</section>
174+
175+
<!-- /.usage -->
176+
177+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
178+
179+
<section class="notes">
180+
181+
</section>
182+
183+
<!-- /.notes -->
184+
185+
<!-- C API usage examples. -->
186+
187+
<section class="examples">
188+
189+
### Examples
190+
191+
```c
192+
#include "stdlib/stats/base/dists/erlang/logpdf.h"
193+
#include "stdlib/math/base/special/round.h"
194+
#include <stdlib.h>
195+
#include <stdio.h>
196+
197+
static double random_uniform( const double min, const double max ) {
198+
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
199+
return min + ( v*(max-min) );
200+
}
201+
202+
int main( void ) {
203+
double lambda;
204+
double x;
205+
double k;
206+
double y;
207+
int i;
208+
209+
for ( i = 0; i < 5; i++ ) {
210+
x = random_uniform( 0.0, 10.0 );
211+
k = stdlib_base_round( random_uniform( 0.0, 10.0 ) );
212+
lambda = random_uniform( 0.0, 5.0 );
213+
y = stdlib_base_dists_erlang_logpdf( x, k, lambda );
214+
printf( "x: %lf, k: %lf, λ: %lf, ln(f(x;k,λ)): %lf\n", x, k, lambda, y );
215+
}
216+
}
217+
```
218+
219+
</section>
220+
221+
<!-- /.examples -->
222+
223+
</section>
224+
225+
<!-- /.c -->
226+
132227
<section class="examples">
133228

134229
## Examples

‎lib/node_modules/@stdlib/stats/base/dists/erlang/logpdf/benchmark/benchmark.js‎

Lines changed: 15 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,8 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var Float64Array = require( '@stdlib/array/float64' );
25-
var uniform = require( '@stdlib/random/base/uniform' );
26-
var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
24+
var uniform = require( '@stdlib/random/array/uniform' );
25+
var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
2726
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2827
var EPS = require( '@stdlib/constants/float64/eps' );
2928
var format = require( '@stdlib/string/format' );
@@ -35,25 +34,22 @@ var logpdf = require( './../lib' );
3534

3635
bench( pkg, function benchmark( b ) {
3736
var lambda;
38-
var len;
37+
var opts;
3938
var k;
4039
var x;
4140
var y;
4241
var i;
4342

44-
len = 100;
45-
x = new Float64Array( len );
46-
k = new Float64Array( len );
47-
lambda = new Float64Array( len );
48-
for ( i = 0; i < len; i++ ) {
49-
x[ i ] = discreteUniform( 0, 100 );
50-
k[ i ] = discreteUniform( 0, 100 );
51-
lambda[ i ] = uniform( EPS, 20.0 );
52-
}
43+
opts = {
44+
'dtype': 'float64'
45+
};
46+
x = discreteUniform( 100, 0, 100.0 );
47+
k = discreteUniform( 100, 0, 100.0 );
48+
lambda = uniform( 100, EPS, 20.0, opts );
5349

5450
b.tic();
5551
for ( i = 0; i < b.iterations; i++ ) {
56-
y = logpdf( x[ i % len ], k[ i % len ], lambda[ i % len ] );
52+
y = logpdf( x[ i % x.length ], k[ i % k.length ], lambda[ i % lambda.length ] );
5753
if ( isnan( y ) ) {
5854
b.fail( 'should not return NaN' );
5955
}
@@ -68,25 +64,18 @@ bench( pkg, function benchmark( b ) {
6864

6965
bench( format( '%s:factory', pkg ), function benchmark( b ) {
7066
var mylogpdf;
71-
var lambda;
72-
var len;
73-
var k;
7467
var x;
7568
var y;
7669
var i;
7770

78-
k = 2.0;
79-
lambda = 1.5;
80-
mylogpdf = logpdf.factory( k, lambda );
81-
len = 100;
82-
x = new Float64Array( len );
83-
for ( i = 0; i < len; i++ ) {
84-
x[ i ] = uniform( EPS, 50.0 );
85-
}
71+
mylogpdf = logpdf.factory( 1.0, 1.5 );
72+
x = uniform( 100, EPS, 10.0, {
73+
'dtype': 'float64'
74+
});
8675

8776
b.tic();
8877
for ( i = 0; i < b.iterations; i++ ) {
89-
y = mylogpdf( x[ i % len ] );
78+
y = mylogpdf( x[ i % x.length ] );
9079
if ( isnan( y ) ) {
9180
b.fail( 'should not return NaN' );
9281
}

‎lib/node_modules/@stdlib/stats/base/dists/erlang/logpdf/benchmark/benchmark.native.js‎

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

‎lib/node_modules/@stdlib/stats/base/dists/erlang/logpdf/benchmark/c/Makefile‎

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
#/
2+
# @license Apache-2.0
3+
#
4+
# Copyright (c) 2026 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)