diff --git a/lib/node_modules/@stdlib/blas/ext/base/ssortins/README.md b/lib/node_modules/@stdlib/blas/ext/base/ssortins/README.md index 2512d5b40a11..20d57a82e474 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ssortins/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/ssortins/README.md @@ -50,16 +50,14 @@ The function has the following parameters: - **x**: input [`Float32Array`][@stdlib/array/float32]. - **stride**: index increment. -The `N` and `stride` parameters determine which elements in `x` are accessed at runtime. For example, to sort every other element +The `N` and stride parameters determine which elements in the strided array are accessed at runtime. For example, to sort every other element ```javascript var Float32Array = require( '@stdlib/array/float32' ); -var floor = require( '@stdlib/math/base/special/floor' ); var x = new Float32Array( [ 1.0, -2.0, 3.0, -4.0 ] ); -var N = floor( x.length / 2 ); -ssortins( N, -1.0, x, 2 ); +ssortins( 2, -1.0, x, 2 ); // x => [ 3.0, -2.0, 1.0, -4.0 ] ``` @@ -67,17 +65,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' ); // Initial array... var x0 = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] ); // Create an offset view... var x1 = new Float32Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element -var N = floor( x0.length/2 ); // Sort every other element... -ssortins( N, -1.0, x1, 2 ); +ssortins( 2, -1.0, x1, 2 ); // x0 => [ 1.0, 4.0, 3.0, 2.0 ] ``` @@ -98,7 +94,7 @@ The function has the following additional parameters: - **offset**: starting index. -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 access only the last three elements of `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 access only the last three elements of `x` ```javascript var Float32Array = require( '@stdlib/array/float32' ); @@ -143,10 +139,9 @@ var ssortins = require( '@stdlib/blas/ext/base/ssortins' ); var rand; var sign; -var x; var i; -x = new Float32Array( 10 ); +var x = new Float32Array( 10 ); for ( i = 0; i < x.length; i++ ) { rand = round( randu()*100.0 ); sign = randu(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ssortins/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/ssortins/docs/repl.txt index 9a5b7927e28e..e8f88d6523f8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ssortins/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/ssortins/docs/repl.txt @@ -2,8 +2,8 @@ {{alias}}( N, order, x, stride ) Sorts a single-precision floating-point strided array using insertion sort. - The `N` and `stride` parameters determine which elements in `x` are accessed - at runtime. + The `N` and stride parameters determine which elements in the strided array + are accessed at runtime. Indexing is relative to the first index. To introduce an offset, use typed array views. @@ -50,7 +50,7 @@ Returns ------- x: Float32Array - Input array `x`. + Input array. Examples -------- @@ -59,27 +59,26 @@ > {{alias}}( x.length, 1, x, 1 ) [ -4.0, -2.0, 1.0, 3.0 ] - // Using `N` and `stride` parameters: + // Using `N` and stride parameters: > x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, -4.0 ] ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}( N, -1, x, 2 ) + > {{alias}}( 2, -1, x, 2 ) [ 3.0, -2.0, 1.0, -4.0 ] // Using view offsets: > var x0 = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, -4.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 ); - > {{alias}}( N, 1, x1, 2 ) + > {{alias}}( 2, 1, x1, 2 ) [ -4.0, 3.0, -2.0 ] > x0 [ 1.0, -4.0, 3.0, -2.0 ] + {{alias}}.ndarray( N, order, x, stride, offset ) Sorts a single-precision floating-point strided array using insertion sort and alternative indexing semantics. While typed array views mandate a view offset based on the underlying - buffer, the `offset` parameter supports indexing semantics based on a + buffer, the offset parameter supports indexing semantics based on a starting index. Parameters @@ -103,7 +102,7 @@ Returns ------- x: Float32Array - Input array `x`. + Input array. Examples -------- @@ -114,8 +113,7 @@ // Using an index offset: > x = new {{alias:@stdlib/array/float32}}( [ 1.0, -2.0, 3.0, -4.0 ] ); - > var N = {{alias:@stdlib/math/base/special/floor}}( x.length / 2 ); - > {{alias}}.ndarray( N, 1, x, 2, 1 ) + > {{alias}}.ndarray( 2, 1, x, 2, 1 ) [ 1.0, -4.0, 3.0, -2.0 ] See Also diff --git a/lib/node_modules/@stdlib/blas/ext/base/ssortins/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/ssortins/docs/types/index.d.ts index 04fb0d474a90..69820975f993 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ssortins/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/ssortins/docs/types/index.d.ts @@ -29,7 +29,7 @@ interface Routine { * @param order - sort order * @param x - input array * @param stride - stride length - * @returns `x` + * @returns input array * * @example * var Float32Array = require( '@stdlib/array/float32' ); @@ -49,7 +49,7 @@ interface Routine { * @param x - input array * @param stride - stride length * @param offset - starting index - * @returns `x` + * @returns input array * * @example * var Float32Array = require( '@stdlib/array/float32' ); @@ -69,7 +69,7 @@ interface Routine { * @param order - sort order * @param x - input array * @param stride - stride length -* @returns `x` +* @returns input array * * @example * var Float32Array = require( '@stdlib/array/float32' ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/ssortins/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/ssortins/examples/index.js index f888241528e7..4a5a36c9dc31 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ssortins/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/ssortins/examples/index.js @@ -25,10 +25,9 @@ var ssortins = require( './../lib' ); var rand; var sign; -var x; var i; -x = new Float32Array( 10 ); +var x = new Float32Array( 10 ); for ( i = 0; i < x.length; i++ ) { if ( randu() < 0.2 ) { x[ i ] = NaN; diff --git a/lib/node_modules/@stdlib/blas/ext/base/ssortins/include.gypi b/lib/node_modules/@stdlib/blas/ext/base/ssortins/include.gypi index 868c5c12e852..26476a8c2655 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/ssortins/include.gypi +++ b/lib/node_modules/@stdlib/blas/ext/base/ssortins/include.gypi @@ -36,7 +36,7 @@ # Source files: 'src_files': [ - '<(src_dir)/addon.cpp', + '<(src_dir)/addon.c', ' + +/** +* 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, 4 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_FLOAT( env, order, argv, 1 ); + STDLIB_NAPI_ARGV_INT64( env, stride, argv, 3 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT32ARRAY( env, X, N, stride, argv, 2 ); + c_ssortins( N, order, X, stride ); + return NULL; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN( addon ) diff --git a/lib/node_modules/@stdlib/blas/ext/base/ssortins/src/addon.cpp b/lib/node_modules/@stdlib/blas/ext/base/ssortins/src/addon.cpp deleted file mode 100644 index d6d696884af4..000000000000 --- a/lib/node_modules/@stdlib/blas/ext/base/ssortins/src/addon.cpp +++ /dev/null @@ -1,128 +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/blas/ext/base/ssortins.h" -#include -#include -#include -#include -#include - -/** -* Add-on namespace. -*/ -namespace stdlib_blas_ext_base_ssortins { - - /** - * Sorts a single-precision floating-point strided array using insertion sort. - * - * ## Notes - * - * - When called from JavaScript, the function expects four arguments: - * - * - `N`: number of indexed elements - * - `order`: sort order - * - `X`: input array - * - `strideX`: `X` stride length - */ - napi_value node_ssortins( napi_env env, napi_callback_info info ) { - napi_status status; - - size_t argc = 4; - napi_value argv[ 4 ]; - status = napi_get_cb_info( env, info, &argc, argv, nullptr, nullptr ); - assert( status == napi_ok ); - - if ( argc < 4 ) { - napi_throw_error( env, nullptr, "invalid invocation. Must provide 4 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; - } - - napi_valuetype vtype1; - status = napi_typeof( env, argv[ 1 ], &vtype1 ); - assert( status == napi_ok ); - if ( vtype1 != napi_number ) { - napi_throw_type_error( env, nullptr, "invalid argument. Second argument must be a number." ); - return nullptr; - } - - bool res2; - status = napi_is_typedarray( env, argv[ 2 ], &res2 ); - assert( status == napi_ok ); - if ( res2 == false ) { - napi_throw_type_error( env, nullptr, "invalid argument. Third argument must be a Float32Array." ); - return nullptr; - } - - napi_valuetype vtype3; - status = napi_typeof( env, argv[ 3 ], &vtype3 ); - assert( status == napi_ok ); - if ( vtype3 != napi_number ) { - napi_throw_type_error( env, nullptr, "invalid argument. Fourth argument must be a number." ); - return nullptr; - } - - int64_t N; - status = napi_get_value_int64( env, argv[ 0 ], &N ); - assert( status == napi_ok ); - - double order; - status = napi_get_value_double( env, argv[ 1 ], &order ); - assert( status == napi_ok ); - - int64_t strideX; - status = napi_get_value_int64( env, argv[ 3 ], &strideX ); - assert( status == napi_ok ); - - napi_typedarray_type vtype2; - size_t xlen; - void *X; - status = napi_get_typedarray_info( env, argv[ 2 ], &vtype2, &xlen, &X, nullptr, nullptr ); - assert( status == napi_ok ); - if ( vtype2 != napi_float32_array ) { - napi_throw_type_error( env, nullptr, "invalid argument. Third argument must be a Float32Array." ); - return nullptr; - } - if ( (N-1)*llabs(strideX) >= (int64_t)xlen ) { - napi_throw_range_error( env, nullptr, "invalid argument. Third argument has insufficient elements based on the associated stride and the number of indexed elements." ); - return nullptr; - } - - c_ssortins( N, (float)order, (float *)X, strideX ); - - return nullptr; - } - - 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_ssortins, NULL, &fcn ); - assert( status == napi_ok ); - return fcn; - } - - NAPI_MODULE( NODE_GYP_MODULE_NAME, Init ) -} // end namespace stdlib_blas_ext_base_ssortins