Skip to content

Commit 36e56bb

Browse files
feat: add C implementation for stats/base/dists/levy/pdf
PR-URL: #4918 Closes: #3729 Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com> Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>
1 parent f63f8df commit 36e56bb

File tree

17 files changed

+1423
-8
lines changed

17 files changed

+1423
-8
lines changed

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

Lines changed: 111 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ y = mypdf( 20.0 );
113113
<!-- eslint no-undef: "error" -->
114114

115115
```javascript
116-
var randu = require( '@stdlib/random/base/randu' );
116+
var uniform = require( '@stdlib/random/base/uniform' );
117117
var EPS = require( '@stdlib/constants/float64/eps' );
118118
var pdf = require( '@stdlib/stats/base/dists/levy/pdf' );
119119

@@ -124,9 +124,9 @@ var y;
124124
var i;
125125

126126
for ( i = 0; i < 10; i++ ) {
127-
mu = randu() * 10.0;
128-
x = ( randu()*10.0 ) + mu;
129-
c = ( randu()*10.0 ) + EPS;
127+
mu = uniform( 0.0, 10.0 );
128+
x = uniform( mu, mu + 10.0 );
129+
c = uniform( EPS, 10.0 );
130130
y = pdf( x, mu, c );
131131
console.log( 'x: %d, µ: %d, c: %d, f(x;µ,c): %d', x, mu, c, y );
132132
}
@@ -136,6 +136,113 @@ for ( i = 0; i < 10; i++ ) {
136136

137137
<!-- /.examples -->
138138

139+
<!-- C interface documentation. -->
140+
141+
* * *
142+
143+
<section class="c">
144+
145+
## C APIs
146+
147+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
148+
149+
<section class="intro">
150+
151+
</section>
152+
153+
<!-- /.intro -->
154+
155+
<!-- C usage documentation. -->
156+
157+
<section class="usage">
158+
159+
### Usage
160+
161+
```c
162+
#include "stdlib/stats/base/dists/levy/pdf.h"
163+
```
164+
165+
#### stdlib_base_dists_levy_pdf( x, mu, c )
166+
167+
Evaluates the [probability density][pdf] for a [Lévy][levy-distribution] distribution with input value `x`, location parameter `mu`, and scale parameter `c`.
168+
169+
```c
170+
double out = stdlib_base_dists_levy_pdf( 2.0, 0.0, 1.0 );
171+
// returns ~0.11
172+
```
173+
174+
The function accepts the following arguments:
175+
176+
- **x**: `[in] double` input value
177+
- **mu**: `[in] double` location parameter.
178+
- **c**: `[in] double` scale parameter.
179+
180+
```c
181+
double stdlib_base_dists_levy_pdf( const double x, const double mu, const double c );
182+
```
183+
184+
</section>
185+
186+
<!-- /.usage -->
187+
188+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
189+
190+
<section class="notes">
191+
192+
</section>
193+
194+
<!-- /.notes -->
195+
196+
<!-- C API usage examples. -->
197+
198+
<section class="examples">
199+
200+
### Examples
201+
202+
```c
203+
#include "stdlib/stats/base/dists/levy/pdf.h"
204+
#include "stdlib/constants/float64/eps.h"
205+
#include <stdlib.h>
206+
#include <stdio.h>
207+
208+
static double random_uniform( const double min, const double max ) {
209+
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
210+
return min + ( v*(max-min) );
211+
}
212+
213+
int main( void ) {
214+
double mu;
215+
double x;
216+
double c;
217+
double y;
218+
int i;
219+
220+
for ( i = 0; i < 25; i++ ) {
221+
mu = random_uniform( 0.0, 10.0 );
222+
x = random_uniform( mu, mu + 10.0 );
223+
c = random_uniform( STDLIB_CONSTANT_FLOAT64_EPS, 20.0 );
224+
y = stdlib_base_dists_levy_pdf( x, mu, c );
225+
printf( "x: %lf, mu: %lf, c: %lf, f(x;mu,c): %lf\n", x, mu, c, y );
226+
}
227+
}
228+
```
229+
230+
</section>
231+
232+
<!-- /.examples -->
233+
234+
</section>
235+
236+
<!-- /.c -->
237+
238+
<!-- 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. -->
239+
240+
<section class="references">
241+
242+
</section>
243+
244+
<!-- /.references -->
245+
139246
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
140247

141248
<section class="related">

lib/node_modules/@stdlib/stats/base/dists/levy/pdf/benchmark/benchmark.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,24 +34,24 @@ var pdf = require( './../lib' );
3434
bench( pkg, function benchmark( b ) {
3535
var len;
3636
var mu;
37-
var s;
3837
var x;
38+
var c;
3939
var y;
4040
var i;
4141

4242
len = 100;
4343
mu = new Float64Array( len );
44-
s = new Float64Array( len );
44+
c = new Float64Array( len );
4545
x = new Float64Array( len );
4646
for ( i = 0; i < len; i++ ) {
4747
mu[ i ] = uniform( -10.0, 10.0 );
4848
x[ i ] = uniform( mu[ i ], 40.0 );
49-
s[ i ] = uniform( EPS, 5.0 );
49+
c[ i ] = uniform( EPS, 5.0 );
5050
}
5151

5252
b.tic();
5353
for ( i = 0; i < b.iterations; i++ ) {
54-
y = pdf( x[ i % len ], mu[ i % len ], s[ i % len ] );
54+
y = pdf( x[ i % len ], mu[ i % len ], c[ i % len ] );
5555
if ( isnan( y ) ) {
5656
b.fail( 'should not return NaN' );
5757
}
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) 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 pdf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
36+
var opts = {
37+
'skip': ( pdf instanceof Error )
38+
};
39+
40+
41+
// MAIN //
42+
43+
bench( pkg+'::native', opts, function benchmark( b ) {
44+
var len;
45+
var mu;
46+
var x;
47+
var c;
48+
var y;
49+
var i;
50+
51+
len = 100;
52+
mu = new Float64Array( len );
53+
x = new Float64Array( len );
54+
c = new Float64Array( len );
55+
for ( i = 0; i < len; i++ ) {
56+
mu[ i ] = uniform( -10.0, 10.0 );
57+
x[ i ] = uniform( mu[ i ], 40.0 );
58+
c[ i ] = uniform( EPS, 5.0 );
59+
}
60+
61+
b.tic();
62+
for ( i = 0; i < b.iterations; i++ ) {
63+
y = pdf( x[ i % len ], mu[ i % len ], c[ 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+
});
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)