Skip to content

Commit 3602cca

Browse files
gururaj1512gururaj1512
committed
feat: add C implementation for stats/base/dists/pareto-type1/cdf
--- type: pre_push_report description: Results of running various checks prior to pushing changes. report: - task: run_javascript_examples status: na - task: run_c_examples status: na - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: na - task: run_c_benchmarks status: na - task: run_cpp_benchmarks status: na - task: run_fortran_benchmarks status: na - task: run_javascript_benchmarks status: na - task: run_julia_benchmarks status: na - task: run_python_benchmarks status: na - task: run_r_benchmarks status: na - task: run_javascript_tests status: na ---
1 parent a40c4f4 commit 3602cca

File tree

17 files changed

+1465
-6
lines changed

17 files changed

+1465
-6
lines changed

‎lib/node_modules/@stdlib/stats/base/dists/pareto-type1/cdf/README.md‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,112 @@ for ( i = 0; i < 10; i++ ) {
153153

154154
<!-- /.examples -->
155155

156+
<!-- C interface documentation. -->
157+
158+
* * *
159+
160+
<section class="c">
161+
162+
## C APIs
163+
164+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
165+
166+
<section class="intro">
167+
168+
</section>
169+
170+
<!-- /.intro -->
171+
172+
<!-- C usage documentation. -->
173+
174+
<section class="usage">
175+
176+
### Usage
177+
178+
```c
179+
#include "stdlib/stats/base/dists/pareto-type1/cdf.h"
180+
```
181+
182+
#### stdlib_base_dists_pareto_type1_cdf( x, alpha, beta )
183+
184+
Evaluates the cumulative distribution function (CDF) for a Pareto (Type I) distribution with shape parameter `alpha` and scale parameter `beta` at a value `x`.
185+
186+
```c
187+
double out = stdlib_base_dists_pareto_type1_cdf( 2.0, 1.0, 1.0 );
188+
// returns 0.5
189+
```
190+
191+
The function accepts the following arguments:
192+
193+
- **x**: `[in] double` input value.
194+
- **alpha**: `[in] double` first shape parameter.
195+
- **beta**: `[in] double` second shape parameter.
196+
197+
```c
198+
double stdlib_base_dists_pareto_type1_cdf( const double x, const double alpha, const double beta );
199+
```
200+
201+
</section>
202+
203+
<!-- /.usage -->
204+
205+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
206+
207+
<section class="notes">
208+
209+
</section>
210+
211+
<!-- /.notes -->
212+
213+
<!-- C API usage examples. -->
214+
215+
<section class="examples">
216+
217+
### Examples
218+
219+
```c
220+
#include "stdlib/stats/base/dists/pareto-type1/cdf.h"
221+
#include <stdlib.h>
222+
#include <stdio.h>
223+
224+
static double random_uniform( const double min, const double max ) {
225+
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
226+
return min + ( v*(max-min) );
227+
}
228+
229+
int main( void ) {
230+
double alpha;
231+
double beta;
232+
double x;
233+
double y;
234+
int i;
235+
236+
for ( i = 0; i < 25; i++ ) {
237+
x = random_uniform( 0.0, 8.0 );
238+
alpha = random_uniform( 0.0, 5.0 );
239+
beta = random_uniform( 0.0, 5.0 );
240+
y = stdlib_base_dists_pareto_type1_cdf( x, alpha, beta );
241+
printf( "x: %lf, α: %lf, β: %lf, F(x;α,β): %lf\n", x, alpha, beta, y );
242+
}
243+
}
244+
```
245+
246+
</section>
247+
248+
<!-- /.examples -->
249+
250+
</section>
251+
252+
<!-- /.c -->
253+
254+
<!-- 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. -->
255+
256+
<section class="references">
257+
258+
</section>
259+
260+
<!-- /.references -->
261+
156262
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
157263

158264
<section class="related">

‎lib/node_modules/@stdlib/stats/base/dists/pareto-type1/cdf/benchmark/benchmark.js‎

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

2323
var bench = require( '@stdlib/bench' );
24+
var Float64Array = require( '@stdlib/array/float64' );
2425
var randu = require( '@stdlib/random/base/randu' );
2526
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2627
var EPS = require( '@stdlib/constants/float64/eps' );
@@ -33,16 +34,24 @@ var cdf = require( './../lib' );
3334
bench( pkg, function benchmark( b ) {
3435
var alpha;
3536
var beta;
37+
var len;
3638
var x;
3739
var y;
3840
var i;
3941

42+
len = 100;
43+
x = new Float64Array( len );
44+
alpha = new Float64Array( len );
45+
beta = new Float64Array( len );
46+
for ( i = 0; i < len; i++ ) {
47+
x[ i ] = ( randu() * 20.0 ) + EPS;
48+
alpha[ i ] = ( randu() * 100.0 ) + EPS;
49+
beta[ i ] = ( randu() * 100.0 ) + EPS;
50+
}
51+
4052
b.tic();
4153
for ( i = 0; i < b.iterations; i++ ) {
42-
x = ( randu()*20.0 ) + EPS;
43-
alpha = ( randu()*100.0 ) + EPS;
44-
beta = ( randu()*100.0 ) + EPS;
45-
y = cdf( x, alpha, beta );
54+
y = cdf( x[ i % len ], alpha[ i % len ], beta[ i % len ] );
4655
if ( isnan( y ) ) {
4756
b.fail( 'should not return NaN' );
4857
}
@@ -59,6 +68,7 @@ bench( pkg+':factory', function benchmark( b ) {
5968
var mycdf;
6069
var alpha;
6170
var beta;
71+
var len;
6272
var x;
6373
var y;
6474
var i;
@@ -67,10 +77,15 @@ bench( pkg+':factory', function benchmark( b ) {
6777
beta = 55.54321;
6878
mycdf = cdf.factory( alpha, beta );
6979

80+
len = 100;
81+
x = new Float64Array( len );
82+
for ( i = 0; i < len; i++ ) {
83+
x[ i ] = ( randu() * 50.0 ) + EPS;
84+
}
85+
7086
b.tic();
7187
for ( i = 0; i < b.iterations; i++ ) {
72-
x = ( randu()*50.0 ) + EPS;
73-
y = mycdf( x );
88+
y = mycdf( x[ i % len ] );
7489
if ( isnan( y ) ) {
7590
b.fail( 'should not return NaN' );
7691
}

‎lib/node_modules/@stdlib/stats/base/dists/pareto-type1/cdf/benchmark/benchmark.native.js‎

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) 2024 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 tryRequire = require( '@stdlib/utils/try-require' );
25+
var bench = require( '@stdlib/bench' );
26+
var Float64Array = require( '@stdlib/array/float64' );
27+
var randu = require( '@stdlib/random/base/randu' );
28+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
29+
var EPS = require( '@stdlib/constants/float64/eps' );
30+
var pkg = require( './../package.json' ).name;
31+
32+
33+
// VARIABLES //
34+
35+
var cdf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
36+
var opts = {
37+
'skip': ( cdf instanceof Error )
38+
};
39+
40+
41+
// MAIN //
42+
43+
bench( pkg+'::native', opts, function benchmark( b ) {
44+
var alpha;
45+
var beta;
46+
var len;
47+
var x;
48+
var y;
49+
var i;
50+
51+
len = 100;
52+
x = new Float64Array( len );
53+
alpha = new Float64Array( len );
54+
beta = new Float64Array( len );
55+
for ( i = 0; i < len; i++ ) {
56+
x[ i ] = ( randu() * 20.0 ) + EPS;
57+
alpha[ i ] = ( randu() * 100.0 ) + EPS;
58+
beta[ i ] = ( randu() * 100.0 ) + EPS;
59+
}
60+
61+
b.tic();
62+
for ( i = 0; i < b.iterations; i++ ) {
63+
y = cdf( x[ i % len ], alpha[ i % len ], beta[ i % len ] );
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+
});

‎lib/node_modules/@stdlib/stats/base/dists/pareto-type1/cdf/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) 2024 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)