Skip to content

Commit 134ba85

Browse files
committed
feat: add c implementation for stats/base/dists/signrank/pdf
--- 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 --- --- 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 9da0761 commit 134ba85

File tree

17 files changed

+1415
-29
lines changed

17 files changed

+1415
-29
lines changed

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

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,102 @@ for ( i = 0; i < 10; i++ ) {
126126

127127
<!-- /.examples -->
128128

129+
<!-- C interface documentation. -->
130+
131+
* * *
132+
133+
<section class="c">
134+
135+
## C APIs
136+
137+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
138+
139+
<section class="intro">
140+
141+
</section>
142+
143+
<!-- /.intro -->
144+
145+
<!-- C usage documentation. -->
146+
147+
<section class="usage">
148+
149+
### Usage
150+
151+
```c
152+
#include "stdlib/stats/base/dists/signrank/pdf.h"
153+
```
154+
155+
#### stdlib_base_dists_signrank_cdf( x, n )
156+
157+
Evaluates the probability density function (PDF) of the Wilcoxon signed rank test statistic with `n` observations.
158+
159+
```c
160+
double out = stdlib_base_dists_signrank_pdf( 7.0, 9 );
161+
// returns ~0.01
162+
```
163+
164+
The function accepts the following arguments:
165+
166+
- **x**: `[in] double` input value.
167+
- **n**: `[in] double` number of observations.
168+
169+
```c
170+
double stdlib_base_dists_signrank_cdf( double x, const double n );
171+
```
172+
173+
</section>
174+
175+
<!-- /.usage -->
176+
177+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
178+
179+
<section class="notes">
180+
181+
</section>
182+
183+
<!-- /.notes -->
184+
185+
<!-- C API usage examples. -->
186+
187+
<section class="examples">
188+
189+
### Examples
190+
191+
```c
192+
#include "stdlib/stats/base/dists/signrank/pdf.h"
193+
#include "stdlib/math/base/special/ceil.h"
194+
#include <stdlib.h>
195+
#include <stdio.h>
196+
197+
static double random_uniform( const double min, const double max ) {
198+
double v = (double)rand() / ( (double)RAND_MAX + 1.0 );
199+
return min + ( v*(max-min) );
200+
}
201+
202+
int main( void ) {
203+
double n;
204+
double x;
205+
double y;
206+
int i;
207+
208+
for ( i = 0; i < 25; i++ ) {
209+
x = random_uniform( 0, 30.0 );
210+
n = stdlib_base_ceil(random_uniform( 1, 30.0 ));
211+
y = stdlib_base_dists_signrank_pdf( x, n );
212+
printf( "x: %lf, n: %lf, F(x;n): %lf\n", x, n, y );
213+
}
214+
}
215+
```
216+
217+
</section>
218+
219+
<!-- /.examples -->
220+
221+
</section>
222+
223+
<!-- /.c -->
224+
129225
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
130226

131227
<section class="related">

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

Lines changed: 20 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -20,53 +20,44 @@
2020

2121
// MODULES //
2222

23+
var resolve = require( 'path' ).resolve;
2324
var bench = require( '@stdlib/bench' );
25+
var Float64Array = require( '@stdlib/array/float64' );
2426
var randu = require( '@stdlib/random/base/randu' );
2527
var ceil = require( '@stdlib/math/base/special/ceil' );
2628
var isnan = require( '@stdlib/math/base/assert/is-nan' );
29+
var tryRequire = require( '@stdlib/utils/try-require' );
2730
var pkg = require( './../package.json' ).name;
28-
var pdf = require( './../lib' );
2931

3032

31-
// MAIN //
33+
// VARIABLES //
3234

33-
bench( pkg, function benchmark( b ) {
34-
var n;
35-
var x;
36-
var y;
37-
var i;
35+
var pdf = tryRequire( resolve( __dirname, './../lib/native.js' ) );
36+
var opts = {
37+
'skip': ( pdf instanceof Error )
38+
};
3839

39-
b.tic();
40-
for ( i = 0; i < b.iterations; i++ ) {
41-
x = randu() * 20.0;
42-
n = ceil( randu()*20.0 );
43-
y = pdf( x, n );
44-
if ( isnan( y ) ) {
45-
b.fail( 'should not return NaN' );
46-
}
47-
}
48-
b.toc();
49-
if ( isnan( y ) ) {
50-
b.fail( 'should not return NaN' );
51-
}
52-
b.pass( 'benchmark finished' );
53-
b.end();
54-
});
5540

56-
bench( pkg+':factory', function benchmark( b ) {
57-
var mypdf;
41+
// MAIN //
42+
43+
bench( pkg, opts, function benchmark( b ) {
44+
var len;
5845
var n;
5946
var x;
6047
var y;
6148
var i;
6249

63-
n = 20;
64-
mypdf = pdf.factory( n );
50+
len = 100;
51+
x = new Float64Array( len );
52+
n = new Float64Array( len );
53+
for ( i = 0; i < len; i++ ) {
54+
x[ i ] = ( randu() * 30.0 );
55+
n[ i ] = ceil( randu() * 30.0 );
56+
}
6557

6658
b.tic();
6759
for ( i = 0; i < b.iterations; i++ ) {
68-
x = randu() * 20.0;
69-
y = mypdf( x );
60+
y = pdf( x[ i % len ], n[ i % len ] );
7061
if ( isnan( y ) ) {
7162
b.fail( 'should not return NaN' );
7263
}
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
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 bench = require( '@stdlib/bench' );
24+
var Float64Array = require( '@stdlib/array/float64' );
25+
var uniform = require( '@stdlib/random/array/uniform' );
26+
var randu = require( '@stdlib/random/base/randu' );
27+
var ceil = require( '@stdlib/math/base/special/ceil' );
28+
var isnan = require( '@stdlib/math/base/assert/is-nan' );
29+
var pkg = require( './../package.json' ).name;
30+
var pdf = require( './../lib' );
31+
32+
33+
// MAIN //
34+
35+
bench( pkg, function benchmark( b ) {
36+
var len;
37+
var n;
38+
var x;
39+
var y;
40+
var i;
41+
42+
len = 100;
43+
x = new Float64Array( len );
44+
n = new Float64Array( len );
45+
for ( i = 0; i < len; i++ ) {
46+
x[ i ] = ( randu() * 30.0 );
47+
n[ i ] = ceil( randu() * 30.0 );
48+
}
49+
50+
b.tic();
51+
for ( i = 0; i < b.iterations; i++ ) {
52+
y = pdf( x[ i % len ], n[ i % len ] );
53+
if ( isnan( y ) ) {
54+
b.fail( 'should not return NaN' );
55+
}
56+
}
57+
b.toc();
58+
if ( isnan( y ) ) {
59+
b.fail( 'should not return NaN' );
60+
}
61+
b.pass( 'benchmark finished' );
62+
b.end();
63+
});
64+
65+
bench( pkg+':factory', function benchmark( b ) {
66+
var mypdf;
67+
var n;
68+
var x;
69+
var y;
70+
var i;
71+
72+
n = 20;
73+
mypdf = pdf.factory( n );
74+
x = uniform( 100, -2.0, 2.0 );
75+
76+
b.tic();
77+
for ( i = 0; i < b.iterations; i++ ) {
78+
y = mypdf( x[ i % x.length] );
79+
if ( isnan( y ) ) {
80+
b.fail( 'should not return NaN' );
81+
}
82+
}
83+
b.toc();
84+
if ( isnan( y ) ) {
85+
b.fail( 'should not return NaN' );
86+
}
87+
b.pass( 'benchmark finished' );
88+
b.end();
89+
});

0 commit comments

Comments
 (0)