From 0045365a074e432ff35ddb69a171c7d613cc6bba Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Wed, 25 Dec 2024 22:37:15 +0000 Subject: [PATCH 1/3] feat: add C ndarray interface and refactor implementation --- .../@stdlib/stats/base/smax/include.gypi | 2 +- .../smax/include/stdlib/stats/base/smax.h | 9 +- .../@stdlib/stats/base/smax/lib/index.js | 7 +- .../@stdlib/stats/base/smax/lib/ndarray.js | 18 ++- .../stats/base/smax/lib/ndarray.native.js | 20 +-- .../@stdlib/stats/base/smax/lib/smax.js | 40 +----- .../stats/base/smax/lib/smax.native.js | 9 +- .../@stdlib/stats/base/smax/manifest.json | 72 ++++++++++- .../@stdlib/stats/base/smax/src/addon.c | 60 +++++++++ .../@stdlib/stats/base/smax/src/addon.cpp | 117 ------------------ .../stats/base/smax/src/{smax.c => main.c} | 43 ++++--- 11 files changed, 189 insertions(+), 208 deletions(-) create mode 100644 lib/node_modules/@stdlib/stats/base/smax/src/addon.c delete mode 100644 lib/node_modules/@stdlib/stats/base/smax/src/addon.cpp rename lib/node_modules/@stdlib/stats/base/smax/src/{smax.c => main.c} (52%) diff --git a/lib/node_modules/@stdlib/stats/base/smax/include.gypi b/lib/node_modules/@stdlib/stats/base/smax/include.gypi index 868c5c12e852..26476a8c2655 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/include.gypi +++ b/lib/node_modules/@stdlib/stats/base/smax/include.gypi @@ -36,7 +36,7 @@ # Source files: 'src_files': [ - '<(src_dir)/addon.cpp', + '<(src_dir)/addon.c', ' +#include "stdlib/blas/base/shared.h" /* * If C++, prevent name mangling so that the compiler emits a binary file having undecorated names, thus mirroring the behavior of a C compiler. @@ -31,7 +31,12 @@ extern "C" { /** * Computes the maximum value of a single-precision floating-point strided array. */ -float stdlib_strided_smax( const int64_t N, const float *X, const int64_t stride ); +float API_SUFFIX(stdlib_strided_smax)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX ); + +/** +* Computes the maximum value of a single-precision floating-point strided array using alternative indexing semantics. +*/ +float API_SUFFIX(stdlib_strided_smax_ndarray)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); #ifdef __cplusplus } diff --git a/lib/node_modules/@stdlib/stats/base/smax/lib/index.js b/lib/node_modules/@stdlib/stats/base/smax/lib/index.js index b574525b9391..bf7c0e580ff2 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/smax/lib/index.js @@ -28,20 +28,17 @@ * var smax = require( '@stdlib/stats/base/smax' ); * * var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); -* var N = x.length; * -* var v = smax( N, x, 1 ); +* var v = smax( x.length, x, 1 ); * // returns 2.0 * * @example * var Float32Array = require( '@stdlib/array/float32' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * var smax = require( '@stdlib/stats/base/smax' ); * * var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); -* var N = floor( x.length / 2 ); * -* var v = smax.ndarray( N, x, 2, 1 ); +* var v = smax.ndarray( 4, x, 2, 1 ); * // returns 4.0 */ diff --git a/lib/node_modules/@stdlib/stats/base/smax/lib/ndarray.js b/lib/node_modules/@stdlib/stats/base/smax/lib/ndarray.js index bb0c646dd795..95d0c646c0b9 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/lib/ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/smax/lib/ndarray.js @@ -31,21 +31,19 @@ var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float32Array} x - input array -* @param {integer} stride - stride length -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} maximum value * * @example * var Float32Array = require( '@stdlib/array/float32' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * * var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); -* var N = floor( x.length / 2 ); * -* var v = smax( N, x, 2, 1 ); +* var v = smax( 4, x, 2, 1 ); * // returns 4.0 */ -function smax( N, x, stride, offset ) { +function smax( N, x, strideX, offsetX ) { var max; var ix; var v; @@ -54,13 +52,13 @@ function smax( N, x, stride, offset ) { if ( N <= 0 ) { return NaN; } - if ( N === 1 || stride === 0 ) { - return x[ offset ]; + if ( N === 1 || strideX === 0 ) { + return x[ offsetX ]; } - ix = offset; + ix = offsetX; max = x[ ix ]; for ( i = 1; i < N; i++ ) { - ix += stride; + ix += strideX; v = x[ ix ]; if ( isnanf( v ) ) { return v; diff --git a/lib/node_modules/@stdlib/stats/base/smax/lib/ndarray.native.js b/lib/node_modules/@stdlib/stats/base/smax/lib/ndarray.native.js index a7210fcf0112..cde0e61789e9 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/smax/lib/ndarray.native.js @@ -20,8 +20,7 @@ // MODULES // -var Float32Array = require( '@stdlib/array/float32' ); -var addon = require( './smax.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // @@ -31,27 +30,20 @@ var addon = require( './smax.native.js' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float32Array} x - input array -* @param {integer} stride - stride length -* @param {NonNegativeInteger} offset - starting index +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index * @returns {number} maximum value * * @example * var Float32Array = require( '@stdlib/array/float32' ); -* var floor = require( '@stdlib/math/base/special/floor' ); * * var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); -* var N = floor( x.length / 2 ); * -* var v = smax( N, x, 2, 1 ); +* var v = smax( 4, x, 2, 1 ); * // returns 4.0 */ -function smax( N, x, stride, offset ) { - var view; - if ( stride < 0 ) { - offset += (N-1) * stride; - } - view = new Float32Array( x.buffer, x.byteOffset+(x.BYTES_PER_ELEMENT*offset), x.length-offset ); // eslint-disable-line max-len - return addon( N, view, stride ); +function smax( N, x, strideX, offsetX ) { + return addon.ndarray( N, x, strideX, offsetX ); } diff --git a/lib/node_modules/@stdlib/stats/base/smax/lib/smax.js b/lib/node_modules/@stdlib/stats/base/smax/lib/smax.js index b6ccd2df7d49..25e9252848ce 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/lib/smax.js +++ b/lib/node_modules/@stdlib/stats/base/smax/lib/smax.js @@ -20,8 +20,8 @@ // MODULES // -var isnanf = require( '@stdlib/math/base/assert/is-nanf' ); -var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var ndarray = require( './ndarray.js' ); // MAIN // @@ -31,47 +31,19 @@ var isPositiveZerof = require( '@stdlib/math/base/assert/is-positive-zerof' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float32Array} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} maximum value * * @example * var Float32Array = require( '@stdlib/array/float32' ); * * var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); -* var N = x.length; * -* var v = smax( N, x, 1 ); +* var v = smax( x.length, x, 1 ); * // returns 2.0 */ -function smax( N, x, stride ) { - var max; - var ix; - var v; - var i; - - if ( N <= 0 ) { - return NaN; - } - if ( N === 1 || stride === 0 ) { - return x[ 0 ]; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; - } - max = x[ ix ]; - for ( i = 1; i < N; i++ ) { - ix += stride; - v = x[ ix ]; - if ( isnanf( v ) ) { - return v; - } - if ( v > max || ( v === max && isPositiveZerof( v ) ) ) { - max = v; - } - } - return max; +function smax( N, x, strideX ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ) ); } diff --git a/lib/node_modules/@stdlib/stats/base/smax/lib/smax.native.js b/lib/node_modules/@stdlib/stats/base/smax/lib/smax.native.js index 39848f633e3f..a34b6d06b14f 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/lib/smax.native.js +++ b/lib/node_modules/@stdlib/stats/base/smax/lib/smax.native.js @@ -30,20 +30,19 @@ var addon = require( './../src/addon.node' ); * * @param {PositiveInteger} N - number of indexed elements * @param {Float32Array} x - input array -* @param {integer} stride - stride length +* @param {integer} strideX - stride length * @returns {number} maximum value * * @example * var Float32Array = require( '@stdlib/array/float32' ); * * var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); -* var N = x.length; * -* var v = smax( N, x, 1 ); +* var v = smax( x.length, x, 1 ); * // returns 2.0 */ -function smax( N, x, stride ) { - return addon( N, x, stride ); +function smax( N, x, strideX ) { + return addon( N, x, strideX ); } diff --git a/lib/node_modules/@stdlib/stats/base/smax/manifest.json b/lib/node_modules/@stdlib/stats/base/smax/manifest.json index b87a47527b6c..f18911fa0a19 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/manifest.json +++ b/lib/node_modules/@stdlib/stats/base/smax/manifest.json @@ -1,5 +1,8 @@ { - "options": {}, + "options": { + "task": "build", + "wasm": false + }, "fields": [ { "field": "src", @@ -24,17 +27,78 @@ ], "confs": [ { + "task": "build", + "wasm": false, "src": [ - "./src/smax.c" + "./src/main.c" ], "include": [ "./include" ], - "libraries": [ - "-lm" + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/math/base/assert/is-positive-zerof", + "@stdlib/math/base/assert/is-nanf", + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-strided-float32array", + "@stdlib/napi/create-double" + ] + }, + { + "task": "benchmark", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/math/base/assert/is-nanf", + "@stdlib/math/base/assert/is-positive-zerof" + ] + }, + { + "task": "examples", + "wasm": false, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/math/base/assert/is-nanf", + "@stdlib/math/base/assert/is-positive-zerof" + ] + }, + { + "task": "", + "wasm": true, + "src": [ + "./src/main.c" + ], + "include": [ + "./include" ], + "libraries": [], "libpath": [], "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", "@stdlib/math/base/assert/is-nanf", "@stdlib/math/base/assert/is-positive-zerof" ] diff --git a/lib/node_modules/@stdlib/stats/base/smax/src/addon.c b/lib/node_modules/@stdlib/stats/base/smax/src/addon.c new file mode 100644 index 000000000000..efe83f11e005 --- /dev/null +++ b/lib/node_modules/@stdlib/stats/base/smax/src/addon.c @@ -0,0 +1,60 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2024 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. +*/ + +#include "stdlib/stats/base/smax.h" +#include "stdlib/napi/export.h" +#include "stdlib/napi/argv.h" +#include "stdlib/napi/argv_int64.h" +#include "stdlib/napi/argv_strided_float32array.h" +#include "stdlib/napi/create_double.h" +#include + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 3 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_CREATE_DOUBLE( env, (double)stdlib_strided_smax( N, X, strideX ), v ); + return v; +} + +/** +* Receives JavaScript callback invocation data. +* +* @param env environment under which the function is invoked +* @param info callback data +* @return Node-API value +*/ +static napi_value addon_method( napi_env env, napi_callback_info info ) { + STDLIB_NAPI_ARGV( env, info, argv, argc, 4 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 3 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_CREATE_DOUBLE( env, (double)stdlib_strided_smax_ndarray( N, X, strideX, offsetX ), v ); + return v; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) diff --git a/lib/node_modules/@stdlib/stats/base/smax/src/addon.cpp b/lib/node_modules/@stdlib/stats/base/smax/src/addon.cpp deleted file mode 100644 index 99e6555bae40..000000000000 --- a/lib/node_modules/@stdlib/stats/base/smax/src/addon.cpp +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2020 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. -*/ - -#include "stdlib/stats/base/smax.h" -#include -#include -#include -#include -#include - -/** -* Add-on namespace. -*/ -namespace stdlib_stats_base_smax { - - /** - * Computes the maximum value of a single-precision floating-point strided array. - * - * ## Notes - * - * - When called from JavaScript, the function expects three arguments: - * - * - `N`: number of indexed elements - * - `X`: input array - * - `stride`: stride length - */ - napi_value node_smax( napi_env env, napi_callback_info info ) { - napi_status status; - - size_t argc = 3; - napi_value argv[ 3 ]; - status = napi_get_cb_info( env, info, &argc, argv, nullptr, nullptr ); - assert( status == napi_ok ); - - if ( argc < 3 ) { - napi_throw_error( env, nullptr, "invalid invocation. Must provide 3 arguments." ); - return nullptr; - } - - napi_valuetype vtype0; - status = napi_typeof( env, argv[ 0 ], &vtype0 ); - assert( status == napi_ok ); - if ( vtype0 != napi_number ) { - napi_throw_type_error( env, nullptr, "invalid argument. First argument must be a number." ); - return nullptr; - } - - bool res; - status = napi_is_typedarray( env, argv[ 1 ], &res ); - assert( status == napi_ok ); - if ( res == false ) { - napi_throw_type_error( env, nullptr, "invalid argument. Second argument must be a Float32Array." ); - return nullptr; - } - - napi_valuetype vtype2; - status = napi_typeof( env, argv[ 2 ], &vtype2 ); - assert( status == napi_ok ); - if ( vtype2 != napi_number ) { - napi_throw_type_error( env, nullptr, "invalid argument. Third argument must be a number." ); - return nullptr; - } - - int64_t N; - status = napi_get_value_int64( env, argv[ 0 ], &N ); - assert( status == napi_ok ); - - int64_t stride; - status = napi_get_value_int64( env, argv[ 2 ], &stride ); - assert( status == napi_ok ); - - napi_typedarray_type vtype1; - size_t xlen; - void *X; - status = napi_get_typedarray_info( env, argv[ 1 ], &vtype1, &xlen, &X, nullptr, nullptr ); - assert( status == napi_ok ); - if ( vtype1 != napi_float32_array ) { - napi_throw_type_error( env, nullptr, "invalid argument. Second argument must be a Float32Array." ); - return nullptr; - } - if ( (N-1)*llabs(stride) >= (int64_t)xlen ) { - napi_throw_range_error( env, nullptr, "invalid argument. Second argument has insufficient elements based on the associated stride and the number of indexed elements." ); - return nullptr; - } - - napi_value v; - status = napi_create_double( env, (double)stdlib_strided_smax( N, (float *)X, stride ), &v ); - assert( status == napi_ok ); - - return v; - } - - napi_value Init( napi_env env, napi_value exports ) { - napi_status status; - napi_value fcn; - status = napi_create_function( env, "exports", NAPI_AUTO_LENGTH, node_smax, NULL, &fcn ); - assert( status == napi_ok ); - return fcn; - } - - NAPI_MODULE( NODE_GYP_MODULE_NAME, Init ) -} // end namespace stdlib_stats_base_smax diff --git a/lib/node_modules/@stdlib/stats/base/smax/src/smax.c b/lib/node_modules/@stdlib/stats/base/smax/src/main.c similarity index 52% rename from lib/node_modules/@stdlib/stats/base/smax/src/smax.c rename to lib/node_modules/@stdlib/stats/base/smax/src/main.c index 345a46a8c156..c68f223364ff 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/src/smax.c +++ b/lib/node_modules/@stdlib/stats/base/smax/src/main.c @@ -19,36 +19,47 @@ #include "stdlib/stats/base/smax.h" #include "stdlib/math/base/assert/is_nanf.h" #include "stdlib/math/base/assert/is_positive_zerof.h" -#include +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/stride2offset.h" /** * Computes the maximum value of a single-precision floating-point strided array. * -* @param N number of indexed elements -* @param X input array -* @param stride stride length -* @return output value +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @return output value */ -float stdlib_strided_smax( const int64_t N, const float *X, const int64_t stride ) { - int64_t ix; - int64_t i; +float API_SUFFIX(stdlib_strided_smax)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX ) { + const CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + return API_SUFFIX(stdlib_strided_smax_ndarray)( N, X, strideX, ox ); +} + +/** +* Computes the maximum value of a single-precision floating-point strided array using alternative indexing semantics. +* +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @param offsetX starting index for X +* @return output value +*/ +float API_SUFFIX(stdlib_strided_smax_ndarray)( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ) { + CBLAS_INT ix; + CBLAS_INT i; float max; float v; if ( N <= 0 ) { return 0.0 / 0.0; // NaN } - if ( N == 1 || stride == 0 ) { - return X[ 0 ]; - } - if ( stride < 0 ) { - ix = (1-N) * stride; - } else { - ix = 0; + if ( N == 1 || strideX == 0 ) { + return X[ offsetX ]; } + ix = offsetX; max = X[ ix ]; for ( i = 1; i < N; i++ ) { - ix += stride; + ix += strideX; v = X[ ix ]; if ( stdlib_base_is_nanf( v ) ) { return v; From 76ec178f7f9e4b00aee6857815f5ce10abfe5be9 Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Thu, 26 Dec 2024 13:46:03 +0000 Subject: [PATCH 2/3] refactor: update tests, docs, examples and benchmarks --- 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: na - task: lint_package_json status: na - task: lint_repl_help status: passed - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: passed - 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: na - 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: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed --- --- .../stats/base/smax/benchmark/benchmark.js | 18 +++---- .../base/smax/benchmark/benchmark.native.js | 14 ++---- .../base/smax/benchmark/benchmark.ndarray.js | 18 +++---- .../benchmark/benchmark.ndarray.native.js | 14 ++---- .../base/smax/benchmark/c/benchmark.length.c | 50 ++++++++++++++++++- .../@stdlib/stats/base/smax/docs/repl.txt | 27 +++++----- .../stats/base/smax/docs/types/index.d.ts | 12 ++--- .../stats/base/smax/examples/c/example.c | 8 +-- .../@stdlib/stats/base/smax/examples/index.js | 14 ++---- .../stats/base/smax/test/test.ndarray.js | 13 ++--- .../base/smax/test/test.ndarray.native.js | 13 ++--- .../@stdlib/stats/base/smax/test/test.smax.js | 13 ++--- .../stats/base/smax/test/test.smax.native.js | 13 ++--- 13 files changed, 114 insertions(+), 113 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.js index 31c25924e2b4..ad5178e1e0bf 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.js @@ -21,14 +21,20 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float32Array = require( '@stdlib/array/float32' ); var pkg = require( './../package.json' ).name; var smax = require( './../lib/smax.js' ); +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + // FUNCTIONS // /** @@ -39,13 +45,7 @@ var smax = require( './../lib/smax.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = new Float32Array( len ); - for ( i = 0; i < x.length; i++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.native.js index c48e045f013e..c87c51ffad1f 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.native.js @@ -22,10 +22,9 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float32Array = require( '@stdlib/array/float32' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -36,6 +35,9 @@ var smax = tryRequire( resolve( __dirname, './../lib/smax.native.js' ) ); var opts = { 'skip': ( smax instanceof Error ) }; +var options = { + 'dtype': 'float32' +}; // FUNCTIONS // @@ -48,13 +50,7 @@ var opts = { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = new Float32Array( len ); - for ( i = 0; i < x.length; i++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.ndarray.js index 6e5764a3f526..8195f6a93d46 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.ndarray.js @@ -21,14 +21,20 @@ // MODULES // var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float32Array = require( '@stdlib/array/float32' ); var pkg = require( './../package.json' ).name; var smax = require( './../lib/ndarray.js' ); +// VARIABLES // + +var options = { + 'dtype': 'float32' +}; + + // FUNCTIONS // /** @@ -39,13 +45,7 @@ var smax = require( './../lib/ndarray.js' ); * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = new Float32Array( len ); - for ( i = 0; i < x.length; i++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.ndarray.native.js index e743fec80750..6121bfeddbff 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/smax/benchmark/benchmark.ndarray.native.js @@ -22,10 +22,9 @@ var resolve = require( 'path' ).resolve; var bench = require( '@stdlib/bench' ); -var randu = require( '@stdlib/random/base/randu' ); +var uniform = require( '@stdlib/random/array/uniform' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var pow = require( '@stdlib/math/base/special/pow' ); -var Float32Array = require( '@stdlib/array/float32' ); var tryRequire = require( '@stdlib/utils/try-require' ); var pkg = require( './../package.json' ).name; @@ -36,6 +35,9 @@ var smax = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); var opts = { 'skip': ( smax instanceof Error ) }; +var options = { + 'dtype': 'float32' +}; // FUNCTIONS // @@ -48,13 +50,7 @@ var opts = { * @returns {Function} benchmark function */ function createBenchmark( len ) { - var x; - var i; - - x = new Float32Array( len ); - for ( i = 0; i < x.length; i++ ) { - x[ i ] = ( randu()*20.0 ) - 10.0; - } + var x = uniform( len, -10.0, 10.0, options ); return benchmark; function benchmark( b ) { diff --git a/lib/node_modules/@stdlib/stats/base/smax/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/stats/base/smax/benchmark/c/benchmark.length.c index 66dae835f79a..954b6cd54e2c 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/stats/base/smax/benchmark/c/benchmark.length.c @@ -94,7 +94,7 @@ static float rand_float( void ) { * @param len array length * @return elapsed time in seconds */ -static double benchmark( int iterations, int len ) { +static double benchmark1( int iterations, int len ) { double elapsed; float x[ len ]; float v; @@ -107,6 +107,7 @@ static double benchmark( int iterations, int len ) { v = 0.0f; t = tic(); for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar v = stdlib_strided_smax( len, x, 1 ); if ( v != v ) { printf( "should not return NaN\n" ); @@ -120,6 +121,40 @@ static double benchmark( int iterations, int len ) { return elapsed; } +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark2( int iterations, int len ) { + double elapsed; + float x[ len ]; + float v; + double t; + int i; + + for ( i = 0; i < len; i++ ) { + x[ i ] = ( rand_float()*20000.0f ) - 10000.0f; + } + v = 0.0f; + t = tic(); + for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar + v = stdlib_strided_smax_ndarray( len, x, 1, 0 ); + if ( v != v ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( v != v ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + /** * Main execution sequence. */ @@ -142,7 +177,18 @@ int main( void ) { for ( j = 0; j < REPEATS; j++ ) { count += 1; printf( "# c::%s:len=%d\n", NAME, len ); - elapsed = benchmark( iter, len ); + elapsed = benchmark1( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + for ( i = MIN; i <= MAX; i++ ) { + len = pow( 10, i ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:ndarray:len=%d\n", NAME, len ); + elapsed = benchmark2( iter, len ); print_results( iter, elapsed ); printf( "ok %d benchmark finished\n", count ); } diff --git a/lib/node_modules/@stdlib/stats/base/smax/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/smax/docs/repl.txt index 38a7c0a93c72..447df52534d7 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/smax/docs/repl.txt @@ -1,9 +1,9 @@ -{{alias}}( N, x, stride ) +{{alias}}( N, x, strideX ) Computes the maximum value of a single-precision floating-point strided array. - The `N` and `stride` parameters determine which elements in `x` are accessed + The `N` and stride parameters determine which elements in `x` are accessed at runtime. Indexing is relative to the first index. To introduce an offset, use a typed @@ -19,8 +19,8 @@ x: Float32Array Input array. - stride: integer - Index increment. + strideX: integer + Stride Length. Returns ------- @@ -34,22 +34,19 @@ > {{alias}}( x.length, x, 1 ) 2.0 - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = new {{alias:@stdlib/array/float32}}( [ -2.0, 1.0, 1.0, -5.0, 2.0, -1.0 ] ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > var stride = 2; - > {{alias}}( N, x, stride ) + > {{alias}}( 3, x, 2 ) 2.0 // Using view offsets: > var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, 2.0, 5.0, -1.0 ] ); > var x1 = new {{alias:@stdlib/array/float32}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); - > N = {{alias:@stdlib/math/base/special/floor}}( x0.length / 2 ); - > stride = 2; - > {{alias}}( N, x1, stride ) + > {{alias}}( 3, x1, 2 ) 2.0 -{{alias}}.ndarray( N, x, stride, offset ) + +{{alias}}.ndarray( N, x, strideX, offsetX ) Computes the maximum value of a single-precision floating-point strided array using alternative indexing semantics. @@ -65,10 +62,10 @@ x: Float32Array Input array. - stride: integer - Index increment. + strideX: integer + Stride Length. - offset: integer + offsetX: integer Starting index. Returns diff --git a/lib/node_modules/@stdlib/stats/base/smax/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/smax/docs/types/index.d.ts index cf2cd8b9712f..8f01b165bfb3 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/smax/docs/types/index.d.ts @@ -27,7 +27,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length + * @param strideX - stride length * @returns maximum value * * @example @@ -38,15 +38,15 @@ interface Routine { * var v = smax( x.length, x, 1 ); * // returns 2.0 */ - ( N: number, x: Float32Array, stride: number ): number; + ( N: number, x: Float32Array, strideX: number ): number; /** * Computes the maximum value of a single-precision floating-point strided array using alternative indexing semantics. * * @param N - number of indexed elements * @param x - input array - * @param stride - stride length - * @param offset - starting index + * @param strideX - stride length + * @param offsetX - starting index * @returns maximum value * * @example @@ -57,7 +57,7 @@ interface Routine { * var v = smax.ndarray( x.length, x, 1, 0 ); * // returns 2.0 */ - ndarray( N: number, x: Float32Array, stride: number, offset: number ): number; + ndarray( N: number, x: Float32Array, strideX: number, offsetX: number ): number; } /** @@ -65,7 +65,7 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array -* @param stride - stride length +* @param strideX - stride length * @returns maximum value * * @example diff --git a/lib/node_modules/@stdlib/stats/base/smax/examples/c/example.c b/lib/node_modules/@stdlib/stats/base/smax/examples/c/example.c index 4f24b01db6e7..d13581783eb4 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/examples/c/example.c +++ b/lib/node_modules/@stdlib/stats/base/smax/examples/c/example.c @@ -22,16 +22,16 @@ int main( void ) { // Create a strided array: - float x[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 }; + const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f }; // Specify the number of elements: - int64_t N = 4; + const int N = 4; // Specify the stride length: - int64_t stride = 2; + const int strideX = 2; // Compute the maximum value: - float v = stdlib_strided_smax( N, x, stride ); + float v = stdlib_strided_smax( N, x, strideX ); // Print the result: printf( "max: %f\n", v ); diff --git a/lib/node_modules/@stdlib/stats/base/smax/examples/index.js b/lib/node_modules/@stdlib/stats/base/smax/examples/index.js index d74e560d9fb5..5685900db370 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/examples/index.js +++ b/lib/node_modules/@stdlib/stats/base/smax/examples/index.js @@ -18,18 +18,12 @@ 'use strict'; -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float32Array = require( '@stdlib/array/float32' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var smax = require( './../lib' ); -var x; -var i; - -x = new Float32Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - x[ i ] = round( (randu()*100.0) - 50.0 ); -} +var x = discreteUniform( 10, -50, 50, { + 'dtype': 'float32' +}); console.log( x ); var v = smax( x.length, x, 1 ); diff --git a/lib/node_modules/@stdlib/stats/base/smax/test/test.ndarray.js b/lib/node_modules/@stdlib/stats/base/smax/test/test.ndarray.js index 178f8765199d..028cb977c1e9 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/stats/base/smax/test/test.ndarray.js @@ -21,7 +21,6 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); var Float32Array = require( '@stdlib/array/float32' ); @@ -96,7 +95,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -111,15 +109,13 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]); - N = floor( x.length / 2 ); - v = smax( N, x, 2, 0 ); + v = smax( 4, x, 2, 0 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -134,8 +130,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]); - N = floor( x.length / 2 ); - v = smax( N, x, -2, 6 ); + v = smax( 4, x, -2, 6 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -154,7 +149,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f }); tape( 'the function supports an `offset` parameter', function test( t ) { - var N; var x; var v; @@ -168,9 +162,8 @@ tape( 'the function supports an `offset` parameter', function test( t ) { 3.0, 4.0 // 3 ]); - N = floor( x.length / 2 ); - v = smax( N, x, 2, 1 ); + v = smax( 4, x, 2, 1 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/smax/test/test.ndarray.native.js b/lib/node_modules/@stdlib/stats/base/smax/test/test.ndarray.native.js index 8e75e442329a..198d168d328e 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/stats/base/smax/test/test.ndarray.native.js @@ -22,7 +22,6 @@ var resolve = require( 'path' ).resolve; var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); var Float32Array = require( '@stdlib/array/float32' ); @@ -105,7 +104,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', opts, function test( t ) { - var N; var x; var v; @@ -120,15 +118,13 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { 2.0 ]); - N = floor( x.length / 2 ); - v = smax( N, x, 2, 0 ); + v = smax( 4, x, 2, 0 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', opts, function test( t ) { - var N; var x; var v; @@ -143,8 +139,7 @@ tape( 'the function supports a negative `stride` parameter', opts, function test 2.0 ]); - N = floor( x.length / 2 ); - v = smax( N, x, -2, 6 ); + v = smax( 4, x, -2, 6 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -163,7 +158,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f }); tape( 'the function supports an `offset` parameter', opts, function test( t ) { - var N; var x; var v; @@ -177,9 +171,8 @@ tape( 'the function supports an `offset` parameter', opts, function test( t ) { 3.0, 4.0 // 3 ]); - N = floor( x.length / 2 ); - v = smax( N, x, 2, 1 ); + v = smax( 4, x, 2, 1 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/smax/test/test.smax.js b/lib/node_modules/@stdlib/stats/base/smax/test/test.smax.js index 41b7dee86235..f7fdf0d145ed 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/test/test.smax.js +++ b/lib/node_modules/@stdlib/stats/base/smax/test/test.smax.js @@ -21,7 +21,6 @@ // MODULES // var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); var Float32Array = require( '@stdlib/array/float32' ); @@ -96,7 +95,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', function test( t ) { - var N; var x; var v; @@ -111,15 +109,13 @@ tape( 'the function supports a `stride` parameter', function test( t ) { 2.0 ]); - N = floor( x.length / 2 ); - v = smax( N, x, 2 ); + v = smax( 4, x, 2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', function test( t ) { - var N; var x; var v; @@ -134,8 +130,7 @@ tape( 'the function supports a negative `stride` parameter', function test( t ) 2.0 ]); - N = floor( x.length / 2 ); - v = smax( N, x, -2 ); + v = smax( 4, x, -2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -156,7 +151,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f tape( 'the function supports view offsets', function test( t ) { var x0; var x1; - var N; var v; x0 = new Float32Array([ @@ -172,9 +166,8 @@ tape( 'the function supports view offsets', function test( t ) { ]); x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - N = floor(x1.length / 2); - v = smax( N, x1, 2 ); + v = smax( 4, x1, 2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/stats/base/smax/test/test.smax.native.js b/lib/node_modules/@stdlib/stats/base/smax/test/test.smax.native.js index 4d7f1140f7a7..d3ec37de4559 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/test/test.smax.native.js +++ b/lib/node_modules/@stdlib/stats/base/smax/test/test.smax.native.js @@ -22,7 +22,6 @@ var resolve = require( 'path' ).resolve; var tape = require( 'tape' ); -var floor = require( '@stdlib/math/base/special/floor' ); var isnan = require( '@stdlib/math/base/assert/is-nan' ); var isPositiveZero = require( '@stdlib/math/base/assert/is-positive-zero' ); var Float32Array = require( '@stdlib/array/float32' ); @@ -187,7 +186,6 @@ tape( 'if provided an `N` parameter equal to `1`, the function returns the first }); tape( 'the function supports a `stride` parameter', opts, function test( t ) { - var N; var x; var v; @@ -202,15 +200,13 @@ tape( 'the function supports a `stride` parameter', opts, function test( t ) { 2.0 ]); - N = floor( x.length / 2 ); - v = smax( N, x, 2 ); + v = smax( 4, x, 2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); }); tape( 'the function supports a negative `stride` parameter', opts, function test( t ) { - var N; var x; var v; @@ -225,8 +221,7 @@ tape( 'the function supports a negative `stride` parameter', opts, function test 2.0 ]); - N = floor( x.length / 2 ); - v = smax( N, x, -2 ); + v = smax( 4, x, -2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); @@ -247,7 +242,6 @@ tape( 'if provided a `stride` parameter equal to `0`, the function returns the f tape( 'the function supports view offsets', opts, function test( t ) { var x0; var x1; - var N; var v; x0 = new Float32Array([ @@ -263,9 +257,8 @@ tape( 'the function supports view offsets', opts, function test( t ) { ]); x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element - N = floor(x1.length / 2); - v = smax( N, x1, 2 ); + v = smax( 4, x1, 2 ); t.strictEqual( v, 4.0, 'returns expected value' ); t.end(); From ba325c916658d31c9ea2482e9abdd2941d0bd27a Mon Sep 17 00:00:00 2001 From: aayush0325 Date: Thu, 26 Dec 2024 14:01:28 +0000 Subject: [PATCH 3/3] docs: update README.md --- 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: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: passed - task: lint_c_benchmarks status: na - 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: passed - task: run_cpp_examples status: na - task: run_javascript_readme_examples status: passed - 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 --- --- .../@stdlib/stats/base/smax/README.md | 162 ++++++++++++++---- .../stats/base/smax/examples/c/example.c | 1 - 2 files changed, 132 insertions(+), 31 deletions(-) diff --git a/lib/node_modules/@stdlib/stats/base/smax/README.md b/lib/node_modules/@stdlib/stats/base/smax/README.md index 616ae496f72b..0deb49479784 100644 --- a/lib/node_modules/@stdlib/stats/base/smax/README.md +++ b/lib/node_modules/@stdlib/stats/base/smax/README.md @@ -36,7 +36,7 @@ limitations under the License. var smax = require( '@stdlib/stats/base/smax' ); ``` -#### smax( N, x, stride ) +#### smax( N, x, strideX ) Computes the maximum value of a single-precision floating-point strided array `x`. @@ -44,9 +44,8 @@ Computes the maximum value of a single-precision floating-point strided array `x var Float32Array = require( '@stdlib/array/float32' ); var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); -var N = x.length; -var v = smax( N, x, 1 ); +var v = smax( x.length, x, 1 ); // returns 2.0 ``` @@ -54,18 +53,16 @@ The function has the following parameters: - **N**: number of indexed elements. - **x**: input [`Float32Array`][@stdlib/array/float32]. -- **stride**: index increment for `x`. +- **strideX**: stride length for `x`. -The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to compute the maximum value of every other element in `x`, +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to compute the maximum value of every other element in `x`, ```javascript var Float32Array = require( '@stdlib/array/float32' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float32Array( [ 1.0, 2.0, 2.0, -7.0, -2.0, 3.0, 4.0, 2.0 ] ); -var N = floor( x.length / 2 ); -var v = smax( N, x, 2 ); +var v = smax( 4, x, 2 ); // returns 4.0 ``` @@ -75,18 +72,15 @@ Note that indexing is relative to the first index. To introduce an offset, use [ ```javascript var Float32Array = require( '@stdlib/array/float32' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x0 = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length / 2 ); - -var v = smax( N, x1, 2 ); +var v = smax( 4, x1, 2 ); // returns 4.0 ``` -#### smax.ndarray( N, x, stride, offset ) +#### smax.ndarray( N, x, strideX, offsetX ) Computes the maximum value of a single-precision floating-point strided array using alternative indexing semantics. @@ -94,26 +88,23 @@ Computes the maximum value of a single-precision floating-point strided array us var Float32Array = require( '@stdlib/array/float32' ); var x = new Float32Array( [ 1.0, -2.0, 2.0 ] ); -var N = x.length; -var v = smax.ndarray( N, x, 1, 0 ); +var v = smax.ndarray( x.length, x, 1, 0 ); // returns 2.0 ``` The function has the following additional parameters: -- **offset**: starting index for `x`. +- **offsetX**: starting index for `x`. -While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying `buffer`, the `offset` parameter supports indexing semantics based on a starting index. For example, to calculate the maximum value for every other value in `x` starting from the second value +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to calculate the maximum value for every other element in `x` starting from the second element ```javascript var Float32Array = require( '@stdlib/array/float32' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float32Array( [ 2.0, 1.0, 2.0, -2.0, -2.0, 2.0, 3.0, 4.0 ] ); -var N = floor( x.length / 2 ); -var v = smax.ndarray( N, x, 2, 1 ); +var v = smax.ndarray( 4, x, 2, 1 ); // returns 4.0 ``` @@ -138,18 +129,12 @@ var v = smax.ndarray( N, x, 2, 1 ); ```javascript -var randu = require( '@stdlib/random/base/randu' ); -var round = require( '@stdlib/math/base/special/round' ); -var Float32Array = require( '@stdlib/array/float32' ); +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); var smax = require( '@stdlib/stats/base/smax' ); -var x; -var i; - -x = new Float32Array( 10 ); -for ( i = 0; i < x.length; i++ ) { - x[ i ] = round( (randu()*100.0) - 50.0 ); -} +var x = discreteUniform( 10, -50, 50, { + 'dtype': 'float32' +}); console.log( x ); var v = smax( x.length, x, 1 ); @@ -160,6 +145,123 @@ console.log( v ); + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/stats/base/smax.h" +``` + +#### stdlib_strided_smax( N, \*X, strideX ) + +Computes the maximum value of a single-precision floating-point strided array. + +```c +const float x[] = { 1.0f, -2.0f, 3.0f, -4.0f }; + +float v = stdlib_strided_smax( 4, x, 1 ); +// returns 3.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. + +```c +float stdlib_strided_smax( const CBLAS_INT N, const float *X, const CBLAS_INT strideX ); +``` + +#### stdlib_strided_smax_ndarray( N, \*X, strideX, offsetX ) + +Computes the maximum value of a single-precision floating-point strided array using alternative indexing semantics. + +```c +const float x[] = { 1.0f, -2.0f, 3.0f, -4.0f }; + +float v = stdlib_strided_dmax_ndarray( 4, x, 1, 0 ); +// returns 3.0f +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] float*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. + +```c +float stdlib_strided_smax_ndarray( const CBLAS_INT N, const float *X, const CBLAS_INT strideX, const CBLAS_INT offsetX ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/stats/base/smax.h" +#include + +int main( void ) { + // Create a strided array: + const float x[] = { 1.0f, 2.0f, 3.0f, 4.0f, 5.0f, 6.0f, 7.0f, 8.0f }; + + // Specify the number of elements: + const int N = 4; + + // Specify the stride length: + const int strideX = 2; + + // Compute the maximum value: + float v = stdlib_strided_smax( N, x, strideX ); + + // Print the result: + printf( "max: %f\n", v ); +} +``` + +
+ + + +
+ + +