Skip to content

Commit 3ee60b4

Browse files
0PrashantYadav0Planeshifterstdlib-bot
authored
feat: add C implementation for stats/base/dists/triangular/quantile
PR-URL: #4307 Closes: #3821 Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Co-authored-by: stdlib-bot <noreply@stdlib.io> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent 73d8eb8 commit 3ee60b4

File tree

18 files changed

+1473
-12
lines changed

18 files changed

+1473
-12
lines changed

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

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,115 @@ for ( i = 0; i < 25; 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/triangular/quantile.h"
185+
```
186+
187+
#### stdlib_base_dists_triangular_quantile( p, a, b, c )
188+
189+
Evaluates the [quantile function][quantile-function] for a [triangular][triangular-distribution] distribution with parameters `a` (lower limit), `b` (upper limit) and `c` (mode).
190+
191+
```c
192+
double out = stdlib_base_dists_triangular_quantile( 0.9, -1.0, 1.0, 0.0 );
193+
// returns ~0.553
194+
```
195+
196+
The function accepts the following arguments:
197+
198+
- **p**: `[in] double` input probability.
199+
- **a**: `[in] double` minimum support.
200+
- **b**: `[in] double` maximum support.
201+
- **c**: `[in] double` mode.
202+
203+
```c
204+
double stdlib_base_dists_triangular_quantile( const double p, const double a, const double b, const double c );
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/triangular/quantile.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 a;
237+
double b;
238+
double c;
239+
double p;
240+
double v;
241+
int i;
242+
243+
for ( i = 0; i < 25; i++ ) {
244+
p = random_uniform( 0.0, 1.0 );
245+
a = random_uniform( 0.0, 10.0 );
246+
b = random_uniform( a, a+10.0 );
247+
c = random_uniform( a, b );
248+
v = stdlib_base_dists_triangular_quantile( p, a, b, c );
249+
printf( "p: %lf, a: %lf, b: %lf, c: %lf, Q(p;a,b,c): %lf\n", p, a, b, c, v );
250+
}
251+
}
252+
```
253+
254+
</section>
255+
256+
<!-- /.examples -->
257+
258+
</section>
259+
260+
<!-- /.c -->
261+
262+
<!-- 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. -->
263+
264+
<section class="references">
265+
266+
</section>
267+
268+
<!-- /.references -->
269+
161270
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
162271

163272
<section class="related">

lib/node_modules/@stdlib/stats/base/dists/triangular/quantile/benchmark/benchmark.js

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

2323
var bench = require( '@stdlib/bench' );
24-
var randu = require( '@stdlib/random/base/randu' );
24+
var Float64Array = require( '@stdlib/array/float64' );
25+
var uniform = require( '@stdlib/random/base/uniform' );
2526
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2627
var EPS = require( '@stdlib/constants/float64/eps' );
2728
var pkg = require( './../package.json' ).name;
@@ -32,19 +33,28 @@ var quantile = require( './../lib' );
3233

3334
bench( pkg, function benchmark( b ) {
3435
var mode;
36+
var len;
3537
var min;
3638
var max;
3739
var p;
3840
var y;
3941
var i;
4042

43+
len = 100;
44+
p = new Float64Array( len );
45+
min = new Float64Array( len );
46+
max = new Float64Array( len );
47+
mode = new Float64Array( len );
48+
for ( i = 0; i < len; i++ ) {
49+
p[ i ] = uniform( 0.0, 1.0 );
50+
min[ i ] = uniform( 0.0, 10.0 );
51+
max[ i ] = uniform( EPS + min[ i ], EPS + min[ i ] + 10.0 );
52+
mode[ i ] = uniform( min[ i ], max[ i ] );
53+
}
54+
4155
b.tic();
4256
for ( i = 0; i < b.iterations; i++ ) {
43-
p = randu();
44-
min = randu() * 10.0;
45-
max = min + ( randu() * 40.0 ) + EPS;
46-
mode = min + ( ( max - min ) * randu() );
47-
y = quantile( p, min, max, mode );
57+
y = quantile( p[ i ], min[ i ], max[ i ], mode[ i ] );
4858
if ( isnan( y ) ) {
4959
b.fail( 'should not return NaN' );
5060
}
@@ -73,7 +83,7 @@ bench( pkg+':factory', function benchmark( b ) {
7383

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