Package Exports
- @stdlib/stats-base-ndarray-smax
- @stdlib/stats-base-ndarray-smax/dist
- @stdlib/stats-base-ndarray-smax/dist/index.js
- @stdlib/stats-base-ndarray-smax/lib/index.js
- @stdlib/stats-base-ndarray-smax/lib/main.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@stdlib/stats-base-ndarray-smax) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
smax
Compute the maximum value of a one-dimensional single-precision floating-point ndarray.
Installation
npm install @stdlib/stats-base-ndarray-smaxUsage
var smax = require( '@stdlib/stats-base-ndarray-smax' );smax( arrays )
Computes the maximum value of a one-dimensional single-precision floating-point ndarray.
var Float32Array = require( '@stdlib/array-float32' );
var ndarray = require( '@stdlib/ndarray-base-ctor' );
var xbuf = new Float32Array( [ 1.0, 3.0, 4.0, 2.0 ] );
var x = new ndarray( 'float32', xbuf, [ 4 ], [ 1 ], 0, 'row-major' );
var v = smax( [ x ] );
// returns 4.0The function has the following parameters:
- arrays: array-like object containing a one-dimensional input ndarray.
Notes
- If provided an empty one-dimensional ndarray, the function returns
NaN.
Examples
var discreteUniform = require( '@stdlib/random-array-discrete-uniform' );
var ndarray = require( '@stdlib/ndarray-base-ctor' );
var ndarray2array = require( '@stdlib/ndarray-to-array' );
var smax = require( '@stdlib/stats-base-ndarray-smax' );
var xbuf = discreteUniform( 10, -50, 50, {
'dtype': 'float32'
});
var x = new ndarray( 'float32', xbuf, [ xbuf.length ], [ 1 ], 0, 'row-major' );
console.log( ndarray2array( x ) );
var v = smax( [ x ] );
console.log( v );C APIs
Usage
#include "stdlib/stats/base/ndarray/smax.h"stdlib_stats_smax( arrays )
Computes the maximum value of a one-dimensional single-precision floating-point ndarray.
#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 maximum value:
const struct ndarray *arrays[] = { x };
float v = stdlib_stats_smax( arrays );
// returns 4.0f
// Free allocated memory:
stdlib_ndarray_free( x );The function accepts the following arguments:
- arrays:
[in] struct ndarray**list containing a one-dimensional input ndarray.
float stdlib_stats_smax( const struct ndarray *arrays[] );Examples
#include "stdlib/stats/base/ndarray/smax.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[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.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 maximum value:
float v = stdlib_stats_smax( arrays );
// Print the result:
printf( "max: %f\n", v );
// Free allocated memory:
stdlib_ndarray_free( x );
}Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2026. The Stdlib Authors.