Skip to content

Commit 88f5b96

Browse files
Planeshifterclaude
andcommitted
feat: add C implementation for stats/base/dists/erlang/quantile
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 parent c9ec8c9 commit 88f5b96

16 files changed

Lines changed: 1379 additions & 0 deletions

File tree

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

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,89 @@ logEachMap( 'p: %0.4f, k: %d, λ: %0.4f, Q(p;k,λ): %0.4f', p, k, lambda, quanti
158158

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

161+
<!-- C usage documentation. -->
162+
163+
<section class="c">
164+
165+
<section class="intro">
166+
167+
</section>
168+
169+
<!-- /.intro -->
170+
171+
172+
<section class="usage">
173+
174+
## C APIs
175+
176+
### Usage
177+
178+
```c
179+
#include "stdlib/stats/base/dists/erlang/quantile.h"
180+
```
181+
182+
#### stdlib_base_dists_erlang_quantile( p, k, lambda )
183+
184+
Evaluates the [quantile function][quantile-function] for an [Erlang][erlang-distribution] distribution with shape parameter `k` and rate parameter `lambda`.
185+
186+
```c
187+
double out = stdlib_base_dists_erlang_quantile( 0.8, 2.0, 1.0 );
188+
// returns ~2.994
189+
```
190+
191+
The function accepts the following arguments:
192+
193+
- **p**: `[in] double` input probability.
194+
- **k**: `[in] double` shape parameter.
195+
- **lambda**: `[in] double` rate parameter.
196+
197+
```c
198+
double stdlib_base_dists_erlang_quantile( const double p, const double k, const double lambda );
199+
```
200+
201+
</section>
202+
203+
<!-- /.usage -->
204+
205+
<section class="examples">
206+
207+
### Examples
208+
209+
```c
210+
#include "stdlib/stats/base/dists/erlang/quantile.h"
211+
#include <stdlib.h>
212+
#include <stdio.h>
213+
214+
static double random_uniform( double min, double max ) {
215+
double scale = rand() / (double) RAND_MAX;
216+
return min + ( scale * ( max - min ) );
217+
}
218+
219+
int main( void ) {
220+
double lambda;
221+
double p;
222+
double y;
223+
int k;
224+
int i;
225+
226+
for ( i = 0; i < 25; i++ ) {
227+
p = random_uniform( 0.0, 1.0 );
228+
k = (int)random_uniform( 1.0, 10.0 );
229+
lambda = random_uniform( 0.1, 5.0 );
230+
y = stdlib_base_dists_erlang_quantile( p, (double)k, lambda );
231+
printf( "p: %lf, k: %d, λ: %lf, Q(p;k,λ): %lf\n", p, k, lambda, y );
232+
}
233+
}
234+
```
235+
236+
</section>
237+
238+
<!-- /.examples -->
239+
240+
</section>
241+
242+
<!-- /.c -->
243+
161244
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
162245

163246
<section class="related">
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
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 discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
26+
var uniform = require( '@stdlib/random/array/uniform' );
27+
var format = require( '@stdlib/string/format' );
28+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
29+
var EPS = require( '@stdlib/constants/float64/eps' );
30+
var tryRequire = require( '@stdlib/utils/try-require' );
31+
var pkg = require( './../package.json' ).name;
32+
33+
34+
// VARIABLES //
35+
36+
var quantile = tryRequire( resolve( __dirname, './../lib/native.js' ) );
37+
var opts = {
38+
'skip': ( quantile instanceof Error )
39+
};
40+
41+
42+
// MAIN //
43+
44+
bench( format( '%s::native', pkg ), opts, function benchmark( b ) {
45+
var lambda;
46+
var p;
47+
var k;
48+
var y;
49+
var i;
50+
51+
p = uniform( 100, 0.0, 1.0, {
52+
'dtype': 'float64'
53+
});
54+
k = discreteUniform( 100, 0, 20, {
55+
'dtype': 'float64'
56+
});
57+
lambda = uniform( 100, EPS, 20.0, {
58+
'dtype': 'float64'
59+
});
60+
61+
b.tic();
62+
for ( i = 0; i < b.iterations; i++ ) {
63+
y = quantile( p[ i % p.length ], k[ i % k.length ], lambda[ i % lambda.length ] );
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+
});
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)