Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
0ddb958
docs: update README.md
LoayAhmed304 Feb 13, 2026
7032e6c
feat: create c implementation and its structure
LoayAhmed304 Feb 13, 2026
c916bc0
build: create build config files
LoayAhmed304 Feb 13, 2026
df70fb5
chore: update package.json
LoayAhmed304 Feb 13, 2026
1ce6ff7
chore: create native.js and update index.js to add native try/require
LoayAhmed304 Feb 13, 2026
7b41ba0
feat: add c and native benchmarks
LoayAhmed304 Feb 13, 2026
6f3b41e
test: add native tests
LoayAhmed304 Feb 13, 2026
16a76b7
chore: add c examples
LoayAhmed304 Feb 13, 2026
040a143
bench: refactor to use string interpolation
LoayAhmed304 Feb 13, 2026
6db01dc
docs: update copyright years
LoayAhmed304 Feb 13, 2026
47d8925
fix: JS and JSON linting errors
LoayAhmed304 Feb 13, 2026
174ef7d
Update copyright year in index.js example
Sachinn-64 Feb 16, 2026
a46a904
Update copyright year in benchmark.js
Sachinn-64 Feb 16, 2026
9b599a9
Update benchmark.length.c
Sachinn-64 Feb 16, 2026
ca6ebb4
Update benchmark.length.c
Sachinn-64 Feb 16, 2026
b6c42f9
Update index.js
Sachinn-64 Feb 16, 2026
bf57efb
Correct copyright year in test.js
Sachinn-64 Feb 16, 2026
391eeae
docs: fix JSDocs to correctly display the functionality
LoayAhmed304 Feb 16, 2026
b1e5aaf
fix: correctly import the function from main.js in test.main.js
LoayAhmed304 Feb 16, 2026
213848f
refactor: correctly order include statements to match stdlib convention
LoayAhmed304 Feb 16, 2026
2c9fb40
bench: create ordered ndarray instead of randomized one
LoayAhmed304 Feb 16, 2026
6f7f1e2
Update example.c
Sachinn-64 Feb 20, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
147 changes: 147 additions & 0 deletions lib/node_modules/@stdlib/stats/base/ndarray/smediansorted/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,153 @@ console.log( v );

<!-- /.examples -->

<!-- C interface documentation. -->

* * *

<section class="c">

## C APIs

<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->

<section class="intro">

</section>

<!-- /.intro -->

<!-- C usage documentation. -->

<section class="usage">

### Usage

```c
#include "stdlib/stats/base/ndarray/smediansorted.h"
```

#### stdlib_stats_smediansorted( arrays )

> Compute the median value of a sorted one-dimensional single-precision floating-point ndarray.

```c
#include "stdlib/ndarray/ctor.h"
#include "stdlib/ndarray/dtypes.h"
#include "stdlib/ndarray/index_modes.h"
#include "stdlib/ndarray/orders.h"
#include "stdlib/ndarray/base/bytes_per_element.h"
#include <stdint.h>

// Create an ndarray:
const float data[] = { 1.0f, 2.0f, 3.0f, 4.0f };
int64_t shape[] = { 4 };
int64_t strides[] = { STDLIB_NDARRAY_FLOAT32_BYTES_PER_ELEMENT };
int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR };

struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT32, (uint8_t *)data, 1, shape, strides, 0, STDLIB_NDARRAY_ROW_MAJOR, STDLIB_NDARRAY_INDEX_ERROR, 1, submodes );

// Compute the median value:
const struct ndarray *arrays[] = { x };
float v = stdlib_stats_smediansorted( arrays );
// returns 2.5f

// Free allocated memory:
stdlib_ndarray_free( x );
```

The function accepts the following arguments:

- **arrays**: `[in] struct ndarray**` list containing a one-dimensional input ndarray.

```c
float stdlib_stats_smediansorted( const struct ndarray *arrays[] );
```

</section>

<!-- /.usage -->

<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->

<section class="notes">

</section>

<!-- /.notes -->

<!-- C API usage examples. -->

<section class="examples">

### Examples

```c
#include "stdlib/stats/base/ndarray/smediansorted.h"
#include "stdlib/ndarray/ctor.h"
#include "stdlib/ndarray/dtypes.h"
#include "stdlib/ndarray/index_modes.h"
#include "stdlib/ndarray/orders.h"
#include "stdlib/ndarray/base/bytes_per_element.h"
#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>

int main( void ) {
// Create a data buffer:
const float data[] = { -3.0f, -2.0f, 3.0f, 5.0f, 7.0f };

// Specify the number of array dimensions:
const int64_t ndims = 1;

// Specify the array shape:
int64_t shape[] = { 4 };

// Specify the array strides:
int64_t strides[] = { 2*STDLIB_NDARRAY_FLOAT32_BYTES_PER_ELEMENT };

// Specify the byte offset:
const int64_t offset = 0;

// Specify the array order:
const enum STDLIB_NDARRAY_ORDER order = STDLIB_NDARRAY_ROW_MAJOR;

// Specify the index mode:
const enum STDLIB_NDARRAY_INDEX_MODE imode = STDLIB_NDARRAY_INDEX_ERROR;

// Specify the subscript index modes:
int8_t submodes[] = { STDLIB_NDARRAY_INDEX_ERROR };
const int64_t nsubmodes = 1;

// Create an ndarray:
struct ndarray *x = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT32, (uint8_t *)data, ndims, shape, strides, offset, order, imode, nsubmodes, submodes );
if ( x == NULL ) {
fprintf( stderr, "Error allocating memory.\n" );
exit( 1 );
}

// Define a list of ndarrays:
const struct ndarray *arrays[] = { x };

// Compute the median value:
float v = stdlib_stats_smediansorted( arrays );

// Print the result:
printf( "median: %f\n", v );

// Free allocated memory:
stdlib_ndarray_free( x );
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->

<section class="related">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,9 @@ var linspace = require( '@stdlib/array/linspace' );
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
var pow = require( '@stdlib/math/base/special/pow' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var smediansorted = require( './../lib' );
var smediansorted = require( './../lib/main.js' );


// VARIABLES //
Expand Down Expand Up @@ -101,7 +102,7 @@ function main() {
for ( i = min; i <= max; i++ ) {
len = pow( 10, i );
f = createBenchmark( len );
bench( pkg+':len='+len, f );
bench( format( '%s:len=%d', pkg, len ), f );
}
}

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
/**
* @license Apache-2.0
*
* Copyright (c) 2026 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

'use strict';

// MODULES //

var resolve = require( 'path' ).resolve;
var bench = require( '@stdlib/bench' );
var uniform = require( '@stdlib/random/array/uniform' );
var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
var pow = require( '@stdlib/math/base/special/pow' );
var ndarray = require( '@stdlib/ndarray/base/ctor' );
var format = require( '@stdlib/string/format' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

var smediansorted = tryRequire( resolve( __dirname, './../lib/native.js' ) );
var opts = {
'skip': ( smediansorted instanceof Error )
};
var options = {
'dtype': 'float32'
};


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var xbuf;
var x;

xbuf = uniform( len, -10.0, 10.0, options );
x = new ndarray( options.dtype, xbuf, [ len ], [ 1 ], 0, 'row-major' );

return benchmark;

/**
* Benchmark function.
*
* @private
* @param {Benchmark} b - benchmark instance
*/
function benchmark( b ) {
var v;
var i;

b.tic();
for ( i = 0; i < b.iterations; i++ ) {
v = smediansorted( [ x ] );
if ( isnanf( v ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnanf( v ) ) {
b.fail( 'should not return NaN' );
}
b.pass( 'benchmark finished' );
b.end();
}
}


// MAIN //

/**
* Main execution sequence.
*
* @private
*/
function main() {
var len;
var min;
var max;
var f;
var i;

min = 1; // 10^min
max = 6; // 10^max

for ( i = min; i <= max; i++ ) {
len = pow( 10, i );
f = createBenchmark( len );
bench( format( '%s::native:len=%d', pkg, len ), opts, f );
}
}

main();
Loading