Skip to content

Commit 11de1b0

Browse files
committed
feat: add C implementation for stats/base/dists/planck/pmf
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: passed - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: passed - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: na - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---
1 parent 5cc4546 commit 11de1b0

File tree

16 files changed

+1354
-7
lines changed

16 files changed

+1354
-7
lines changed

lib/node_modules/@stdlib/stats/base/dists/planck/pmf/README.md

Lines changed: 103 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,13 @@ var pmf = require( '@stdlib/stats/base/dists/planck/pmf' );
5353
Evaluates the [probability mass function][pmf] (PMF) of a Planck (discrete exponential) distribution with shape parameter `lambda`.
5454

5555
```javascript
56-
var y = pmf( 4.0, 0.3 );
56+
var y = pmf( 4, 0.3 );
5757
// returns ~0.0781
5858

59-
y = pmf( 2.0, 1.7 );
59+
y = pmf( 2, 1.7 );
6060
// returns ~0.0273
6161

62-
y = pmf( -1.0, 2.5 );
62+
y = pmf( -1, 2.5 );
6363
// returns 0.0
6464
```
6565

@@ -69,14 +69,14 @@ If provided `NaN` as any argument, the function returns `NaN`.
6969
var y = pmf( NaN, 0.0 );
7070
// returns NaN
7171

72-
y = pmf( 0.0, NaN );
72+
y = pmf( 0, NaN );
7373
// returns NaN
7474
```
7575

7676
If provided a shape parameter `lambda` which is a nonpositive number, the function returns `NaN`.
7777

7878
```javascript
79-
var y = pmf( 2.0, -1.0 );
79+
var y = pmf( 2, -1.0 );
8080
// returns NaN
8181
```
8282

@@ -86,10 +86,10 @@ Returns a function for evaluating the [probability mass function][pmf] (PMF) of
8686

8787
```javascript
8888
var mypmf = pmf.factory( 0.5 );
89-
var y = mypmf( 3.0 );
89+
var y = mypmf( 3 );
9090
// returns ~0.0878
9191

92-
y = mypmf( 1.0 );
92+
y = mypmf( 1 );
9393
// returns ~0.2387
9494
```
9595

@@ -123,6 +123,102 @@ for ( i = 0; i < lambda.length; i++ ) {
123123

124124
<!-- /.examples -->
125125

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

128224
<section class="related">
Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
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 discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
27+
var uniform = require( '@stdlib/random/base/uniform' );
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 pmf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
36+
var opts = {
37+
'skip': ( pmf instanceof Error )
38+
};
39+
40+
41+
// MAIN //
42+
43+
bench( pkg+'::native', opts, function benchmark( b ) {
44+
var lambda;
45+
var len;
46+
var x;
47+
var y;
48+
var i;
49+
50+
len = 100;
51+
lambda = new Float64Array( len );
52+
x = new Float64Array( len );
53+
for ( i = 0; i < len; i++ ) {
54+
lambda[ i ] = uniform( 0.1, 10.0 );
55+
x[ i ] = discreteUniform( 0, 40 );
56+
}
57+
58+
b.tic();
59+
for ( i = 0; i < b.iterations; i++ ) {
60+
y = pmf( x[ i % len ], lambda[ i % len ] );
61+
if ( isnan( y ) ) {
62+
b.fail( 'should not return NaN' );
63+
}
64+
}
65+
b.toc();
66+
if ( isnan( y ) ) {
67+
b.fail( 'should not return NaN' );
68+
}
69+
b.pass( 'benchmark finished' );
70+
b.end();
71+
});
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)