Skip to content

Commit b9c545d

Browse files
aayush0325kgrytestdlib-bot
authored
feat: add C ndarray interface and refactor implementation for stats/base/dmediansorted
PR-URL: #4466 Co-authored-by: Athan Reines <[email protected]> Reviewed-by: Athan Reines <[email protected]> Co-authored-by: stdlib-bot <[email protected]>
1 parent b7c2e5d commit b9c545d

26 files changed

+458
-358
lines changed

‎lib/node_modules/@stdlib/stats/base/dmediansorted/README.md

+130-24
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ limitations under the License.
3636
var dmediansorted = require( '@stdlib/stats/base/dmediansorted' );
3737
```
3838

39-
#### dmediansorted( N, x, stride )
39+
#### dmediansorted( N, x, strideX )
4040

4141
Computes the median value of a sorted double-precision floating-point strided array `x`.
4242

@@ -56,18 +56,16 @@ The function has the following parameters:
5656

5757
- **N**: number of indexed elements.
5858
- **x**: sorted input [`Float64Array`][@stdlib/array/float64].
59-
- **stride**: index increment for `x`.
59+
- **strideX**: index increment for `x`.
6060

61-
The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the median value of every other element in `x`,
61+
The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the median value of every other element in `x`,
6262

6363
```javascript
6464
var Float64Array = require( '@stdlib/array/float64' );
65-
var floor = require( '@stdlib/math/base/special/floor' );
6665

6766
var x = new Float64Array( [ 1.0, 2.0, 2.0, -7.0, 3.0, 3.0, 4.0, 2.0 ] );
68-
var N = floor( x.length / 2 );
6967

70-
var v = dmediansorted( N, x, 2 );
68+
var v = dmediansorted( 4, x, 2 );
7169
// returns 2.5
7270
```
7371

@@ -77,28 +75,24 @@ Note that indexing is relative to the first index. To introduce an offset, use [
7775

7876
```javascript
7977
var Float64Array = require( '@stdlib/array/float64' );
80-
var floor = require( '@stdlib/math/base/special/floor' );
8178

8279
var x0 = new Float64Array( [ 2.0, 1.0, 2.0, 2.0, -2.0, 2.0, 3.0, 4.0 ] );
8380
var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
8481

85-
var N = floor( x0.length / 2 );
86-
87-
var v = dmediansorted( N, x1, 2 );
82+
var v = dmediansorted( 4, x1, 2 );
8883
// returns 2.0
8984
```
9085

91-
#### dmediansorted.ndarray( N, x, stride, offset )
86+
#### dmediansorted.ndarray( N, x, strideX, offsetX )
9287

9388
Computes the median value of a sorted double-precision floating-point strided array using alternative indexing semantics.
9489

9590
```javascript
9691
var Float64Array = require( '@stdlib/array/float64' );
9792

9893
var x = new Float64Array( [ 1.0, 2.0, 3.0 ] );
99-
var N = x.length;
10094

101-
var v = dmediansorted.ndarray( N, x, 1, 0 );
95+
var v = dmediansorted.ndarray( x.length, x, 1, 0 );
10296
// returns 2.0
10397
```
10498

@@ -110,12 +104,10 @@ While [`typed array`][mdn-typed-array] views mandate a view offset based on the
110104

111105
```javascript
112106
var Float64Array = require( '@stdlib/array/float64' );
113-
var floor = require( '@stdlib/math/base/special/floor' );
114107

115108
var x = new Float64Array( [ 2.0, 1.0, 2.0, 2.0, -2.0, 2.0, 3.0, 4.0 ] );
116-
var N = floor( x.length / 2 );
117109

118-
var v = dmediansorted.ndarray( N, x, 2, 1 );
110+
var v = dmediansorted.ndarray( 4, x, 2, 1 );
119111
// returns 2.0
120112
```
121113

@@ -141,16 +133,13 @@ var v = dmediansorted.ndarray( N, x, 2, 1 );
141133
<!-- eslint no-undef: "error" -->
142134

143135
```javascript
144-
var Float64Array = require( '@stdlib/array/float64' );
136+
var linspace = require( '@stdlib/array/linspace' );
145137
var dmediansorted = require( '@stdlib/stats/base/dmediansorted' );
146138

147-
var x;
148-
var i;
149-
150-
x = new Float64Array( 10 );
151-
for ( i = 0; i < x.length; i++ ) {
152-
x[ i ] = i - 5.0;
153-
}
139+
var options = {
140+
'dtype': 'float64'
141+
};
142+
var x = linspace( -5.0, 5.0, 10, options );
154143
console.log( x );
155144

156145
var v = dmediansorted( x.length, x, 1 );
@@ -161,6 +150,123 @@ console.log( v );
161150

162151
<!-- /.examples -->
163152

153+
<!-- C interface documentation. -->
154+
155+
* * *
156+
157+
<section class="c">
158+
159+
## C APIs
160+
161+
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
162+
163+
<section class="intro">
164+
165+
</section>
166+
167+
<!-- /.intro -->
168+
169+
<!-- C usage documentation. -->
170+
171+
<section class="usage">
172+
173+
### Usage
174+
175+
```c
176+
#include "stdlib/stats/base/dmediansorted.h"
177+
```
178+
179+
#### stdlib_strided_dmediansorted( N, \*X, strideX )
180+
181+
Computes the median value of a sorted double-precision floating-point strided array.
182+
183+
```c
184+
const double x[] = { 1.0, 2.0, 3.0 };
185+
186+
double v = stdlib_strided_dmediansorted( 3, x, 1 );
187+
// returns 2.0
188+
```
189+
190+
The function accepts the following arguments:
191+
192+
- **N**: `[in] CBLAS_INT` number of indexed elements.
193+
- **X**: `[in] double*` input array.
194+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
195+
196+
```c
197+
double stdlib_strided_dmediansorted( const CBLAS_INT N, const double *X, const CBLAS_INT strideX );
198+
```
199+
200+
#### stdlib_strided_dmediansorted_ndarray( N, \*X, strideX, offsetX )
201+
202+
Computes the median value of a sorted double-precision floating-point strided array using alternative indexing semantics.
203+
204+
```c
205+
const double x[] = { 1.0, 2.0, 3.0 };
206+
207+
double v = stdlib_strided_dmediansorted_ndarray( 3, x, 1, 0 );
208+
// returns 2.0
209+
```
210+
211+
The function accepts the following arguments:
212+
213+
- **N**: `[in] CBLAS_INT` number of indexed elements.
214+
- **X**: `[in] double*` input array.
215+
- **strideX**: `[in] CBLAS_INT` stride length for `X`.
216+
- **offsetX**: `[in] CBLAS_INT` starting index for `X`.
217+
218+
```c
219+
double stdlib_strided_dmediansorted_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
220+
```
221+
222+
</section>
223+
224+
<!-- /.usage -->
225+
226+
<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
227+
228+
<section class="notes">
229+
230+
</section>
231+
232+
<!-- /.notes -->
233+
234+
<!-- C API usage examples. -->
235+
236+
<section class="examples">
237+
238+
### Examples
239+
240+
```c
241+
#include "stdlib/stats/base/dmediansorted.h"
242+
#include <stdio.h>
243+
244+
int main( void ) {
245+
// Create a strided array:
246+
const double x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
247+
248+
// Specify the number of elements:
249+
const int N = 4;
250+
251+
// Specify the stride length:
252+
const int strideX = 2;
253+
254+
// Compute the median value:
255+
double v = stdlib_strided_dmediansorted( N, x, strideX );
256+
257+
// Print the result:
258+
printf( "median: %lf\n", v );
259+
}
260+
```
261+
262+
</section>
263+
264+
<!-- /.examples -->
265+
266+
</section>
267+
268+
<!-- /.c -->
269+
164270
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
165271
166272
<section class="related">

‎lib/node_modules/@stdlib/stats/base/dmediansorted/benchmark/benchmark.js

+9-8
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,19 @@
2222

2323
var bench = require( '@stdlib/bench' );
2424
var isnan = require( '@stdlib/math/base/assert/is-nan' );
25+
var linspace = require( '@stdlib/array/linspace' );
2526
var pow = require( '@stdlib/math/base/special/pow' );
26-
var Float64Array = require( '@stdlib/array/float64' );
2727
var pkg = require( './../package.json' ).name;
2828
var dmediansorted = require( './../lib/dmediansorted.js' );
2929

3030

31+
// VARIABLES //
32+
33+
var options = {
34+
'dtype': 'float64'
35+
};
36+
37+
3138
// FUNCTIONS //
3239

3340
/**
@@ -38,13 +45,7 @@ var dmediansorted = require( './../lib/dmediansorted.js' );
3845
* @returns {Function} benchmark function
3946
*/
4047
function createBenchmark( len ) {
41-
var x;
42-
var i;
43-
44-
x = new Float64Array( len );
45-
for ( i = 0; i < x.length; i++ ) {
46-
x[ i ] = i;
47-
}
48+
var x = linspace( -len/2, len/2, len, options );
4849
return benchmark;
4950

5051
function benchmark( b ) {

‎lib/node_modules/@stdlib/stats/base/dmediansorted/benchmark/benchmark.native.js

+5-8
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
2525
var isnan = require( '@stdlib/math/base/assert/is-nan' );
26+
var linspace = require( '@stdlib/array/linspace' );
2627
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float64Array = require( '@stdlib/array/float64' );
2828
var tryRequire = require( '@stdlib/utils/try-require' );
2929
var pkg = require( './../package.json' ).name;
3030

@@ -35,6 +35,9 @@ var dmediansorted = tryRequire( resolve( __dirname, './../lib/dmediansorted.nati
3535
var opts = {
3636
'skip': ( dmediansorted instanceof Error )
3737
};
38+
var options = {
39+
'dtype': 'float64'
40+
};
3841

3942

4043
// FUNCTIONS //
@@ -47,13 +50,7 @@ var opts = {
4750
* @returns {Function} benchmark function
4851
*/
4952
function createBenchmark( len ) {
50-
var x;
51-
var i;
52-
53-
x = new Float64Array( len );
54-
for ( i = 0; i < x.length; i++ ) {
55-
x[ i ] = i;
56-
}
53+
var x = linspace( -len/2, len/2, len, options );
5754
return benchmark;
5855

5956
function benchmark( b ) {

‎lib/node_modules/@stdlib/stats/base/dmediansorted/benchmark/benchmark.ndarray.js

+9-8
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,19 @@
2222

2323
var bench = require( '@stdlib/bench' );
2424
var isnan = require( '@stdlib/math/base/assert/is-nan' );
25+
var linspace = require( '@stdlib/array/linspace' );
2526
var pow = require( '@stdlib/math/base/special/pow' );
26-
var Float64Array = require( '@stdlib/array/float64' );
2727
var pkg = require( './../package.json' ).name;
2828
var dmediansorted = require( './../lib/ndarray.js' );
2929

3030

31+
// VARIABLES //
32+
33+
var options = {
34+
'dtype': 'float64'
35+
};
36+
37+
3138
// FUNCTIONS //
3239

3340
/**
@@ -38,13 +45,7 @@ var dmediansorted = require( './../lib/ndarray.js' );
3845
* @returns {Function} benchmark function
3946
*/
4047
function createBenchmark( len ) {
41-
var x;
42-
var i;
43-
44-
x = new Float64Array( len );
45-
for ( i = 0; i < x.length; i++ ) {
46-
x[ i ] = i;
47-
}
48+
var x = linspace( -len/2, len/2, len, options );
4849
return benchmark;
4950

5051
function benchmark( b ) {

‎lib/node_modules/@stdlib/stats/base/dmediansorted/benchmark/benchmark.ndarray.native.js

+5-8
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@
2323
var resolve = require( 'path' ).resolve;
2424
var bench = require( '@stdlib/bench' );
2525
var isnan = require( '@stdlib/math/base/assert/is-nan' );
26+
var linspace = require( '@stdlib/array/linspace' );
2627
var pow = require( '@stdlib/math/base/special/pow' );
27-
var Float64Array = require( '@stdlib/array/float64' );
2828
var tryRequire = require( '@stdlib/utils/try-require' );
2929
var pkg = require( './../package.json' ).name;
3030

@@ -35,6 +35,9 @@ var dmediansorted = tryRequire( resolve( __dirname, './../lib/ndarray.native.js'
3535
var opts = {
3636
'skip': ( dmediansorted instanceof Error )
3737
};
38+
var options = {
39+
'dtype': 'float64'
40+
};
3841

3942

4043
// FUNCTIONS //
@@ -47,13 +50,7 @@ var opts = {
4750
* @returns {Function} benchmark function
4851
*/
4952
function createBenchmark( len ) {
50-
var x;
51-
var i;
52-
53-
x = new Float64Array( len );
54-
for ( i = 0; i < x.length; i++ ) {
55-
x[ i ] = i;
56-
}
53+
var x = linspace( -len/2, len/2, len, options );
5754
return benchmark;
5855

5956
function benchmark( b ) {

0 commit comments

Comments
 (0)