Skip to content

Commit 120e678

Browse files
yuvi-mittalPlaneshifter
yuvi-mittal
and
Planeshifter
authored
feat: add C implementation for stats/base/dists/planck/stdev
PR-URL: #4913 Closes: #4912 Co-authored-by: Philipp Burckhardt <[email protected]> Reviewed-by: Neeraj Pathak <[email protected]> Reviewed-by: Philipp Burckhardt <[email protected]>
1 parent fb5d497 commit 120e678

File tree

17 files changed

+1269
-3
lines changed

17 files changed

+1269
-3
lines changed

Diff for: ‎lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md

+92
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,98 @@ for ( i = 0; i < lambda.length; i++ ) {
120120

121121
<!-- /.references -->
122122

123+
<!-- C interface documentation. -->
124+
125+
* * *
126+
127+
<section class="c">
128+
129+
## C APIs
130+
131+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
132+
133+
<section class="intro">
134+
135+
</section>
136+
137+
<!-- /.intro -->
138+
139+
<!-- C usage documentation. -->
140+
141+
<section class="usage">
142+
143+
### Usage
144+
145+
```c
146+
#include "stdlib/stats/base/dists/planck/stdev.h"
147+
```
148+
149+
#### stdlib_base_dists_planck_stdev( lambda )
150+
151+
Returns the standard deviation of a Planck distribution with shape parameter `λ`.
152+
153+
```c
154+
double out = stdlib_base_dists_planck_stdev( 0.1 );
155+
// returns ~9.9958
156+
```
157+
158+
The function accepts the following arguments:
159+
160+
- **lambda**: `[in] double` shape parameter.
161+
162+
```c
163+
double stdlib_base_dists_planck_stdev( const double lambda );
164+
```
165+
166+
</section>
167+
168+
<!-- /.usage -->
169+
170+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
171+
172+
<section class="notes">
173+
174+
</section>
175+
176+
<!-- /.notes -->
177+
178+
<!-- C API usage examples. -->
179+
180+
<section class="examples">
181+
182+
### Examples
183+
184+
```c
185+
#include "stdlib/stats/base/dists/planck/stdev.h"
186+
#include <stdlib.h>
187+
#include <stdio.h>
188+
189+
static double random_uniform( const double min, const double max ) {
190+
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
191+
return min + ( v*(max-min) );
192+
}
193+
194+
int main( void ) {
195+
double lambda;
196+
double y;
197+
int i;
198+
199+
for ( i = 0; i < 25; i++ ) {
200+
lambda = random_uniform( 0.1, 10.0 );
201+
y = stdlib_base_dists_planck_stdev( lambda );
202+
printf( "λ: %lf, SD(X;λ): %lf\n", lambda, y );
203+
}
204+
}
205+
```
206+
207+
</section>
208+
209+
<!-- /.examples -->
210+
211+
</section>
212+
213+
<!-- /.c -->
214+
123215
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
124216

125217
<section class="related">

Diff for: ‎lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js

+9-3
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@
2121
// MODULES //
2222

2323
var bench = require( '@stdlib/bench' );
24-
var uniform = require( '@stdlib/random/array/uniform' );
24+
var uniform = require( '@stdlib/random/base/uniform' );
25+
var Float64Array = require( '@stdlib/array/float64' );
2526
var isnan = require( '@stdlib/math/base/assert/is-nan' );
2627
var pkg = require( './../package.json' ).name;
2728
var stdev = require( './../lib' );
@@ -31,14 +32,19 @@ var stdev = require( './../lib' );
3132

3233
bench( pkg, function benchmark( b ) {
3334
var lambda;
35+
var len;
3436
var y;
3537
var i;
3638

37-
lambda = uniform( 100, 0.1, 10.0 );
39+
len = 100;
40+
lambda = new Float64Array( len );
41+
for ( i = 0; i < len; i++ ) {
42+
lambda[ i ] = uniform( 1.0, 11.0 );
43+
}
3844

3945
b.tic();
4046
for ( i = 0; i < b.iterations; i++ ) {
41-
y = stdev( lambda[ i % lambda.length ] );
47+
y = stdev( lambda[ i % len ] );
4248
if ( isnan( y ) ) {
4349
b.fail( 'should not return NaN' );
4450
}

Diff for: ‎lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
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 uniform = require( '@stdlib/random/base/uniform' );
26+
var Float64Array = require( '@stdlib/array/float64' );
27+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
28+
var tryRequire = require( '@stdlib/utils/try-require' );
29+
var pkg = require( './../package.json' ).name;
30+
31+
32+
// VARIABLES //
33+
34+
var stdev = tryRequire( resolve( __dirname, './../lib/native.js' ) );
35+
var opts = {
36+
'skip': ( stdev instanceof Error )
37+
};
38+
39+
40+
// MAIN //
41+
42+
bench( pkg+'::native', opts, function benchmark( b ) {
43+
var lambda;
44+
var len;
45+
var y;
46+
var i;
47+
48+
len = 100;
49+
lambda = new Float64Array( len );
50+
for ( i = 0; i < len; i++ ) {
51+
lambda[ i ] = uniform( 0.1, 11.0 );
52+
}
53+
54+
b.tic();
55+
for ( i = 0; i < b.iterations; i++ ) {
56+
y = stdev( lambda[ i % len ] );
57+
if ( isnan( y ) ) {
58+
b.fail( 'should not return NaN' );
59+
}
60+
}
61+
b.toc();
62+
if ( isnan( y ) ) {
63+
b.fail( 'should not return NaN' );
64+
}
65+
b.pass( 'benchmark finished' );
66+
b.end();
67+
});

Diff for: ‎lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/c/Makefile

+146
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)