Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
130 changes: 129 additions & 1 deletion lib/node_modules/@stdlib/stats/base/ndarray/dnanmean/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

@license Apache-2.0

Copyright (c) 2025 The Stdlib Authors.
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.
Expand Down Expand Up @@ -117,10 +117,138 @@ console.log( v );

<!-- /.examples -->

* * *

<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/dnanmean.h"
```

#### stdlib_stats_dnanmean( arrays )

Computes the arithmetic mean of a one-dimensional double-precision floating-point ndarray, ignoring `NaN` values.

```c
#include "stdlib/ndarray/ctor.h"
#include "stdlib/ndarray/orders.h"
#include <stdint.h>
#include <stdlib.h>

// Define an array of pointers to ndarrays:
struct ndarray *arrays[ 1 ];

// Create an ndarray:
double x[] = { 1.0, -2.0, 0.0/0.0, 4.0, 5.0, 0.0/0.0, 7.0 };
int64_t nd = 1;
int64_t shape[] = { 7 };
int64_t strides[] = { 1 };
int64_t offset = 0;

struct ndarray *arr = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT64, x, nd, shape, strides, offset, STDLIB_NDARRAY_ROW_MAJOR );
arrays[ 0 ] = arr;

// Compute the arithmetic mean:
double out = stdlib_stats_dnanmean( (const struct ndarray *const *)arrays );

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

The function accepts the following arguments:

- **arrays**: `[in] struct ndarray**` array of pointers to `ndarray` objects.

```c
double stdlib_stats_dnanmean( 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/dnanmean.h"
#include "stdlib/ndarray/ctor.h"
#include "stdlib/ndarray/orders.h"
#include <stdint.h>
#include <stdlib.h>
#include <stdio.h>
#include <inttypes.h>

int main( void ) {
// Define an array of pointers to ndarrays:
struct ndarray *arrays[ 1 ];

// Create an ndarray:
double x[] = { 1.0, -2.0, 0.0/0.0, 4.0, 5.0, 0.0/0.0, 7.0 };
int64_t nd = 1;
int64_t shape[] = { 7 };
int64_t strides[] = { 1 };
int64_t offset = 0;

struct ndarray *arr = stdlib_ndarray_allocate( STDLIB_NDARRAY_FLOAT64, x, nd, shape, strides, offset, STDLIB_NDARRAY_ROW_MAJOR );
if ( arr == NULL ) {
fprintf( stderr, "Error allocating memory.\n" );
exit( 1 );
}
arrays[ 0 ] = arr;

// Compute the arithmetic mean:
double out = stdlib_stats_dnanmean( (const struct ndarray *const *)arrays );

printf( "mean: %lf\n", out );

// Free allocated memory:
stdlib_ndarray_free( arr );

return 0;
}
```

</section>

<!-- /.examples -->

</section>

<!-- /.c -->

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

<section class="related">


</section>

<!-- /.related -->
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var format = require( '@stdlib/string/format' );
var pkg = require( './../package.json' ).name;
var dnanmean = require( './../lib' );
var dnanmean = require( './../lib/main.js' );


// VARIABLES //
Expand Down

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You also need to update the require path in benchmark.js.

Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
/**
* @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/uniform' );
var isnan = require( '@stdlib/math/base/assert/is-nan' );
var pow = require( '@stdlib/math/base/special/pow' );
var format = require( '@stdlib/string/format' );
var tryRequire = require( '@stdlib/utils/try-require' );
var pkg = require( './../package.json' ).name;


// VARIABLES //

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


// FUNCTIONS //

/**
* Creates a benchmark function.
*
* @private
* @param {PositiveInteger} len - array length
* @returns {Function} benchmark function
*/
function createBenchmark( len ) {
var x = uniform( [ len ], -10.0, 10.0, options );
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 = dnanmean( [ x ] );
if ( isnan( v ) ) {
b.fail( 'should not return NaN' );
}
}
b.toc();
if ( isnan( 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
Loading