Skip to content

Commit 318b207

Browse files
rautelaKamalrautelaKamal
committed
fix: address maintainer feedback for C implementation
- Add benchmark/c and examples/c directories and Makefiles - Add C APIs documentation to README.md - Add degenerate distribution test cases for k=0 to test.pdf.js and test.native.js Signed-off-by: Kamal Singh Rautela <e22cseu1624@bennett.edu.in>
1 parent 7d46006 commit 318b207

File tree

7 files changed

+606
-2
lines changed

7 files changed

+606
-2
lines changed

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

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,108 @@ logEachMap( 'x: %0.4f, k: %d, λ: %0.4f, f(x;k,λ): %0.4f', x, k, lambda, pdf );
155155

156156
<!-- /.examples -->
157157

158+
<!-- C interface documentation. -->
159+
160+
* * *
161+
162+
<section class="c">
163+
164+
## C APIs
165+
166+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
167+
168+
<section class="intro">
169+
170+
</section>
171+
172+
<!-- /.intro -->
173+
174+
<!-- C usage documentation. -->
175+
176+
<section class="usage">
177+
178+
### Usage
179+
180+
```c
181+
#include "stdlib/stats/base/dists/erlang/pdf.h"
182+
```
183+
184+
#### stdlib_base_dists_erlang_pdf( x, k, lambda )
185+
186+
Evaluates the [probability density function][pdf] (PDF) for an [Erlang][erlang-distribution] distribution with parameters `k` (shape parameter) and `lambda` (rate parameter).
187+
188+
```c
189+
double y = stdlib_base_dists_erlang_pdf( 0.1, 1, 1.0 );
190+
// returns ~0.905
191+
```
192+
193+
The function accepts the following arguments:
194+
195+
- **x**: `[in] double` input value.
196+
- **k**: `[in] double` shape parameter.
197+
- **lambda**: `[in] double` rate parameter.
198+
199+
```c
200+
double stdlib_base_dists_erlang_pdf( const double x, const double k, const double lambda );
201+
```
202+
203+
</section>
204+
205+
<!-- /.usage -->
206+
207+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
208+
209+
<section class="notes">
210+
211+
</section>
212+
213+
<!-- /.notes -->
214+
215+
<!-- C API usage examples. -->
216+
217+
<section class="examples">
218+
219+
### Examples
220+
221+
```c
222+
#include "stdlib/stats/base/dists/erlang/pdf.h"
223+
#include "stdlib/math/base/special/round.h"
224+
#include <stdlib.h>
225+
#include <stdio.h>
226+
227+
static double random_uniform( const double min, const double max ) {
228+
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
229+
return min + ( v*(max-min) );
230+
}
231+
232+
int main( void ) {
233+
double lambda;
234+
double k;
235+
double x;
236+
double y;
237+
int i;
238+
239+
for ( i = 0; i < 25; i++ ) {
240+
k = stdlib_base_round( random_uniform( 1.0, 10.0 ) );
241+
lambda = random_uniform( 0.0, 10.0 );
242+
x = random_uniform( 0.0, 20.0 );
243+
y = stdlib_base_dists_erlang_pdf( x, k, lambda );
244+
printf( "x: %lf, k: %lf, λ: %lf, f(x;k,λ): %lf\n", x, k, lambda, y );
245+
}
246+
}
247+
```
248+
249+
</section>
250+
251+
<!-- /.examples -->
252+
253+
</section>
254+
255+
<!-- /.c -->
256+
158257
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
159258

259+
160260
<section class="related">
161261

162262
</section>

‎lib/node_modules/@stdlib/stats/base/dists/erlang/pdf/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)