From 7a9dbd24620d04247a9499584a8cb5368ee68a5a Mon Sep 17 00:00:00 2001 From: headlessNode Date: Sat, 7 Mar 2026 14:42:34 +0500 Subject: [PATCH 1/5] feat: add blas/ext/base/dcartesian-square --- 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: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - 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: missing_dependencies - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../blas/ext/base/dcartesian-square/README.md | 310 ++++++++++++++++++ .../dcartesian-square/benchmark/benchmark.js | 103 ++++++ .../benchmark/benchmark.native.js | 108 ++++++ .../benchmark/benchmark.ndarray.js | 103 ++++++ .../benchmark/benchmark.ndarray.native.js | 108 ++++++ .../dcartesian-square/benchmark/c/Makefile | 146 +++++++++ .../benchmark/c/benchmark.length.c | 197 +++++++++++ .../ext/base/dcartesian-square/binding.gyp | 170 ++++++++++ .../ext/base/dcartesian-square/docs/repl.txt | 113 +++++++ .../dcartesian-square/docs/types/index.d.ts | 106 ++++++ .../base/dcartesian-square/docs/types/test.ts | 278 ++++++++++++++++ .../dcartesian-square/examples/c/Makefile | 146 +++++++++ .../dcartesian-square/examples/c/example.c | 44 +++ .../base/dcartesian-square/examples/index.js | 33 ++ .../ext/base/dcartesian-square/include.gypi | 53 +++ .../stdlib/blas/ext/base/dcartesiansquare.h | 45 +++ .../dcartesian-square/lib/dcartesiansquare.js | 56 ++++ .../lib/dcartesiansquare.native.js | 56 ++++ .../ext/base/dcartesian-square/lib/index.js | 70 ++++ .../ext/base/dcartesian-square/lib/main.js | 35 ++ .../ext/base/dcartesian-square/lib/native.js | 35 ++ .../ext/base/dcartesian-square/lib/ndarray.js | 75 +++++ .../dcartesian-square/lib/ndarray.native.js | 58 ++++ .../ext/base/dcartesian-square/manifest.json | 79 +++++ .../ext/base/dcartesian-square/package.json | 75 +++++ .../ext/base/dcartesian-square/src/Makefile | 70 ++++ .../ext/base/dcartesian-square/src/addon.c | 70 ++++ .../ext/base/dcartesian-square/src/main.c | 75 +++++ .../test/test.dcartesiansquare.js | 225 +++++++++++++ .../test/test.dcartesiansquare.native.js | 157 +++++++++ .../ext/base/dcartesian-square/test/test.js | 82 +++++ .../dcartesian-square/test/test.ndarray.js | 237 +++++++++++++ .../test/test.ndarray.native.js | 151 +++++++++ 33 files changed, 3669 insertions(+) create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.ndarray.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/c/Makefile create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/c/benchmark.length.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/binding.gyp create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/repl.txt create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/test.ts create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/Makefile create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/example.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/include.gypi create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/include/stdlib/blas/ext/base/dcartesiansquare.h create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/index.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/main.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/manifest.json create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/package.json create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/Makefile create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/addon.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.native.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.js create mode 100644 lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.native.js diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md new file mode 100644 index 000000000000..91d8ee486c2f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md @@ -0,0 +1,310 @@ + + +# dcartesianSquare + +> Compute the Cartesian square for a double-precision floating-point strided array. + +
+ +## Usage + +```javascript +var dcartesianSquare = require( '@stdlib/blas/ext/base/dcartesian-square' ); +``` + +#### dcartesianSquare( N, x, strideX, out, strideOut1, strideOut2 ) + +Computes the Cartesian square for a double-precision floating-point strided array. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +var out = new Float64Array( 18 ); + +dcartesianSquare( x.length, x, 1, out, 2, 1 ); +// out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +``` + +The function has the following parameters: + +- **N**: number of indexed elements. +- **x**: input [`Float64Array`][@stdlib/array/float64]. +- **strideX**: stride length for `x`. +- **out**: output [`Float64Array`][@stdlib/array/float64]. +- **strideOut1**: stride length between consecutive output pairs. +- **strideOut2**: stride length between the two elements of each output pair. + +The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the Cartesian square of every other element: + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, 0.0, 2.0, 0.0 ] ); +var out = new Float64Array( 8 ); + +dcartesianSquare( 2, x, 2, out, 2, 1 ); +// out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] +``` + +Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +// Initial array... +var x0 = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); + +// Create an offset view... +var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +// Compute the Cartesian square of the first two elements of the view: +var out = new Float64Array( 8 ); +dcartesianSquare( 2, x1, 1, out, 2, 1 ); +// out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] +``` + + + +#### dcartesianSquare.ndarray( N, x, strideX, offsetX, out, strideOut1, strideOut2, offsetOut ) + +Computes the Cartesian square for a double-precision floating-point strided array using alternative indexing semantics. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +var out = new Float64Array( 18 ); + +dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, 0 ); +// out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +``` + +The function has the following additional parameters: + +- **offsetX**: starting index for `x`. +- **offsetOut**: starting index for `out`. + +While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to access only the last two elements: + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var x = new Float64Array( [ 0.0, 0.0, 1.0, 2.0 ] ); +var out = new Float64Array( 8 ); + +dcartesianSquare.ndarray( 2, x, 1, 2, out, 2, 1, 0 ); +// out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] +``` + +
+ + + +
+ +## Notes + +- For an input array `x` of length `N`, the output array `out` must contain at least `N^2` pairs. +- If `N <= 0`, both functions return `out` unchanged. + +
+ + + +
+ +## Examples + + + +```javascript +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var Float64Array = require( '@stdlib/array/float64' ); +var dcartesianSquare = require( '@stdlib/blas/ext/base/dcartesian-square' ); + +var N = 4; +var x = discreteUniform( N, 1, 10, { + 'dtype': 'float64' +}); +console.log( x ); + +var out = new Float64Array( N * N * 2 ); +dcartesianSquare( N, x, 1, out, 2, 1 ); +console.log( out ); +``` + +
+ + + + + +* * * + +
+ +## C APIs + + + +
+ +
+ + + + + +
+ +### Usage + +```c +#include "stdlib/blas/ext/base/dcartesiansquare.h" +``` + +#### stdlib_strided_dcartesian_square( N, \*X, strideX, \*Out, strideOut1, strideOut2 ) + +Computes the Cartesian square for a double-precision floating-point strided array. + +```c +double x[] = { 1.0, 2.0, 3.0, 4.0 }; +double out[ 32 ]; + +stdlib_strided_dcartesian_square( 4, x, 1, out, 2, 1 ); +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **Out**: `[out] double*` output array. +- **strideOut1**: `[in] CBLAS_INT` stride length between consecutive output pairs. +- **strideOut2**: `[in] CBLAS_INT` stride length between elements of each output pair. + +```c +void stdlib_strided_dcartesian_square( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT strideOut1, const CBLAS_INT strideOut2 ); +``` + + + +#### stdlib_strided_dcartesian_square_ndarray( N, \*X, strideX, offsetX, \*Out, strideOut1, strideOut2, offsetOut ) + +Computes the Cartesian square for a double-precision floating-point strided array using alternative indexing semantics. + +```c +double x[] = { 1.0, 2.0, 3.0, 4.0 }; +double out[ 32 ]; + +stdlib_strided_dcartesian_square_ndarray( 4, x, 1, 0, out, 2, 1, 0 ); +``` + +The function accepts the following arguments: + +- **N**: `[in] CBLAS_INT` number of indexed elements. +- **X**: `[in] double*` input array. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **offsetX**: `[in] CBLAS_INT` starting index for `X`. +- **Out**: `[out] double*` output array. +- **strideOut1**: `[in] CBLAS_INT` stride length between consecutive output pairs. +- **strideOut2**: `[in] CBLAS_INT` stride length between elements of each output pair. +- **offsetOut**: `[in] CBLAS_INT` starting index for `Out`. + +```c +void stdlib_strided_dcartesian_square_ndarray( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *Out, const CBLAS_INT strideOut1, const CBLAS_INT strideOut2, const CBLAS_INT offsetOut ); +``` + +
+ + + + + +
+ +
+ + + + + +
+ +### Examples + +```c +#include "stdlib/blas/ext/base/dcartesiansquare.h" +#include + +int main( void ) { + // Create a strided input array: + double x[] = { 1.0, 2.0, 3.0, 4.0 }; + + // Specify the number of indexed elements: + const int N = 4; + + // Create an output array (N*N pairs, each pair has 2 elements): + double out[ 32 ]; + + // Specify strides: + const int strideX = 1; + const int strideOut1 = 2; + const int strideOut2 = 1; + + // Compute the Cartesian square: + stdlib_strided_dcartesian_square( N, x, strideX, out, strideOut1, strideOut2 ); + + // Print the result: + for ( int i = 0; i < N*N; i++ ) { + printf( "out[ %i ] = ( %lf, %lf )\n", i, out[ i*2 ], out[ i*2+1 ] ); + } +} +``` + +
+ + + +
+ + + + + + + + + + + + + + diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.js new file mode 100644 index 000000000000..af3d40bcebdb --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.js @@ -0,0 +1,103 @@ +/** +* @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 bench = require( '@stdlib/bench' ); +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 Float64Array = require( '@stdlib/array/float64' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var dcartesianSquare = require( './../lib/dcartesiansquare.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Create a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var out; + var x; + + x = uniform( len, -10.0, 10.0, options ); + out = new Float64Array( len * len * 2 ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = dcartesianSquare( x.length, x, 1, out, 2, 1 ); + if ( isnan( y[ 0 ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y[ 0 ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 3; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( format( '%s:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.native.js new file mode 100644 index 000000000000..ddd76a5bb203 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.native.js @@ -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/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var Float64Array = require( '@stdlib/array/float64' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var dcartesianSquare = tryRequire( resolve( __dirname, './../lib/dcartesiansquare.native.js' ) ); +var opts = { + 'skip': ( dcartesianSquare instanceof Error ) +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Create a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var out; + var x; + + x = uniform( len, -10.0, 10.0, options ); + out = new Float64Array( len * len * 2 ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = dcartesianSquare( x.length, x, 1, out, 2, 1 ); + if ( isnan( y[ 0 ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y[ 0 ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 3; // 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(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.ndarray.js new file mode 100644 index 000000000000..a6b03f985d47 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.ndarray.js @@ -0,0 +1,103 @@ +/** +* @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 bench = require( '@stdlib/bench' ); +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 Float64Array = require( '@stdlib/array/float64' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; +var dcartesianSquare = require( './../lib/ndarray.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Create a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var out; + var x; + + x = uniform( len, -10.0, 10.0, options ); + out = new Float64Array( len * len * 2 ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = dcartesianSquare( x.length, x, 1, 0, out, 2, 1, 0 ); + if ( isnan( y[ 0 ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y[ 0 ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 3; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( format( '%s:ndarray:len=%d', pkg, len ), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.ndarray.native.js new file mode 100644 index 000000000000..ed8b6139b200 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.ndarray.native.js @@ -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/array/uniform' ); +var isnan = require( '@stdlib/math/base/assert/is-nan' ); +var pow = require( '@stdlib/math/base/special/pow' ); +var Float64Array = require( '@stdlib/array/float64' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var format = require( '@stdlib/string/format' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var dcartesianSquare = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( dcartesianSquare instanceof Error ) +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Create a benchmark function. +* +* @private +* @param {PositiveInteger} len - array length +* @returns {Function} benchmark function +*/ +function createBenchmark( len ) { + var out; + var x; + + x = uniform( len, -10.0, 10.0, options ); + out = new Float64Array( len * len * 2 ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var y; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + y = dcartesianSquare( x.length, x, 1, 0, out, 2, 1, 0 ); + if ( isnan( y[ 0 ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( y[ 0 ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 3; // 10^max + + for ( i = min; i <= max; i++ ) { + len = pow( 10, i ); + f = createBenchmark( len ); + bench( format( '%s::native:ndarray:len=%d', pkg, len ), opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/c/Makefile b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/c/Makefile new file mode 100644 index 000000000000..0756dc7da20a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @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. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := benchmark.length.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/c/benchmark.length.c new file mode 100644 index 000000000000..e738048a8733 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/c/benchmark.length.c @@ -0,0 +1,197 @@ +/** +* @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. +*/ + +#include "stdlib/blas/ext/base/dcartesiansquare.h" +#include +#include +#include +#include +#include + +#define NAME "dcartesian_square" +#define ITERATIONS 1000000 +#define REPEATS 3 +#define MIN 1 +#define MAX 3 + +/** +* Prints the TAP version. +*/ +static void print_version( void ) { + printf( "TAP version 13\n" ); +} + +/** +* Prints the TAP summary. +* +* @param total total number of tests +* @param passing total number of passing tests +*/ +static void print_summary( int total, int passing ) { + printf( "#\n" ); + printf( "1..%d\n", total ); // TAP plan + printf( "# total %d\n", total ); + printf( "# pass %d\n", passing ); + printf( "#\n" ); + printf( "# ok\n" ); +} + +/** +* Prints benchmarks results. +* +* @param iterations number of iterations +* @param elapsed elapsed time in seconds +*/ +static void print_results( int iterations, double elapsed ) { + double rate = (double)iterations / elapsed; + printf( " ---\n" ); + printf( " iterations: %d\n", iterations ); + printf( " elapsed: %0.9f\n", elapsed ); + printf( " rate: %0.9f\n", rate ); + printf( " ...\n" ); +} + +/** +* Returns a clock time. +* +* @return clock time +*/ +static double tic( void ) { + struct timeval now; + gettimeofday( &now, NULL ); + return (double)now.tv_sec + (double)now.tv_usec/1.0e6; +} + +/** +* Generates a random number on the interval [0,1). +* +* @return random number +*/ +static double rand_double( void ) { + int r = rand(); + return (double)r / ( (double)RAND_MAX + 1.0 ); +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param len array length +* @return elapsed time in seconds +*/ +static double benchmark1( int iterations, int len ) { + double elapsed; + double *out; + double *x; + double t; + int i; + + x = (double *) malloc( len * sizeof( double ) ); + out = (double *) malloc( len * len * 2 * sizeof( double ) ); + for ( i = 0; i < len; i++ ) { + x[ i ] = ( rand_double()*200.0 ) - 100.0; + } + t = tic(); + for ( i = 0; i < iterations; i++ ) { + stdlib_strided_dcartesian_square( len, x, 1, out, 2, 1 ); + if ( out[ 0 ] != out[ 0 ] ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( out[ 0 ] != out[ 0 ] ) { + printf( "should not return NaN\n" ); + } + free( x ); + free( out ); + 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; + double *out; + double *x; + double t; + int i; + + x = (double *) malloc( len * sizeof( double ) ); + out = (double *) malloc( len * len * 2 * sizeof( double ) ); + for ( i = 0; i < len; i++ ) { + x[ i ] = ( rand_double()*200.0 ) - 100.0; + } + t = tic(); + for ( i = 0; i < iterations; i++ ) { + stdlib_strided_dcartesian_square_ndarray( len, x, 1, 0, out, 2, 1, 0 ); + if ( out[ 0 ] != out[ 0 ] ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( out[ 0 ] != out[ 0 ] ) { + printf( "should not return NaN\n" ); + } + free( x ); + free( out ); + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int count; + int iter; + int len; + int i; + int j; + + // Use the current time to seed the random number generator: + srand( time( NULL ) ); + + print_version(); + count = 0; + for ( i = MIN; i <= MAX; i++ ) { + len = (int) pow( 10, i ); + iter = ITERATIONS / (int) pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:len=%d\n", NAME, len ); + elapsed = benchmark1( iter, len ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + 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 ); + } + } + print_summary( count, count ); +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/binding.gyp b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/binding.gyp new file mode 100644 index 000000000000..0d6508a12e99 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/binding.gyp @@ -0,0 +1,170 @@ +# @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. + +# A `.gyp` file for building a Node.js native add-on. +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # List of files to include in this file: + 'includes': [ + './include.gypi', + ], + + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Target name should match the add-on export name: + 'addon_target_name%': 'addon', + + # Set variables based on the host OS: + 'conditions': [ + [ + 'OS=="win"', + { + # Define the object file suffix: + 'obj': 'obj', + }, + { + # Define the object file suffix: + 'obj': 'o', + } + ], # end condition (OS=="win") + ], # end conditions + }, # end variables + + # Define compile targets: + 'targets': [ + + # Target to generate an add-on: + { + # The target name should match the add-on export name: + 'target_name': '<(addon_target_name)', + + # Define dependencies: + 'dependencies': [], + + # Define directories which contain relevant include headers: + 'include_dirs': [ + # Local include directory: + '<@(include_dirs)', + ], + + # List of source files: + 'sources': [ + '<@(src_files)', + ], + + # Settings which should be applied when a target's object files are used as linker input: + 'link_settings': { + # Define libraries: + 'libraries': [ + '<@(libraries)', + ], + + # Define library directories: + 'library_dirs': [ + '<@(library_dirs)', + ], + }, + + # C/C++ compiler flags: + 'cflags': [ + # Enable commonly used warning options: + '-Wall', + + # Aggressive optimization: + '-O3', + ], + + # C specific compiler flags: + 'cflags_c': [ + # Specify the C standard to which a program is expected to conform: + '-std=c99', + ], + + # C++ specific compiler flags: + 'cflags_cpp': [ + # Specify the C++ standard to which a program is expected to conform: + '-std=c++11', + ], + + # Linker flags: + 'ldflags': [], + + # Apply conditions based on the host OS: + 'conditions': [ + [ + 'OS=="mac"', + { + # Linker flags: + 'ldflags': [ + '-undefined dynamic_lookup', + '-Wl,-no-pie', + '-Wl,-search_paths_first', + ], + }, + ], # end condition (OS=="mac") + [ + 'OS!="win"', + { + # C/C++ flags: + 'cflags': [ + # Generate platform-independent code: + '-fPIC', + ], + }, + ], # end condition (OS!="win") + ], # end conditions + }, # end target <(addon_target_name) + + # Target to copy a generated add-on to a standard location: + { + 'target_name': 'copy_addon', + + # Declare that the output of this target is not linked: + 'type': 'none', + + # Define dependencies: + 'dependencies': [ + # Require that the add-on be generated before building this target: + '<(addon_target_name)', + ], + + # Define a list of actions: + 'actions': [ + { + 'action_name': 'copy_addon', + 'message': 'Copying addon...', + + # Explicitly list the inputs in the command-line invocation below: + 'inputs': [], + + # Declare the expected outputs: + 'outputs': [ + '<(addon_output_dir)/<(addon_target_name).node', + ], + + # Define the command-line invocation: + 'action': [ + 'cp', + '<(PRODUCT_DIR)/<(addon_target_name).node', + '<(addon_output_dir)/<(addon_target_name).node', + ], + }, + ], # end actions + }, # end target copy_addon + ], # end targets +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/repl.txt new file mode 100644 index 000000000000..56f66decb508 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/repl.txt @@ -0,0 +1,113 @@ + +{{alias}}( N, x, strideX, out, strideOut1, strideOut2 ) + Computes the Cartesian square for a double-precision floating-point strided + array. + + The `N` and stride parameters determine which elements in the strided + arrays are accessed at runtime. + + If `N <= 0`, the function returns `out` unchanged. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float64Array + Input array. + + strideX: integer + Stride length. + + out: Float64Array + Output array. + + strideOut1: integer + Stride length between consecutive output pairs. + + strideOut2: integer + Stride length between elements of each output pair. + + Returns + ------- + out: Float64Array + Output array. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0 ] ); + > var out = new {{alias:@stdlib/array/float64}}( 8 ); + > {{alias}}( x.length, x, 1, out, 2, 1 ) + [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] + + // Using `N` and stride parameters: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 0.0, 2.0, 0.0 ] ); + > out = new {{alias:@stdlib/array/float64}}( 8 ); + > {{alias}}( 2, x, 2, out, 2, 1 ) + [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] + + // Using view offsets: + > var x0 = new {{alias:@stdlib/array/float64}}( [ 0.0, 1.0, 2.0, 3.0 ] ); + > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + > out = new {{alias:@stdlib/array/float64}}( 8 ); + > {{alias}}( 2, x1, 1, out, 2, 1 ) + [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] + + +{{alias}}.ndarray( N, x,strideX,offsetX, out,strideOut1,strideOut2,offsetOut ) + Computes the Cartesian square for a double-precision floating-point strided + array using alternative indexing semantics. + + While typed array views mandate a view offset based on the underlying + buffer, the offset parameters support indexing semantics based on starting + indices. + + Parameters + ---------- + N: integer + Number of indexed elements. + + x: Float64Array + Input array. + + strideX: integer + Stride length. + + offsetX: integer + Starting index. + + out: Float64Array + Output array. + + strideOut1: integer + Stride length between consecutive output pairs. + + strideOut2: integer + Stride length between elements of each output pair. + + offsetOut: integer + Starting index. + + Returns + ------- + out: Float64Array + Output array. + + Examples + -------- + // Standard Usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0 ] ); + > var out = new {{alias:@stdlib/array/float64}}( 8 ); + > {{alias}}.ndarray( x.length, x, 1, 0, out, 2, 1, 0 ) + [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] + + // Using an index offset: + > x = new {{alias:@stdlib/array/float64}}( [ 0.0, 1.0, 2.0, 3.0 ] ); + > out = new {{alias:@stdlib/array/float64}}( 8 ); + > {{alias}}.ndarray( 2, x, 1, 1, out, 2, 1, 0 ) + [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] + + See Also + -------- + diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts new file mode 100644 index 000000000000..6b709106b854 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts @@ -0,0 +1,106 @@ +/* +* @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. +*/ + +// TypeScript Version: 4.1 + +/** +* Interface describing `dcartesianSquare`. +*/ +interface Routine { + /** + * Computes the Cartesian square for a double-precision floating-point strided array. + * + * @param N - number of indexed elements + * @param x - input array + * @param strideX - stride length + * @param out - output array + * @param strideOut1 - stride length between consecutive output pairs + * @param strideOut2 - stride length between elements of each output pair + * @returns output array + * + * @example + * var Float64Array = require( `@stdlib/array/float64` ); + * + * var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + * var out = new Float64Array( 18 ); + * + * dcartesianSquare( x.length, x, 1, out, 2, 1 ); + * // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] + */ + ( N: number, x: Float64Array, strideX: number, out: Float64Array, strideOut1: number, strideOut2: number ): Float64Array; + + /** + * Computes the Cartesian square for a double-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 + * @param out - output array + * @param strideOut1 - stride length between consecutive output pairs + * @param strideOut2 - stride length between elements of each output pair + * @param offsetOut - starting index + * @returns output array + * + * @example + * var Float64Array = require( `@stdlib/array/float64` ); + * + * var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + * var out = new Float64Array( 18 ); + * + * dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, 0 ); + * // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] + */ + ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, out: Float64Array, strideOut1: number, strideOut2: number, offsetOut: number ): Float64Array; +} + +/** +* Computes the Cartesian square for a double-precision floating-point strided array. +* +* @param N - number of indexed elements +* @param x - input array +* @param strideX - stride length +* @param out - output array +* @param strideOut1 - stride length between consecutive output pairs +* @param strideOut2 - stride length between elements of each output pair +* @returns output array +* +* @example +* var Float64Array = require( `@stdlib/array/float64` ); +* +* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +* var out = new Float64Array( 18 ); +* +* dcartesianSquare( x.length, x, 1, out, 2, 1 ); +* // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +* +* @example +* var Float64Array = require( `@stdlib/array/float64` ); +* +* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +* var out = new Float64Array( 18 ); +* +* dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, 0 ); +* // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +*/ +declare var dcartesianSquare: Routine; + + +// EXPORTS // + +export = dcartesianSquare; diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/test.ts new file mode 100644 index 000000000000..4dbf88aeb7a8 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/test.ts @@ -0,0 +1,278 @@ +/* +* @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. +*/ + +import dcartesianSquare = require( './index' ); + + +// TESTS // + +// The function returns a Float64Array... +{ + const x = new Float64Array( 3 ); + const out = new Float64Array( 18 ); + + dcartesianSquare( x.length, x, 1, out, 2, 1 ); // $ExpectType Float64Array +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const x = new Float64Array( 3 ); + const out = new Float64Array( 18 ); + + dcartesianSquare( '10', x, 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( true, x, 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( false, x, 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( null, x, 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( undefined, x, 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( [], x, 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( {}, x, 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( ( x: number ): number => x, x, 1, out, 2, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a Float64Array... +{ + const out = new Float64Array( 18 ); + + dcartesianSquare( 3, 10, 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( 3, '10', 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( 3, true, 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( 3, false, 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( 3, null, 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( 3, undefined, 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( 3, [], 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( 3, {}, 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( 3, ( x: number ): number => x, 1, out, 2, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a number... +{ + const x = new Float64Array( 3 ); + const out = new Float64Array( 18 ); + + dcartesianSquare( x.length, x, '10', out, 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, true, out, 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, false, out, 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, null, out, 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, undefined, out, 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, [], out, 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, {}, out, 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, ( x: number ): number => x, out, 2, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a Float64Array... +{ + const x = new Float64Array( 3 ); + + dcartesianSquare( x.length, x, 1, 10, 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, '10', 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, true, 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, false, 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, null, 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, undefined, 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, [], 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, {}, 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, ( x: number ): number => x, 2, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fifth argument which is not a number... +{ + const x = new Float64Array( 3 ); + const out = new Float64Array( 18 ); + + dcartesianSquare( x.length, x, 1, out, '10', 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, true, 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, false, 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, null, 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, undefined, 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, [], 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, {}, 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a sixth argument which is not a number... +{ + const x = new Float64Array( 3 ); + const out = new Float64Array( 18 ); + + dcartesianSquare( x.length, x, 1, out, 2, '10' ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, 2, true ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, 2, false ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, 2, null ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, 2, undefined ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, 2, [] ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, 2, {} ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, 2, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = new Float64Array( 3 ); + const out = new Float64Array( 18 ); + + dcartesianSquare(); // $ExpectError + dcartesianSquare( x.length ); // $ExpectError + dcartesianSquare( x.length, x ); // $ExpectError + dcartesianSquare( x.length, x, 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, out ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, 2 ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, 2, 1, 0 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a Float64Array... +{ + const x = new Float64Array( 3 ); + const out = new Float64Array( 18 ); + + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, 0 ); // $ExpectType Float64Array +} + +// The compiler throws an error if the `ndarray` method is provided a first argument which is not a number... +{ + const x = new Float64Array( 3 ); + const out = new Float64Array( 18 ); + + dcartesianSquare.ndarray( '10', x, 1, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( true, x, 1, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( false, x, 1, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( null, x, 1, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( undefined, x, 1, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( [], x, 1, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( {}, x, 1, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( ( x: number ): number => x, x, 1, 0, out, 2, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a second argument which is not a Float64Array... +{ + const out = new Float64Array( 18 ); + + dcartesianSquare.ndarray( 3, 10, 1, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( 3, '10', 1, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( 3, true, 1, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( 3, false, 1, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( 3, null, 1, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( 3, undefined, 1, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( 3, [], 1, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( 3, {}, 1, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( 3, ( x: number ): number => x, 1, 0, out, 2, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a third argument which is not a number... +{ + const x = new Float64Array( 3 ); + const out = new Float64Array( 18 ); + + dcartesianSquare.ndarray( x.length, x, '10', 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, true, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, false, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, null, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, undefined, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, [], 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, {}, 0, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, ( x: number ): number => x, 0, out, 2, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fourth argument which is not a number... +{ + const x = new Float64Array( 3 ); + const out = new Float64Array( 18 ); + + dcartesianSquare.ndarray( x.length, x, 1, '10', out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, true, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, false, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, null, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, undefined, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, [], out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, {}, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, ( x: number ): number => x, out, 2, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a fifth argument which is not a Float64Array... +{ + const x = new Float64Array( 3 ); + + dcartesianSquare.ndarray( x.length, x, 1, 0, 10, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, '10', 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, true, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, false, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, null, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, undefined, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, [], 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, {}, 2, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, ( x: number ): number => x, 2, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a sixth argument which is not a number... +{ + const x = new Float64Array( 3 ); + const out = new Float64Array( 18 ); + + dcartesianSquare.ndarray( x.length, x, 1, 0, out, '10', 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, true, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, false, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, null, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, undefined, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, [], 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, {}, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided a seventh argument which is not a number... +{ + const x = new Float64Array( 3 ); + const out = new Float64Array( 18 ); + + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, '10', 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, true, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, false, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, null, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, undefined, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, [], 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, {}, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an eighth argument which is not a number... +{ + const x = new Float64Array( 3 ); + const out = new Float64Array( 18 ); + + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, '10' ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, true ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, false ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, null ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, undefined ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, [] ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, {} ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the `ndarray` method is provided an unsupported number of arguments... +{ + const x = new Float64Array( 3 ); + const out = new Float64Array( 18 ); + + dcartesianSquare.ndarray(); // $ExpectError + dcartesianSquare.ndarray( x.length ); // $ExpectError + dcartesianSquare.ndarray( x.length, x ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1 ); // $ExpectError + dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/Makefile b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/Makefile new file mode 100644 index 000000000000..c8f8e9a1517b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @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. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + +# Define the program used for compiling C source files: +ifdef C_COMPILER + CC := $(C_COMPILER) +else + CC := gcc +endif + +# Define the command-line options when compiling C files: +CFLAGS ?= \ + -std=c99 \ + -O3 \ + -Wall \ + -pedantic + +# Determine whether to generate position independent code ([1][1], [2][2]). +# +# [1]: https://gcc.gnu.org/onlinedocs/gcc/Code-Gen-Options.html#Code-Gen-Options +# [2]: http://stackoverflow.com/questions/5311515/gcc-fpic-option +ifeq ($(OS), WINNT) + fPIC ?= +else + fPIC ?= -fPIC +endif + +# List of includes (e.g., `-I /foo/bar -I /beep/boop/include`): +INCLUDE ?= + +# List of source files: +SOURCE_FILES ?= + +# List of libraries (e.g., `-lopenblas -lpthread`): +LIBRARIES ?= + +# List of library paths (e.g., `-L /foo/bar -L /beep/boop`): +LIBPATH ?= + +# List of C targets: +c_targets := example.out + + +# RULES # + +#/ +# Compiles source files. +# +# @param {string} [C_COMPILER] - C compiler (e.g., `gcc`) +# @param {string} [CFLAGS] - C compiler options +# @param {(string|void)} [fPIC] - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop/include`) +# @param {string} [SOURCE_FILES] - list of source files +# @param {string} [LIBPATH] - list of library paths (e.g., `-L /foo/bar -L /beep/boop`) +# @param {string} [LIBRARIES] - list of libraries (e.g., `-lopenblas -lpthread`) +# +# @example +# make +# +# @example +# make all +#/ +all: $(c_targets) + +.PHONY: all + +#/ +# Compiles C source files. +# +# @private +# @param {string} CC - C compiler (e.g., `gcc`) +# @param {string} CFLAGS - C compiler options +# @param {(string|void)} fPIC - compiler flag determining whether to generate position independent code (e.g., `-fPIC`) +# @param {string} INCLUDE - list of includes (e.g., `-I /foo/bar`) +# @param {string} SOURCE_FILES - list of source files +# @param {string} LIBPATH - list of library paths (e.g., `-L /foo/bar`) +# @param {string} LIBRARIES - list of libraries (e.g., `-lopenblas`) +#/ +$(c_targets): %.out: %.c + $(QUIET) $(CC) $(CFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< $(LIBPATH) -lm $(LIBRARIES) + +#/ +# Runs compiled examples. +# +# @example +# make run +#/ +run: $(c_targets) + $(QUIET) ./$< + +.PHONY: run + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: + $(QUIET) -rm -f *.o *.out + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/example.c b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/example.c new file mode 100644 index 000000000000..53eb92dff3c6 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/example.c @@ -0,0 +1,44 @@ +/** +* @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. +*/ + +#include "stdlib/blas/ext/base/dcartesiansquare.h" +#include + +int main( void ) { + // Create a strided input array: + double x[] = { 1.0, 2.0, 3.0, 4.0 }; + + // Specify the number of indexed elements: + const int N = 4; + + // Create an output array (N*N pairs, each pair has 2 elements): + double out[ 32 ]; + + // Specify strides: + const int strideX = 1; + const int strideOut1 = 2; + const int strideOut2 = 1; + + // Compute the Cartesian square: + stdlib_strided_dcartesian_square( N, x, strideX, out, strideOut1, strideOut2 ); + + // Print the result: + for ( int i = 0; i < N*N; i++ ) { + printf( "out[ %i ] = ( %lf, %lf )\n", i, out[ i*2 ], out[ i*2+1 ] ); + } +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/index.js new file mode 100644 index 000000000000..03dd16115873 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/index.js @@ -0,0 +1,33 @@ +/** +* @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'; + +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var Float64Array = require( '@stdlib/array/float64' ); +var dcartesianSquare = require( './../lib' ); + +var N = 4; +var x = discreteUniform( N, 1, 10, { + 'dtype': 'float64' +}); +console.log( x ); + +var out = new Float64Array( N * N * 2 ); +dcartesianSquare( N, x, 1, out, 2, 1 ); +console.log( out ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/include.gypi b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/include.gypi new file mode 100644 index 000000000000..bee8d41a2caf --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/include.gypi @@ -0,0 +1,53 @@ +# @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. + +# A GYP include file for building a Node.js native add-on. +# +# Main documentation: +# +# [1]: https://gyp.gsrc.io/docs/InputFormatReference.md +# [2]: https://gyp.gsrc.io/docs/UserDocumentation.md +{ + # Define variables to be used throughout the configuration for all targets: + 'variables': { + # Source directory: + 'src_dir': './src', + + # Include directories: + 'include_dirs': [ + ' [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +*/ +function dcartesianSquare( N, x, strideX, out, strideOut1, strideOut2 ) { + return ndarray( N, x, strideX, stride2offset( N, strideX ), out, strideOut1, strideOut2, stride2offset( N * N, strideOut1 ) + stride2offset( 2, strideOut2 ) ); // eslint-disable-line max-len +} + + +// EXPORTS // + +module.exports = dcartesianSquare; diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js new file mode 100644 index 000000000000..cf3dda1a0237 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js @@ -0,0 +1,56 @@ +/** +* @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 addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Computes the Cartesian square for a double-precision floating-point strided array. +* +* @param {NonNegativeInteger} N - number of indexed elements +* @param {Float64Array} x - input array +* @param {integer} strideX - stride length +* @param {Float64Array} out - output array +* @param {integer} strideOut1 - stride length between consecutive output pairs +* @param {integer} strideOut2 - stride length between elements of each output pair +* @returns {Float64Array} output array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +* var out = new Float64Array( 18 ); +* +* dcartesianSquare( 3, x, 1, out, 2, 1 ); +* // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +*/ +function dcartesianSquare( N, x, strideX, out, strideOut1, strideOut2 ) { + addon( N, x, strideX, out, strideOut1, strideOut2 ); + return out; +} + + +// EXPORTS // + +module.exports = dcartesianSquare; diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/index.js new file mode 100644 index 000000000000..9d1e12c68e23 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/index.js @@ -0,0 +1,70 @@ +/** +* @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'; + +/** +* Compute the Cartesian square for a double-precision floating-point strided array. +* +* @module @stdlib/blas/ext/base/dcartesian-square +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var dcartesianSquare = require( '@stdlib/blas/ext/base/dcartesian-square' ); +* +* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +* var out = new Float64Array( 18 ); +* +* dcartesianSquare( x.length, x, 1, out, 2, 1 ); +* // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* var dcartesianSquare = require( '@stdlib/blas/ext/base/dcartesian-square' ); +* +* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +* var out = new Float64Array( 18 ); +* +* dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, 0 ); +* // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +*/ + +// MODULES // + +var join = require( 'path' ).join; +var tryRequire = require( '@stdlib/utils/try-require' ); +var isError = require( '@stdlib/assert/is-error' ); +var main = require( './main.js' ); + + +// MAIN // + +var dcartesianSquare; +var tmp = tryRequire( join( __dirname, './native.js' ) ); +if ( isError( tmp ) ) { + dcartesianSquare = main; +} else { + dcartesianSquare = tmp; +} + + +// EXPORTS // + +module.exports = dcartesianSquare; + +// exports: { "ndarray": "dcartesianSquare.ndarray" } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/main.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/main.js new file mode 100644 index 000000000000..5f187bdbf75e --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/main.js @@ -0,0 +1,35 @@ +/** +* @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 setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var dcartesianSquare = require( './dcartesiansquare.js' ); +var ndarray = require( './ndarray.js' ); + + +// MAIN // + +setReadOnly( dcartesianSquare, 'ndarray', ndarray ); + + +// EXPORTS // + +module.exports = dcartesianSquare; diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/native.js new file mode 100644 index 000000000000..a7fad5959a01 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/native.js @@ -0,0 +1,35 @@ +/** +* @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 setReadOnly = require( '@stdlib/utils/define-nonenumerable-read-only-property' ); +var dcartesianSquare = require( './dcartesiansquare.native.js' ); +var ndarray = require( './ndarray.native.js' ); + + +// MAIN // + +setReadOnly( dcartesianSquare, 'ndarray', ndarray ); + + +// EXPORTS // + +module.exports = dcartesianSquare; diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js new file mode 100644 index 000000000000..119361715654 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js @@ -0,0 +1,75 @@ +/** +* @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'; + +// MAIN // + +/** +* Computes the Cartesian square for a double-precision floating-point strided array using alternative indexing semantics. +* +* @param {NonNegativeInteger} N - number of indexed elements +* @param {Float64Array} x - input array +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index +* @param {Float64Array} out - output array +* @param {integer} strideOut1 - stride length between consecutive output pairs +* @param {integer} strideOut2 - stride length between elements of each output pair +* @param {NonNegativeInteger} offsetOut - starting index +* @returns {Float64Array} output array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +* var out = new Float64Array( 18 ); +* +* dcartesianSquare( 3, x, 1, 0, out, 2, 1, 0 ); +* // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +*/ +function dcartesianSquare( N, x, strideX, offsetX, out, strideOut1, strideOut2, offsetOut ) { // eslint-disable-line max-len + var xi; + var xj; + var io; + var v; + var i; + var j; + + if ( N <= 0 ) { + return out; + } + xi = offsetX; + io = offsetOut; + for ( i = 0; i < N; i++ ) { + v = x[ xi ]; + xj = offsetX; + for ( j = 0; j < N; j++ ) { + out[ io ] = v; + out[ io + strideOut2 ] = x[ xj ]; + io += strideOut1; + xj += strideX; + } + xi += strideX; + } + return out; +} + + +// EXPORTS // + +module.exports = dcartesianSquare; diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js new file mode 100644 index 000000000000..c601c5eca212 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js @@ -0,0 +1,58 @@ +/** +* @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 addon = require( './../src/addon.node' ); + + +// MAIN // + +/** +* Computes the Cartesian square for a double-precision floating-point strided array using alternative indexing semantics. +* +* @param {NonNegativeInteger} N - number of indexed elements +* @param {Float64Array} x - input array +* @param {integer} strideX - stride length +* @param {NonNegativeInteger} offsetX - starting index +* @param {Float64Array} out - output array +* @param {integer} strideOut1 - stride length between consecutive output pairs +* @param {integer} strideOut2 - stride length between elements of each output pair +* @param {NonNegativeInteger} offsetOut - starting index +* @returns {Float64Array} output array +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); +* var out = new Float64Array( 18 ); +* +* dcartesianSquare( 3, x, 1, 0, out, 2, 1, 0 ); +* // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +*/ +function dcartesianSquare( N, x, strideX, offsetX, out, strideOut1, strideOut2, offsetOut ) { // eslint-disable-line max-len + addon.ndarray( N, x, strideX, offsetX, out, strideOut1, strideOut2, offsetOut ); // eslint-disable-line max-len + return out; +} + + +// EXPORTS // + +module.exports = dcartesianSquare; diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/manifest.json b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/manifest.json new file mode 100644 index 000000000000..90910926e84f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/manifest.json @@ -0,0 +1,79 @@ +{ + "options": { + "task": "build" + }, + "fields": [ + { + "field": "src", + "resolve": true, + "relative": true + }, + { + "field": "include", + "resolve": true, + "relative": true + }, + { + "field": "libraries", + "resolve": false, + "relative": false + }, + { + "field": "libpath", + "resolve": true, + "relative": false + } + ], + "confs": [ + { + "task": "build", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset", + "@stdlib/napi/export", + "@stdlib/napi/argv", + "@stdlib/napi/argv-float64array", + "@stdlib/napi/argv-int64", + "@stdlib/napi/argv-strided-float64array" + ] + }, + { + "task": "benchmark", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" + ] + }, + { + "task": "examples", + "src": [ + "./src/main.c" + ], + "include": [ + "./include" + ], + "libraries": [], + "libpath": [], + "dependencies": [ + "@stdlib/blas/base/shared", + "@stdlib/strided/base/stride2offset" + ] + } + ] +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/package.json b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/package.json new file mode 100644 index 000000000000..3a309cd18d31 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/package.json @@ -0,0 +1,75 @@ +{ + "name": "@stdlib/blas/ext/base/dcartesian-square", + "version": "0.0.0", + "description": "Compute the Cartesian square for a double-precision floating-point strided array.", + "license": "Apache-2.0", + "author": { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + }, + "contributors": [ + { + "name": "The Stdlib Authors", + "url": "https://github.com/stdlib-js/stdlib/graphs/contributors" + } + ], + "main": "./lib", + "browser": "./lib/main.js", + "gypfile": true, + "directories": { + "benchmark": "./benchmark", + "doc": "./docs", + "example": "./examples", + "include": "./include", + "lib": "./lib", + "src": "./src", + "test": "./test" + }, + "types": "./docs/types", + "scripts": {}, + "homepage": "https://github.com/stdlib-js/stdlib", + "repository": { + "type": "git", + "url": "git://github.com/stdlib-js/stdlib.git" + }, + "bugs": { + "url": "https://github.com/stdlib-js/stdlib/issues" + }, + "dependencies": {}, + "devDependencies": {}, + "engines": { + "node": ">=0.10.0", + "npm": ">2.7.0" + }, + "os": [ + "aix", + "darwin", + "freebsd", + "linux", + "macos", + "openbsd", + "sunos", + "win32", + "windows" + ], + "keywords": [ + "stdlib", + "stdmath", + "mathematics", + "math", + "blas", + "extended", + "cartesian", + "product", + "square", + "strided", + "array", + "ndarray", + "float64", + "double", + "float64array" + ], + "__stdlib__": { + "wasm": false + } +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/Makefile b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/Makefile new file mode 100644 index 000000000000..2caf905cedbe --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/Makefile @@ -0,0 +1,70 @@ +#/ +# @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. +#/ + +# VARIABLES # + +ifndef VERBOSE + QUIET := @ +else + QUIET := +endif + +# Determine the OS ([1][1], [2][2]). +# +# [1]: https://en.wikipedia.org/wiki/Uname#Examples +# [2]: http://stackoverflow.com/a/27776822/2225624 +OS ?= $(shell uname) +ifneq (, $(findstring MINGW,$(OS))) + OS := WINNT +else +ifneq (, $(findstring MSYS,$(OS))) + OS := WINNT +else +ifneq (, $(findstring CYGWIN,$(OS))) + OS := WINNT +else +ifneq (, $(findstring Windows_NT,$(OS))) + OS := WINNT +endif +endif +endif +endif + + +# RULES # + +#/ +# Removes generated files for building an add-on. +# +# @example +# make clean-addon +#/ +clean-addon: + $(QUIET) -rm -f *.o *.node + +.PHONY: clean-addon + +#/ +# Removes generated files. +# +# @example +# make clean +#/ +clean: clean-addon + +.PHONY: clean diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/addon.c b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/addon.c new file mode 100644 index 000000000000..5a4873dfe6de --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/addon.c @@ -0,0 +1,70 @@ +/** +* @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. +*/ + +#include "stdlib/blas/ext/base/dcartesiansquare.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/napi/export.h" +#include "stdlib/napi/argv.h" +#include "stdlib/napi/argv_int64.h" +#include "stdlib/napi/argv_float64array.h" +#include "stdlib/napi/argv_strided_float64array.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, 6 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); + STDLIB_NAPI_ARGV_INT64( env, strideOut1, argv, 4 ); + STDLIB_NAPI_ARGV_INT64( env, strideOut2, argv, 5 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_ARGV_FLOAT64ARRAY( env, Out, out_len, argv, 3 ); + (void)out_len; + API_SUFFIX(stdlib_strided_dcartesian_square)( N, X, strideX, Out, strideOut1, strideOut2 ); + return NULL; +} + +/** +* 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, 8 ); + 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_INT64( env, strideOut1, argv, 5 ); + STDLIB_NAPI_ARGV_INT64( env, strideOut2, argv, 6 ); + STDLIB_NAPI_ARGV_INT64( env, offsetOut, argv, 7 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); + STDLIB_NAPI_ARGV_FLOAT64ARRAY( env, Out, out_len, argv, 4 ); + (void)out_len; + API_SUFFIX(stdlib_strided_dcartesian_square_ndarray)( N, X, strideX, offsetX, Out, strideOut1, strideOut2, offsetOut ); + return NULL; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c new file mode 100644 index 000000000000..838b1afbbc8d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c @@ -0,0 +1,75 @@ +/** +* @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. +*/ + +#include "stdlib/blas/ext/base/dcartesiansquare.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/strided/base/stride2offset.h" + +/** +* Computes the Cartesian square for a double-precision floating-point strided array. +* +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @param Out output array +* @param strideOut1 stride length between consecutive output pairs +* @param strideOut2 stride length between elements of each output pair +*/ +void API_SUFFIX(stdlib_strided_dcartesian_square)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT strideOut1, const CBLAS_INT strideOut2 ) { + CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); + CBLAS_INT oo = stdlib_strided_stride2offset( N*N, strideOut1 ) + stdlib_strided_stride2offset( 2, strideOut2 ); + API_SUFFIX(stdlib_strided_dcartesian_square_ndarray)( N, X, strideX, ox, Out, strideOut1, strideOut2, oo ); +} + +/** +* Computes the Cartesian square for a double-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 +* @param Out output array +* @param strideOut1 stride length between consecutive output pairs +* @param strideOut2 stride length between elements of each output pair +* @param offsetOut starting index +*/ +void API_SUFFIX(stdlib_strided_dcartesian_square_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *Out, const CBLAS_INT strideOut1, const CBLAS_INT strideOut2, const CBLAS_INT offsetOut ) { + CBLAS_INT xi; + CBLAS_INT xj; + CBLAS_INT io; + CBLAS_INT i; + CBLAS_INT j; + double v; + + if ( N <= 0 ) { + return; + } + xi = offsetX; + io = offsetOut; + for ( i = 0; i < N; i++ ) { + v = X[ xi ]; + xj = offsetX; + for ( j = 0; j < N; j++ ) { + Out[ io ] = v; + Out[ io + strideOut2 ] = X[ xj ]; + io += strideOut1; + xj += strideX; + } + xi += strideX; + } +} diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.js new file mode 100644 index 000000000000..e8a61f5307fd --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.js @@ -0,0 +1,225 @@ +/** +* @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 tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var dcartesianSquare = require( './../lib/dcartesiansquare.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dcartesianSquare, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 6', function test( t ) { + t.strictEqual( dcartesianSquare.length, 6, 'has expected arity' ); + t.end(); +}); + +tape( 'the function computes the Cartesian square', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( x.length, x, 1, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + out = new Float64Array( 18 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] ); + + dcartesianSquare( x.length, x, 1, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns a reference to the output array', function test( t ) { + var out; + var x; + var y; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + y = dcartesianSquare( x.length, x, 1, out, 2, 1 ); + + t.strictEqual( y, out, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the output array unchanged', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( [ 3.0, 4.0, 5.0, 6.0 ] ); + expected = new Float64Array( [ 3.0, 4.0, 5.0, 6.0 ] ); + + dcartesianSquare( 0, x, 1, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + dcartesianSquare( -4, x, 1, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports N=1', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 5.0 ] ); + out = new Float64Array( 2 ); + expected = new Float64Array( [ 5.0, 5.0 ] ); + + dcartesianSquare( 1, x, 1, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a stride for `x`', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array([ + 1.0, // 0 + 0.0, + 2.0, // 1 + 0.0 + ]); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( 2, x, 2, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a negative stride for `x`', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array([ + 2.0, // 1 + 1.0 // 0 + ]); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( 2, x, -1, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a stride for the output pairs', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 16 ); + expected = new Float64Array([ + 1.0, + 1.0, + 0.0, + 0.0, + 1.0, + 2.0, + 0.0, + 0.0, + 2.0, + 1.0, + 0.0, + 0.0, + 2.0, + 2.0, + 0.0, + 0.0 + ]); + + dcartesianSquare( 2, x, 1, out, 4, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a negative stride for the output pairs', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 2.0, 2.0, 2.0, 1.0, 1.0, 2.0, 1.0, 1.0 ] ); + + dcartesianSquare( 2, x, 1, out, -2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a negative stride for the output pair elements', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 2.0, 1.0, 1.0, 2.0, 2.0, 2.0 ] ); + + dcartesianSquare( 2, x, 1, out, 2, -1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports view offsets', function test( t ) { + var expected; + var out; + var x0; + var x1; + + x0 = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( 2, x1, 1, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.native.js new file mode 100644 index 000000000000..2360ec5335fe --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.native.js @@ -0,0 +1,157 @@ +/** +* @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 tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var dcartesianSquare = tryRequire( resolve( __dirname, './../lib/dcartesiansquare.native.js' ) ); +var opts = { + 'skip': ( dcartesianSquare instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dcartesianSquare, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 6', opts, function test( t ) { + t.strictEqual( dcartesianSquare.length, 6, 'has expected arity' ); + t.end(); +}); + +tape( 'the function computes the Cartesian square', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( x.length, x, 1, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + out = new Float64Array( 18 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] ); + + dcartesianSquare( x.length, x, 1, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns a reference to the output array', opts, function test( t ) { + var out; + var x; + var y; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + y = dcartesianSquare( x.length, x, 1, out, 2, 1 ); + + t.strictEqual( y, out, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the output array unchanged', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( [ 3.0, 4.0, 5.0, 6.0 ] ); + expected = new Float64Array( [ 3.0, 4.0, 5.0, 6.0 ] ); + + dcartesianSquare( 0, x, 1, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + dcartesianSquare( -4, x, 1, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a stride for `x`', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array([ + 1.0, // 0 + 0.0, + 2.0, // 1 + 0.0 + ]); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( 2, x, 2, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a negative stride for `x`', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array([ + 2.0, // 1 + 1.0 // 0 + ]); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( 2, x, -1, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports view offsets', opts, function test( t ) { + var expected; + var out; + var x0; + var x1; + + x0 = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); + x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( 2, x1, 1, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.js new file mode 100644 index 000000000000..e655a3dee337 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.js @@ -0,0 +1,82 @@ +/** +* @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 tape = require( 'tape' ); +var proxyquire = require( 'proxyquire' ); +var IS_BROWSER = require( '@stdlib/assert/is-browser' ); +var dcartesianSquare = require( './../lib' ); + + +// VARIABLES // + +var opts = { + 'skip': IS_BROWSER +}; + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dcartesianSquare, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'attached to the main export is a method providing an ndarray interface', function test( t ) { + t.strictEqual( typeof dcartesianSquare.ndarray, 'function', 'method is a function' ); + t.end(); +}); + +tape( 'if a native implementation is available, the main export is the native implementation', opts, function test( t ) { + var dcartesianSquare = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( dcartesianSquare, mock, 'returns native implementation' ); + t.end(); + + function tryRequire() { + return mock; + } + + function mock() { + // Mock... + } +}); + +tape( 'if a native implementation is not available, the main export is a JavaScript implementation', opts, function test( t ) { + var dcartesianSquare; + var main; + + main = require( './../lib/dcartesiansquare.js' ); + + dcartesianSquare = proxyquire( './../lib', { + '@stdlib/utils/try-require': tryRequire + }); + + t.strictEqual( dcartesianSquare, main, 'returns JavaScript implementation' ); + t.end(); + + function tryRequire() { + return new Error( 'Cannot find module' ); + } +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.js new file mode 100644 index 000000000000..6938349d46b3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.js @@ -0,0 +1,237 @@ +/** +* @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 tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var dcartesianSquare = require( './../lib/ndarray.js' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dcartesianSquare, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 8', function test( t ) { + t.strictEqual( dcartesianSquare.length, 8, 'has expected arity' ); + t.end(); +}); + +tape( 'the function computes the Cartesian square', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( x.length, x, 1, 0, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + out = new Float64Array( 18 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] ); // eslint-disable-line max-len + + dcartesianSquare( x.length, x, 1, 0, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns a reference to the output array', function test( t ) { + var out; + var x; + var y; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + y = dcartesianSquare( x.length, x, 1, 0, out, 2, 1, 0 ); + + t.strictEqual( y, out, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the output array unchanged', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( [ 3.0, 4.0, 5.0, 6.0 ] ); + expected = new Float64Array( [ 3.0, 4.0, 5.0, 6.0 ] ); + + dcartesianSquare( 0, x, 1, 0, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + dcartesianSquare( -4, x, 1, 0, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports N=1', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 5.0 ] ); + out = new Float64Array( 2 ); + expected = new Float64Array( [ 5.0, 5.0 ] ); + + dcartesianSquare( 1, x, 1, 0, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a stride for `x`', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array([ + 1.0, // 0 + 0.0, + 2.0, // 1 + 0.0 + ]); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( 2, x, 2, 0, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a negative stride for `x`', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array([ + 2.0, // 1 + 1.0 // 0 + ]); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( 2, x, -1, 1, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a stride for the output pairs', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 16 ); + expected = new Float64Array([ + 1.0, + 1.0, + 0.0, + 0.0, + 1.0, + 2.0, + 0.0, + 0.0, + 2.0, + 1.0, + 0.0, + 0.0, + 2.0, + 2.0, + 0.0, + 0.0 + ]); + + dcartesianSquare( 2, x, 1, 0, out, 4, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a negative stride for the output pairs', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 2.0, 2.0, 2.0, 1.0, 1.0, 2.0, 1.0, 1.0 ] ); + + dcartesianSquare( 2, x, 1, 0, out, -2, 1, 6 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a negative stride for the output pair elements', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 2.0, 1.0, 1.0, 2.0, 2.0, 2.0 ] ); + + dcartesianSquare( 2, x, 1, 0, out, 2, -1, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an `offsetX` parameter', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( 2, x, 1, 1, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an `offsetOut` parameter', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 10 ); + expected = new Float64Array( [ 0.0, 0.0, 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); // eslint-disable-line max-len + + dcartesianSquare( 2, x, 1, 0, out, 2, 1, 2 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.native.js new file mode 100644 index 000000000000..2f471e44876d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.native.js @@ -0,0 +1,151 @@ +/** +* @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 tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var tryRequire = require( '@stdlib/utils/try-require' ); + + +// VARIABLES // + +var dcartesianSquare = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( dcartesianSquare instanceof Error ) +}; + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dcartesianSquare, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 8', opts, function test( t ) { + t.strictEqual( dcartesianSquare.length, 8, 'has expected arity' ); + t.end(); +}); + +tape( 'the function computes the Cartesian square', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( x.length, x, 1, 0, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); + out = new Float64Array( 18 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] ); // eslint-disable-line max-len + + dcartesianSquare( x.length, x, 1, 0, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function returns a reference to the output array', opts, function test( t ) { + var out; + var x; + var y; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + y = dcartesianSquare( x.length, x, 1, 0, out, 2, 1, 0 ); + + t.strictEqual( y, out, 'same reference' ); + t.end(); +}); + +tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the output array unchanged', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( [ 3.0, 4.0, 5.0, 6.0 ] ); + expected = new Float64Array( [ 3.0, 4.0, 5.0, 6.0 ] ); + + dcartesianSquare( 0, x, 1, 0, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + dcartesianSquare( -4, x, 1, 0, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a stride for `x`', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array([ + 1.0, // 0 + 0.0, + 2.0, // 1 + 0.0 + ]); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( 2, x, 2, 0, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an `offsetX` parameter', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( 2, x, 1, 1, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports an `offsetOut` parameter', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 10 ); + expected = new Float64Array( [ 0.0, 0.0, 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); // eslint-disable-line max-len + + dcartesianSquare( 2, x, 1, 0, out, 2, 1, 2 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); From 5c721ab8ab1884ce30521fabddba9cea8ef8611f Mon Sep 17 00:00:00 2001 From: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> Date: Sun, 8 Mar 2026 01:35:57 +0500 Subject: [PATCH 2/5] docs: apply suggestion from code review Signed-off-by: Muhammad Haris <101793258+headlessNode@users.noreply.github.com> --- .../@stdlib/blas/ext/base/dcartesian-square/README.md | 6 +++--- .../blas/ext/base/dcartesian-square/examples/c/example.c | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md index 91d8ee486c2f..9b9e29c3b56c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md @@ -187,7 +187,7 @@ console.log( out ); Computes the Cartesian square for a double-precision floating-point strided array. ```c -double x[] = { 1.0, 2.0, 3.0, 4.0 }; +const double x[] = { 1.0, 2.0, 3.0, 4.0 }; double out[ 32 ]; stdlib_strided_dcartesian_square( 4, x, 1, out, 2, 1 ); @@ -213,7 +213,7 @@ void stdlib_strided_dcartesian_square( const CBLAS_INT N, const double *X, const Computes the Cartesian square for a double-precision floating-point strided array using alternative indexing semantics. ```c -double x[] = { 1.0, 2.0, 3.0, 4.0 }; +const double x[] = { 1.0, 2.0, 3.0, 4.0 }; double out[ 32 ]; stdlib_strided_dcartesian_square_ndarray( 4, x, 1, 0, out, 2, 1, 0 ); @@ -258,7 +258,7 @@ void stdlib_strided_dcartesian_square_ndarray( const CBLAS_INT N, const double * int main( void ) { // Create a strided input array: - double x[] = { 1.0, 2.0, 3.0, 4.0 }; + const double x[] = { 1.0, 2.0, 3.0, 4.0 }; // Specify the number of indexed elements: const int N = 4; diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/example.c b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/example.c index 53eb92dff3c6..d35ec6c6948a 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/example.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/example.c @@ -21,7 +21,7 @@ int main( void ) { // Create a strided input array: - double x[] = { 1.0, 2.0, 3.0, 4.0 }; + const double x[] = { 1.0, 2.0, 3.0, 4.0 }; // Specify the number of indexed elements: const int N = 4; From 6130af23c249873b9661f29d7eac40bb95fbe2a1 Mon Sep 17 00:00:00 2001 From: headlessNode Date: Sun, 8 Mar 2026 22:43:14 +0500 Subject: [PATCH 3/5] fix: apply suggestions from code review --- 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: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../blas/ext/base/dcartesian-square/README.md | 12 ++-- .../dcartesian-square/docs/types/index.d.ts | 12 ++-- .../dcartesian-square/lib/dcartesiansquare.js | 12 ++-- .../lib/dcartesiansquare.native.js | 8 +-- .../ext/base/dcartesian-square/lib/index.js | 12 ++-- .../ext/base/dcartesian-square/lib/ndarray.js | 26 ++++---- .../dcartesian-square/lib/ndarray.native.js | 8 +-- .../ext/base/dcartesian-square/manifest.json | 4 +- .../ext/base/dcartesian-square/src/addon.c | 8 +-- .../ext/base/dcartesian-square/src/main.c | 18 +++--- .../test/test.dcartesiansquare.js | 48 +++++++++------ .../test/test.dcartesiansquare.native.js | 33 ++++++++-- .../dcartesian-square/test/test.ndarray.js | 61 ++++++++++++------- .../test/test.ndarray.native.js | 46 ++++++++++++-- 14 files changed, 196 insertions(+), 112 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md index 9b9e29c3b56c..7fe7562de616 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md @@ -37,11 +37,11 @@ Computes the Cartesian square for a double-precision floating-point strided arra ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); -var out = new Float64Array( 18 ); +var x = new Float64Array( [ 1.0, 2.0 ] ); +var out = new Float64Array( 8 ); dcartesianSquare( x.length, x, 1, out, 2, 1 ); -// out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +// out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ``` The function has the following parameters: @@ -91,11 +91,11 @@ Computes the Cartesian square for a double-precision floating-point strided arra ```javascript var Float64Array = require( '@stdlib/array/float64' ); -var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); -var out = new Float64Array( 18 ); +var x = new Float64Array( [ 1.0, 2.0 ] ); +var out = new Float64Array( 8 ); dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, 0 ); -// out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +// out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ``` The function has the following additional parameters: diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts index 6b709106b854..b7cc9ed62f3e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts @@ -36,11 +36,11 @@ interface Routine { * @example * var Float64Array = require( `@stdlib/array/float64` ); * - * var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); - * var out = new Float64Array( 18 ); + * var x = new Float64Array( [ 1.0, 2.0 ] ); + * var out = new Float64Array( 8 ); * * dcartesianSquare( x.length, x, 1, out, 2, 1 ); - * // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] + * // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] */ ( N: number, x: Float64Array, strideX: number, out: Float64Array, strideOut1: number, strideOut2: number ): Float64Array; @@ -60,11 +60,11 @@ interface Routine { * @example * var Float64Array = require( `@stdlib/array/float64` ); * - * var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); - * var out = new Float64Array( 18 ); + * var x = new Float64Array( [ 1.0, 2.0 ] ); + * var out = new Float64Array( 8 ); * * dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, 0 ); - * // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] + * // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] */ ndarray( N: number, x: Float64Array, strideX: number, offsetX: number, out: Float64Array, strideOut1: number, strideOut2: number, offsetOut: number ): Float64Array; } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.js index 133419a5955d..1be665334851 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.js @@ -40,14 +40,16 @@ var ndarray = require( './ndarray.js' ); * @example * var Float64Array = require( '@stdlib/array/float64' ); * -* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); -* var out = new Float64Array( 18 ); +* var x = new Float64Array( [ 1.0, 2.0 ] ); +* var out = new Float64Array( 8 ); * -* dcartesianSquare( 3, x, 1, out, 2, 1 ); -* // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +* dcartesianSquare( x.length, x, 1, out, 2, 1 ); +* // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] */ function dcartesianSquare( N, x, strideX, out, strideOut1, strideOut2 ) { - return ndarray( N, x, strideX, stride2offset( N, strideX ), out, strideOut1, strideOut2, stride2offset( N * N, strideOut1 ) + stride2offset( 2, strideOut2 ) ); // eslint-disable-line max-len + var ox = stride2offset( N, strideX ); + var oo = stride2offset( N * N, strideOut1 ) + stride2offset( 2, strideOut2 ); // eslint-disable-line max-len + return ndarray( N, x, strideX, ox, out, strideOut1, strideOut2, oo ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js index cf3dda1a0237..d6647f54f192 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js @@ -39,11 +39,11 @@ var addon = require( './../src/addon.node' ); * @example * var Float64Array = require( '@stdlib/array/float64' ); * -* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); -* var out = new Float64Array( 18 ); +* var x = new Float64Array( [ 1.0, 2.0 ] ); +* var out = new Float64Array( 8 ); * -* dcartesianSquare( 3, x, 1, out, 2, 1 ); -* // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +* dcartesianSquare( x.length, x, 1, out, 2, 1 ); +* // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] */ function dcartesianSquare( N, x, strideX, out, strideOut1, strideOut2 ) { addon( N, x, strideX, out, strideOut1, strideOut2 ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/index.js index 9d1e12c68e23..daf3d08371cf 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/index.js @@ -27,21 +27,21 @@ * var Float64Array = require( '@stdlib/array/float64' ); * var dcartesianSquare = require( '@stdlib/blas/ext/base/dcartesian-square' ); * -* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); -* var out = new Float64Array( 18 ); +* var x = new Float64Array( [ 1.0, 2.0 ] ); +* var out = new Float64Array( 8 ); * * dcartesianSquare( x.length, x, 1, out, 2, 1 ); -* // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +* // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] * * @example * var Float64Array = require( '@stdlib/array/float64' ); * var dcartesianSquare = require( '@stdlib/blas/ext/base/dcartesian-square' ); * -* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); -* var out = new Float64Array( 18 ); +* var x = new Float64Array( [ 1.0, 2.0 ] ); +* var out = new Float64Array( 8 ); * * dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, 0 ); -* // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +* // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js index 119361715654..cf55ec69213d 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js @@ -21,7 +21,7 @@ // MAIN // /** -* Computes the Cartesian square for a double-precision floating-point strided array using alternative indexing semantics. +* Computes the Cartesian square for a double-precision floating-point strided array using alternative indeixng semantics. * * @param {NonNegativeInteger} N - number of indexed elements * @param {Float64Array} x - input array @@ -36,15 +36,15 @@ * @example * var Float64Array = require( '@stdlib/array/float64' ); * -* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); -* var out = new Float64Array( 18 ); +* var x = new Float64Array( [ 1.0, 2.0 ] ); +* var out = new Float64Array( 8 ); * -* dcartesianSquare( 3, x, 1, 0, out, 2, 1, 0 ); -* // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +* dcartesianSquare( x.length, x, 1, 0, out, 2, 1, 0 ); +* // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] */ function dcartesianSquare( N, x, strideX, offsetX, out, strideOut1, strideOut2, offsetOut ) { // eslint-disable-line max-len - var xi; - var xj; + var ix; + var jx; var io; var v; var i; @@ -53,18 +53,18 @@ function dcartesianSquare( N, x, strideX, offsetX, out, strideOut1, strideOut2, if ( N <= 0 ) { return out; } - xi = offsetX; + ix = offsetX; io = offsetOut; for ( i = 0; i < N; i++ ) { - v = x[ xi ]; - xj = offsetX; + v = x[ ix ]; + jx = offsetX; for ( j = 0; j < N; j++ ) { out[ io ] = v; - out[ io + strideOut2 ] = x[ xj ]; + out[ io + strideOut2 ] = x[ jx ]; io += strideOut1; - xj += strideX; + jx += strideX; } - xi += strideX; + ix += strideX; } return out; } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js index c601c5eca212..cb6db36b82d6 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js @@ -41,11 +41,11 @@ var addon = require( './../src/addon.node' ); * @example * var Float64Array = require( '@stdlib/array/float64' ); * -* var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); -* var out = new Float64Array( 18 ); +* var x = new Float64Array( [ 1.0, 2.0 ] ); +* var out = new Float64Array( 8 ); * -* dcartesianSquare( 3, x, 1, 0, out, 2, 1, 0 ); -* // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] +* dcartesianSquare( x.length, x, 1, 0, out, 2, 1, 0 ); +* // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] */ function dcartesianSquare( N, x, strideX, offsetX, out, strideOut1, strideOut2, offsetOut ) { // eslint-disable-line max-len addon.ndarray( N, x, strideX, offsetX, out, strideOut1, strideOut2, offsetOut ); // eslint-disable-line max-len diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/manifest.json b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/manifest.json index 90910926e84f..4e02a05fb7d8 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/manifest.json +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/manifest.json @@ -40,9 +40,9 @@ "@stdlib/strided/base/stride2offset", "@stdlib/napi/export", "@stdlib/napi/argv", - "@stdlib/napi/argv-float64array", "@stdlib/napi/argv-int64", - "@stdlib/napi/argv-strided-float64array" + "@stdlib/napi/argv-strided-float64array", + "@stdlib/napi/argv-strided-float64array2d" ] }, { diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/addon.c b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/addon.c index 5a4873dfe6de..1fa1855524f7 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/addon.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/addon.c @@ -21,8 +21,8 @@ #include "stdlib/napi/export.h" #include "stdlib/napi/argv.h" #include "stdlib/napi/argv_int64.h" -#include "stdlib/napi/argv_float64array.h" #include "stdlib/napi/argv_strided_float64array.h" +#include "stdlib/napi/argv_strided_float64array2d.h" #include /** @@ -39,8 +39,7 @@ static napi_value addon( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV_INT64( env, strideOut1, argv, 4 ); STDLIB_NAPI_ARGV_INT64( env, strideOut2, argv, 5 ); STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); - STDLIB_NAPI_ARGV_FLOAT64ARRAY( env, Out, out_len, argv, 3 ); - (void)out_len; + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY2D( env, Out, N*N, 2, strideOut1, strideOut2, argv, 3 ); API_SUFFIX(stdlib_strided_dcartesian_square)( N, X, strideX, Out, strideOut1, strideOut2 ); return NULL; } @@ -61,8 +60,7 @@ static napi_value addon_method( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV_INT64( env, strideOut2, argv, 6 ); STDLIB_NAPI_ARGV_INT64( env, offsetOut, argv, 7 ); STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); - STDLIB_NAPI_ARGV_FLOAT64ARRAY( env, Out, out_len, argv, 4 ); - (void)out_len; + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY2D( env, Out, N*N, 2, strideOut1, strideOut2, argv, 4 ); API_SUFFIX(stdlib_strided_dcartesian_square_ndarray)( N, X, strideX, offsetX, Out, strideOut1, strideOut2, offsetOut ); return NULL; } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c index 838b1afbbc8d..52a958b99077 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c @@ -37,7 +37,7 @@ void API_SUFFIX(stdlib_strided_dcartesian_square)( const CBLAS_INT N, const doub } /** -* Computes the Cartesian square for a double-precision floating-point strided array using alternative indexing semantics. +* Computes the Cartesian square for a double-precision floating-point strided array using alternative indeixng semantics. * * @param N number of indexed elements * @param X input array @@ -49,8 +49,8 @@ void API_SUFFIX(stdlib_strided_dcartesian_square)( const CBLAS_INT N, const doub * @param offsetOut starting index */ void API_SUFFIX(stdlib_strided_dcartesian_square_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *Out, const CBLAS_INT strideOut1, const CBLAS_INT strideOut2, const CBLAS_INT offsetOut ) { - CBLAS_INT xi; - CBLAS_INT xj; + CBLAS_INT ix; + CBLAS_INT jx; CBLAS_INT io; CBLAS_INT i; CBLAS_INT j; @@ -59,17 +59,17 @@ void API_SUFFIX(stdlib_strided_dcartesian_square_ndarray)( const CBLAS_INT N, co if ( N <= 0 ) { return; } - xi = offsetX; + ix = offsetX; io = offsetOut; for ( i = 0; i < N; i++ ) { - v = X[ xi ]; - xj = offsetX; + v = X[ ix ]; + jx = offsetX; for ( j = 0; j < N; j++ ) { Out[ io ] = v; - Out[ io + strideOut2 ] = X[ xj ]; + Out[ io + strideOut2 ] = X[ jx ]; io += strideOut1; - xj += strideX; + jx += strideX; } - xi += strideX; + ix += strideX; } } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.js index e8a61f5307fd..57812fd6ee8e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.js @@ -52,11 +52,37 @@ tape( 'the function computes the Cartesian square', function test( t ) { x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); out = new Float64Array( 18 ); - expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] ); + expected = new Float64Array([ + 1.0, + 1.0, + 1.0, + 2.0, + 1.0, + 3.0, + 2.0, + 1.0, + 2.0, + 2.0, + 2.0, + 3.0, + 3.0, + 1.0, + 3.0, + 2.0, + 3.0, + 3.0 + ]); dcartesianSquare( x.length, x, 1, out, 2, 1 ); t.deepEqual( out, expected, 'returns expected value' ); + x = new Float64Array( [ 5.0 ] ); + out = new Float64Array( 2 ); + expected = new Float64Array( [ 5.0, 5.0 ] ); + + dcartesianSquare( 1, x, 1, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); }); @@ -73,7 +99,7 @@ tape( 'the function returns a reference to the output array', function test( t ) t.end(); }); -tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the output array unchanged', function test( t ) { +tape( 'if provided an `N` parameter equal to `0`, the function returns the output array unchanged', function test( t ) { var expected; var out; var x; @@ -85,24 +111,6 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu dcartesianSquare( 0, x, 1, out, 2, 1 ); t.deepEqual( out, expected, 'returns expected value' ); - dcartesianSquare( -4, x, 1, out, 2, 1 ); - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports N=1', function test( t ) { - var expected; - var out; - var x; - - x = new Float64Array( [ 5.0 ] ); - out = new Float64Array( 2 ); - expected = new Float64Array( [ 5.0, 5.0 ] ); - - dcartesianSquare( 1, x, 1, out, 2, 1 ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.native.js index 2360ec5335fe..b1eb37dcc5d3 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.native.js @@ -61,11 +61,37 @@ tape( 'the function computes the Cartesian square', opts, function test( t ) { x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); out = new Float64Array( 18 ); - expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] ); + expected = new Float64Array([ + 1.0, + 1.0, + 1.0, + 2.0, + 1.0, + 3.0, + 2.0, + 1.0, + 2.0, + 2.0, + 2.0, + 3.0, + 3.0, + 1.0, + 3.0, + 2.0, + 3.0, + 3.0 + ]); dcartesianSquare( x.length, x, 1, out, 2, 1 ); t.deepEqual( out, expected, 'returns expected value' ); + x = new Float64Array( [ 5.0 ] ); + out = new Float64Array( 2 ); + expected = new Float64Array( [ 5.0, 5.0 ] ); + + dcartesianSquare( 1, x, 1, out, 2, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); }); @@ -82,7 +108,7 @@ tape( 'the function returns a reference to the output array', opts, function tes t.end(); }); -tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the output array unchanged', opts, function test( t ) { +tape( 'if provided an `N` parameter equal to `0`, the function returns the output array unchanged', opts, function test( t ) { var expected; var out; var x; @@ -94,9 +120,6 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu dcartesianSquare( 0, x, 1, out, 2, 1 ); t.deepEqual( out, expected, 'returns expected value' ); - dcartesianSquare( -4, x, 1, out, 2, 1 ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); }); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.js index 6938349d46b3..778a2f7abaf1 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.js @@ -52,11 +52,37 @@ tape( 'the function computes the Cartesian square', function test( t ) { x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); out = new Float64Array( 18 ); - expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] ); // eslint-disable-line max-len + expected = new Float64Array([ + 1.0, + 1.0, + 1.0, + 2.0, + 1.0, + 3.0, + 2.0, + 1.0, + 2.0, + 2.0, + 2.0, + 3.0, + 3.0, + 1.0, + 3.0, + 2.0, + 3.0, + 3.0 + ]); dcartesianSquare( x.length, x, 1, 0, out, 2, 1, 0 ); t.deepEqual( out, expected, 'returns expected value' ); + x = new Float64Array( [ 5.0 ] ); + out = new Float64Array( 2 ); + expected = new Float64Array( [ 5.0, 5.0 ] ); + + dcartesianSquare( 1, x, 1, 0, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); }); @@ -73,7 +99,7 @@ tape( 'the function returns a reference to the output array', function test( t ) t.end(); }); -tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the output array unchanged', function test( t ) { +tape( 'if provided an `N` parameter equal to `0`, the function returns the output array unchanged', function test( t ) { var expected; var out; var x; @@ -85,24 +111,6 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu dcartesianSquare( 0, x, 1, 0, out, 2, 1, 0 ); t.deepEqual( out, expected, 'returns expected value' ); - dcartesianSquare( -4, x, 1, 0, out, 2, 1, 0 ); - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports N=1', function test( t ) { - var expected; - var out; - var x; - - x = new Float64Array( [ 5.0 ] ); - out = new Float64Array( 2 ); - expected = new Float64Array( [ 5.0, 5.0 ] ); - - dcartesianSquare( 1, x, 1, 0, out, 2, 1, 0 ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); }); @@ -228,7 +236,18 @@ tape( 'the function supports an `offsetOut` parameter', function test( t ) { x = new Float64Array( [ 1.0, 2.0 ] ); out = new Float64Array( 10 ); - expected = new Float64Array( [ 0.0, 0.0, 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); // eslint-disable-line max-len + expected = new Float64Array([ + 0.0, + 0.0, + 1.0, + 1.0, + 1.0, + 2.0, + 2.0, + 1.0, + 2.0, + 2.0 + ]); dcartesianSquare( 2, x, 1, 0, out, 2, 1, 2 ); t.deepEqual( out, expected, 'returns expected value' ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.native.js index 2f471e44876d..af93542198a5 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.native.js @@ -61,11 +61,37 @@ tape( 'the function computes the Cartesian square', opts, function test( t ) { x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); out = new Float64Array( 18 ); - expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] ); // eslint-disable-line max-len + expected = new Float64Array([ + 1.0, + 1.0, + 1.0, + 2.0, + 1.0, + 3.0, + 2.0, + 1.0, + 2.0, + 2.0, + 2.0, + 3.0, + 3.0, + 1.0, + 3.0, + 2.0, + 3.0, + 3.0 + ]); dcartesianSquare( x.length, x, 1, 0, out, 2, 1, 0 ); t.deepEqual( out, expected, 'returns expected value' ); + x = new Float64Array( [ 5.0 ] ); + out = new Float64Array( 2 ); + expected = new Float64Array( [ 5.0, 5.0 ] ); + + dcartesianSquare( 1, x, 1, 0, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); }); @@ -82,7 +108,7 @@ tape( 'the function returns a reference to the output array', opts, function tes t.end(); }); -tape( 'if provided an `N` parameter less than or equal to `0`, the function returns the output array unchanged', opts, function test( t ) { +tape( 'if provided an `N` parameter equal to `0`, the function returns the output array unchanged', opts, function test( t ) { var expected; var out; var x; @@ -94,9 +120,6 @@ tape( 'if provided an `N` parameter less than or equal to `0`, the function retu dcartesianSquare( 0, x, 1, 0, out, 2, 1, 0 ); t.deepEqual( out, expected, 'returns expected value' ); - dcartesianSquare( -4, x, 1, 0, out, 2, 1, 0 ); - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); }); @@ -142,7 +165,18 @@ tape( 'the function supports an `offsetOut` parameter', opts, function test( t ) x = new Float64Array( [ 1.0, 2.0 ] ); out = new Float64Array( 10 ); - expected = new Float64Array( [ 0.0, 0.0, 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); // eslint-disable-line max-len + expected = new Float64Array([ + 0.0, + 0.0, + 1.0, + 1.0, + 1.0, + 2.0, + 2.0, + 1.0, + 2.0, + 2.0 + ]); dcartesianSquare( 2, x, 1, 0, out, 2, 1, 2 ); t.deepEqual( out, expected, 'returns expected value' ); From 118cf33555a156ab5d8e784bb8c0e0669d07868e Mon Sep 17 00:00:00 2001 From: headlessNode Date: Mon, 9 Mar 2026 14:40:41 +0500 Subject: [PATCH 4/5] refactor: apply suggestions from code review --- 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: passed - task: lint_javascript_src status: passed - 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: missing_dependencies - task: lint_c_examples status: missing_dependencies - task: lint_c_benchmarks status: missing_dependencies - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../blas/ext/base/dcartesian-square/README.md | 33 +++--- .../dcartesian-square/benchmark/benchmark.js | 2 +- .../benchmark/benchmark.native.js | 2 +- .../benchmark/c/benchmark.length.c | 2 +- .../ext/base/dcartesian-square/docs/repl.txt | 19 ++-- .../dcartesian-square/docs/types/index.d.ts | 16 ++- .../base/dcartesian-square/docs/types/test.ts | 104 ++++++++---------- .../dcartesian-square/examples/c/example.c | 5 +- .../base/dcartesian-square/examples/index.js | 2 +- .../stdlib/blas/ext/base/dcartesiansquare.h | 2 +- .../dcartesian-square/lib/dcartesiansquare.js | 11 +- .../lib/dcartesiansquare.native.js | 9 +- .../ext/base/dcartesian-square/lib/index.js | 2 +- .../ext/base/dcartesian-square/lib/ndarray.js | 55 ++++++--- .../dcartesian-square/lib/ndarray.native.js | 4 +- .../ext/base/dcartesian-square/manifest.json | 3 + .../ext/base/dcartesian-square/src/addon.c | 9 +- .../ext/base/dcartesian-square/src/main.c | 74 +++++++++---- .../test/test.dcartesiansquare.js | 43 +++----- .../test/test.dcartesiansquare.native.js | 67 +++++++++-- .../dcartesian-square/test/test.ndarray.js | 15 +++ .../test/test.ndarray.native.js | 95 ++++++++++++++++ 22 files changed, 374 insertions(+), 200 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md index 7fe7562de616..924456994605 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md @@ -30,7 +30,7 @@ limitations under the License. var dcartesianSquare = require( '@stdlib/blas/ext/base/dcartesian-square' ); ``` -#### dcartesianSquare( N, x, strideX, out, strideOut1, strideOut2 ) +#### dcartesianSquare( N, x, strideX, out, LDO ) Computes the Cartesian square for a double-precision floating-point strided array. @@ -40,7 +40,7 @@ var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, 2.0 ] ); var out = new Float64Array( 8 ); -dcartesianSquare( x.length, x, 1, out, 2, 1 ); +dcartesianSquare( x.length, x, 1, out, 2 ); // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ``` @@ -50,8 +50,7 @@ The function has the following parameters: - **x**: input [`Float64Array`][@stdlib/array/float64]. - **strideX**: stride length for `x`. - **out**: output [`Float64Array`][@stdlib/array/float64]. -- **strideOut1**: stride length between consecutive output pairs. -- **strideOut2**: stride length between the two elements of each output pair. +- **LDO**: stride of the leading dimension of `out`. The `N` and stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to compute the Cartesian square of every other element: @@ -61,7 +60,7 @@ var Float64Array = require( '@stdlib/array/float64' ); var x = new Float64Array( [ 1.0, 0.0, 2.0, 0.0 ] ); var out = new Float64Array( 8 ); -dcartesianSquare( 2, x, 2, out, 2, 1 ); +dcartesianSquare( 2, x, 2, out, 2 ); // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ``` @@ -78,7 +77,7 @@ var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd // Compute the Cartesian square of the first two elements of the view: var out = new Float64Array( 8 ); -dcartesianSquare( 2, x1, 1, out, 2, 1 ); +dcartesianSquare( 2, x1, 1, out, 2 ); // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ``` @@ -101,6 +100,8 @@ dcartesianSquare.ndarray( x.length, x, 1, 0, out, 2, 1, 0 ); The function has the following additional parameters: - **offsetX**: starting index for `x`. +- **strideOut1**: stride length of the first dimension of `out`. +- **strideOut2**: stride length of the second dimension of `out`. - **offsetOut**: starting index for `out`. While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example, to access only the last two elements: @@ -148,7 +149,7 @@ var x = discreteUniform( N, 1, 10, { console.log( x ); var out = new Float64Array( N * N * 2 ); -dcartesianSquare( N, x, 1, out, 2, 1 ); +dcartesianSquare( N, x, 1, out, 2 ); console.log( out ); ``` @@ -182,7 +183,7 @@ console.log( out ); #include "stdlib/blas/ext/base/dcartesiansquare.h" ``` -#### stdlib_strided_dcartesian_square( N, \*X, strideX, \*Out, strideOut1, strideOut2 ) +#### stdlib_strided_dcartesian_square( N, \*X, strideX, \*Out, LDO ) Computes the Cartesian square for a double-precision floating-point strided array. @@ -190,7 +191,7 @@ Computes the Cartesian square for a double-precision floating-point strided arra const double x[] = { 1.0, 2.0, 3.0, 4.0 }; double out[ 32 ]; -stdlib_strided_dcartesian_square( 4, x, 1, out, 2, 1 ); +stdlib_strided_dcartesian_square( 4, x, 1, out, 2 ); ``` The function accepts the following arguments: @@ -199,11 +200,10 @@ The function accepts the following arguments: - **X**: `[in] double*` input array. - **strideX**: `[in] CBLAS_INT` stride length for `X`. - **Out**: `[out] double*` output array. -- **strideOut1**: `[in] CBLAS_INT` stride length between consecutive output pairs. -- **strideOut2**: `[in] CBLAS_INT` stride length between elements of each output pair. +- **LDO**: `[in] CBLAS_INT` stride of the leading dimension of `Out`. ```c -void stdlib_strided_dcartesian_square( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT strideOut1, const CBLAS_INT strideOut2 ); +void stdlib_strided_dcartesian_square( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT LDO ); ``` @@ -226,8 +226,8 @@ The function accepts the following arguments: - **strideX**: `[in] CBLAS_INT` stride length for `X`. - **offsetX**: `[in] CBLAS_INT` starting index for `X`. - **Out**: `[out] double*` output array. -- **strideOut1**: `[in] CBLAS_INT` stride length between consecutive output pairs. -- **strideOut2**: `[in] CBLAS_INT` stride length between elements of each output pair. +- **strideOut1**: `[in] CBLAS_INT` stride length of the first dimension of `Out`. +- **strideOut2**: `[in] CBLAS_INT` stride length of the second dimension of `Out`. - **offsetOut**: `[in] CBLAS_INT` starting index for `Out`. ```c @@ -268,11 +268,10 @@ int main( void ) { // Specify strides: const int strideX = 1; - const int strideOut1 = 2; - const int strideOut2 = 1; + const int LDO = 2; // Compute the Cartesian square: - stdlib_strided_dcartesian_square( N, x, strideX, out, strideOut1, strideOut2 ); + stdlib_strided_dcartesian_square( N, x, strideX, out, LDO ); // Print the result: for ( int i = 0; i < N*N; i++ ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.js index af3d40bcebdb..1c239b3095e4 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.js @@ -66,7 +66,7 @@ function createBenchmark( len ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - y = dcartesianSquare( x.length, x, 1, out, 2, 1 ); + y = dcartesianSquare( x.length, x, 1, out, 2 ); if ( isnan( y[ 0 ] ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.native.js index ddd76a5bb203..cfcf94c7197b 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/benchmark.native.js @@ -71,7 +71,7 @@ function createBenchmark( len ) { b.tic(); for ( i = 0; i < b.iterations; i++ ) { - y = dcartesianSquare( x.length, x, 1, out, 2, 1 ); + y = dcartesianSquare( x.length, x, 1, out, 2 ); if ( isnan( y[ 0 ] ) ) { b.fail( 'should not return NaN' ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/c/benchmark.length.c index e738048a8733..42d6bf7ce279 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/c/benchmark.length.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/benchmark/c/benchmark.length.c @@ -108,7 +108,7 @@ static double benchmark1( int iterations, int len ) { } t = tic(); for ( i = 0; i < iterations; i++ ) { - stdlib_strided_dcartesian_square( len, x, 1, out, 2, 1 ); + stdlib_strided_dcartesian_square( len, x, 1, out, 2 ); if ( out[ 0 ] != out[ 0 ] ) { printf( "should not return NaN\n" ); break; diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/repl.txt index 56f66decb508..b38633afc99c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/repl.txt @@ -1,5 +1,5 @@ -{{alias}}( N, x, strideX, out, strideOut1, strideOut2 ) +{{alias}}( N, x, strideX, out, LDO ) Computes the Cartesian square for a double-precision floating-point strided array. @@ -22,11 +22,8 @@ out: Float64Array Output array. - strideOut1: integer - Stride length between consecutive output pairs. - - strideOut2: integer - Stride length between elements of each output pair. + LDO: integer + Stride of the leading dimension of `out`. Returns ------- @@ -38,20 +35,20 @@ // Standard Usage: > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0 ] ); > var out = new {{alias:@stdlib/array/float64}}( 8 ); - > {{alias}}( x.length, x, 1, out, 2, 1 ) + > {{alias}}( x.length, x, 1, out, 2 ) [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] // Using `N` and stride parameters: > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 0.0, 2.0, 0.0 ] ); > out = new {{alias:@stdlib/array/float64}}( 8 ); - > {{alias}}( 2, x, 2, out, 2, 1 ) + > {{alias}}( 2, x, 2, out, 2 ) [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] // Using view offsets: > var x0 = new {{alias:@stdlib/array/float64}}( [ 0.0, 1.0, 2.0, 3.0 ] ); > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); > out = new {{alias:@stdlib/array/float64}}( 8 ); - > {{alias}}( 2, x1, 1, out, 2, 1 ) + > {{alias}}( 2, x1, 1, out, 2 ) [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] @@ -81,10 +78,10 @@ Output array. strideOut1: integer - Stride length between consecutive output pairs. + Stride length of the first dimension of `out`. strideOut2: integer - Stride length between elements of each output pair. + Stride length of the second dimension of `out`. offsetOut: integer Starting index. diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts index b7cc9ed62f3e..039c002199f4 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts @@ -29,8 +29,7 @@ interface Routine { * @param x - input array * @param strideX - stride length * @param out - output array - * @param strideOut1 - stride length between consecutive output pairs - * @param strideOut2 - stride length between elements of each output pair + * @param LDO - stride of the leading dimension of `out` * @returns output array * * @example @@ -39,10 +38,10 @@ interface Routine { * var x = new Float64Array( [ 1.0, 2.0 ] ); * var out = new Float64Array( 8 ); * - * dcartesianSquare( x.length, x, 1, out, 2, 1 ); + * dcartesianSquare( x.length, x, 1, out, 2 ); * // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] */ - ( N: number, x: Float64Array, strideX: number, out: Float64Array, strideOut1: number, strideOut2: number ): Float64Array; + ( N: number, x: Float64Array, strideX: number, out: Float64Array, LDO: number ): Float64Array; /** * Computes the Cartesian square for a double-precision floating-point strided array using alternative indexing semantics. @@ -52,8 +51,8 @@ interface Routine { * @param strideX - stride length * @param offsetX - starting index * @param out - output array - * @param strideOut1 - stride length between consecutive output pairs - * @param strideOut2 - stride length between elements of each output pair + * @param strideOut1 - stride length of the first dimension of `out` + * @param strideOut2 - stride length of the second dimension of `out` * @param offsetOut - starting index * @returns output array * @@ -76,8 +75,7 @@ interface Routine { * @param x - input array * @param strideX - stride length * @param out - output array -* @param strideOut1 - stride length between consecutive output pairs -* @param strideOut2 - stride length between elements of each output pair +* @param LDO - stride of the leading dimension of `out` * @returns output array * * @example @@ -86,7 +84,7 @@ interface Routine { * var x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); * var out = new Float64Array( 18 ); * -* dcartesianSquare( x.length, x, 1, out, 2, 1 ); +* dcartesianSquare( x.length, x, 1, out, 2 ); * // out => [ 1.0, 1.0, 1.0, 2.0, 1.0, 3.0, 2.0, 1.0, 2.0, 2.0, 2.0, 3.0, 3.0, 1.0, 3.0, 2.0, 3.0, 3.0 ] * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/test.ts b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/test.ts index 4dbf88aeb7a8..84aebb20dd86 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/test.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/test.ts @@ -26,7 +26,7 @@ import dcartesianSquare = require( './index' ); const x = new Float64Array( 3 ); const out = new Float64Array( 18 ); - dcartesianSquare( x.length, x, 1, out, 2, 1 ); // $ExpectType Float64Array + dcartesianSquare( x.length, x, 1, out, 2 ); // $ExpectType Float64Array } // The compiler throws an error if the function is provided a first argument which is not a number... @@ -34,29 +34,29 @@ import dcartesianSquare = require( './index' ); const x = new Float64Array( 3 ); const out = new Float64Array( 18 ); - dcartesianSquare( '10', x, 1, out, 2, 1 ); // $ExpectError - dcartesianSquare( true, x, 1, out, 2, 1 ); // $ExpectError - dcartesianSquare( false, x, 1, out, 2, 1 ); // $ExpectError - dcartesianSquare( null, x, 1, out, 2, 1 ); // $ExpectError - dcartesianSquare( undefined, x, 1, out, 2, 1 ); // $ExpectError - dcartesianSquare( [], x, 1, out, 2, 1 ); // $ExpectError - dcartesianSquare( {}, x, 1, out, 2, 1 ); // $ExpectError - dcartesianSquare( ( x: number ): number => x, x, 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( '10', x, 1, out, 2 ); // $ExpectError + dcartesianSquare( true, x, 1, out, 2 ); // $ExpectError + dcartesianSquare( false, x, 1, out, 2 ); // $ExpectError + dcartesianSquare( null, x, 1, out, 2 ); // $ExpectError + dcartesianSquare( undefined, x, 1, out, 2 ); // $ExpectError + dcartesianSquare( [], x, 1, out, 2 ); // $ExpectError + dcartesianSquare( {}, x, 1, out, 2 ); // $ExpectError + dcartesianSquare( ( x: number ): number => x, x, 1, out, 2 ); // $ExpectError } // The compiler throws an error if the function is provided a second argument which is not a Float64Array... { const out = new Float64Array( 18 ); - dcartesianSquare( 3, 10, 1, out, 2, 1 ); // $ExpectError - dcartesianSquare( 3, '10', 1, out, 2, 1 ); // $ExpectError - dcartesianSquare( 3, true, 1, out, 2, 1 ); // $ExpectError - dcartesianSquare( 3, false, 1, out, 2, 1 ); // $ExpectError - dcartesianSquare( 3, null, 1, out, 2, 1 ); // $ExpectError - dcartesianSquare( 3, undefined, 1, out, 2, 1 ); // $ExpectError - dcartesianSquare( 3, [], 1, out, 2, 1 ); // $ExpectError - dcartesianSquare( 3, {}, 1, out, 2, 1 ); // $ExpectError - dcartesianSquare( 3, ( x: number ): number => x, 1, out, 2, 1 ); // $ExpectError + dcartesianSquare( 3, 10, 1, out, 2 ); // $ExpectError + dcartesianSquare( 3, '10', 1, out, 2 ); // $ExpectError + dcartesianSquare( 3, true, 1, out, 2 ); // $ExpectError + dcartesianSquare( 3, false, 1, out, 2 ); // $ExpectError + dcartesianSquare( 3, null, 1, out, 2 ); // $ExpectError + dcartesianSquare( 3, undefined, 1, out, 2 ); // $ExpectError + dcartesianSquare( 3, [], 1, out, 2 ); // $ExpectError + dcartesianSquare( 3, {}, 1, out, 2 ); // $ExpectError + dcartesianSquare( 3, ( x: number ): number => x, 1, out, 2 ); // $ExpectError } // The compiler throws an error if the function is provided a third argument which is not a number... @@ -64,29 +64,29 @@ import dcartesianSquare = require( './index' ); const x = new Float64Array( 3 ); const out = new Float64Array( 18 ); - dcartesianSquare( x.length, x, '10', out, 2, 1 ); // $ExpectError - dcartesianSquare( x.length, x, true, out, 2, 1 ); // $ExpectError - dcartesianSquare( x.length, x, false, out, 2, 1 ); // $ExpectError - dcartesianSquare( x.length, x, null, out, 2, 1 ); // $ExpectError - dcartesianSquare( x.length, x, undefined, out, 2, 1 ); // $ExpectError - dcartesianSquare( x.length, x, [], out, 2, 1 ); // $ExpectError - dcartesianSquare( x.length, x, {}, out, 2, 1 ); // $ExpectError - dcartesianSquare( x.length, x, ( x: number ): number => x, out, 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, '10', out, 2 ); // $ExpectError + dcartesianSquare( x.length, x, true, out, 2 ); // $ExpectError + dcartesianSquare( x.length, x, false, out, 2 ); // $ExpectError + dcartesianSquare( x.length, x, null, out, 2 ); // $ExpectError + dcartesianSquare( x.length, x, undefined, out, 2 ); // $ExpectError + dcartesianSquare( x.length, x, [], out, 2 ); // $ExpectError + dcartesianSquare( x.length, x, {}, out, 2 ); // $ExpectError + dcartesianSquare( x.length, x, ( x: number ): number => x, out, 2 ); // $ExpectError } // The compiler throws an error if the function is provided a fourth argument which is not a Float64Array... { const x = new Float64Array( 3 ); - dcartesianSquare( x.length, x, 1, 10, 2, 1 ); // $ExpectError - dcartesianSquare( x.length, x, 1, '10', 2, 1 ); // $ExpectError - dcartesianSquare( x.length, x, 1, true, 2, 1 ); // $ExpectError - dcartesianSquare( x.length, x, 1, false, 2, 1 ); // $ExpectError - dcartesianSquare( x.length, x, 1, null, 2, 1 ); // $ExpectError - dcartesianSquare( x.length, x, 1, undefined, 2, 1 ); // $ExpectError - dcartesianSquare( x.length, x, 1, [], 2, 1 ); // $ExpectError - dcartesianSquare( x.length, x, 1, {}, 2, 1 ); // $ExpectError - dcartesianSquare( x.length, x, 1, ( x: number ): number => x, 2, 1 ); // $ExpectError + dcartesianSquare( x.length, x, 1, 10, 2 ); // $ExpectError + dcartesianSquare( x.length, x, 1, '10', 2 ); // $ExpectError + dcartesianSquare( x.length, x, 1, true, 2 ); // $ExpectError + dcartesianSquare( x.length, x, 1, false, 2 ); // $ExpectError + dcartesianSquare( x.length, x, 1, null, 2 ); // $ExpectError + dcartesianSquare( x.length, x, 1, undefined, 2 ); // $ExpectError + dcartesianSquare( x.length, x, 1, [], 2 ); // $ExpectError + dcartesianSquare( x.length, x, 1, {}, 2 ); // $ExpectError + dcartesianSquare( x.length, x, 1, ( x: number ): number => x, 2 ); // $ExpectError } // The compiler throws an error if the function is provided a fifth argument which is not a number... @@ -94,29 +94,14 @@ import dcartesianSquare = require( './index' ); const x = new Float64Array( 3 ); const out = new Float64Array( 18 ); - dcartesianSquare( x.length, x, 1, out, '10', 1 ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, true, 1 ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, false, 1 ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, null, 1 ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, undefined, 1 ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, [], 1 ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, {}, 1 ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, ( x: number ): number => x, 1 ); // $ExpectError -} - -// The compiler throws an error if the function is provided a sixth argument which is not a number... -{ - const x = new Float64Array( 3 ); - const out = new Float64Array( 18 ); - - dcartesianSquare( x.length, x, 1, out, 2, '10' ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, 2, true ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, 2, false ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, 2, null ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, 2, undefined ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, 2, [] ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, 2, {} ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, 2, ( x: number ): number => x ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, '10' ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, true ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, false ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, null ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, undefined ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, [] ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, {} ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, ( x: number ): number => x ); // $ExpectError } // The compiler throws an error if the function is provided an unsupported number of arguments... @@ -129,8 +114,7 @@ import dcartesianSquare = require( './index' ); dcartesianSquare( x.length, x ); // $ExpectError dcartesianSquare( x.length, x, 1 ); // $ExpectError dcartesianSquare( x.length, x, 1, out ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, 2 ); // $ExpectError - dcartesianSquare( x.length, x, 1, out, 2, 1, 0 ); // $ExpectError + dcartesianSquare( x.length, x, 1, out, 2, 1 ); // $ExpectError } // Attached to main export is an `ndarray` method which returns a Float64Array... diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/example.c b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/example.c index d35ec6c6948a..4f6210211995 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/example.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/c/example.c @@ -31,11 +31,10 @@ int main( void ) { // Specify strides: const int strideX = 1; - const int strideOut1 = 2; - const int strideOut2 = 1; + const int LDO = 2; // Compute the Cartesian square: - stdlib_strided_dcartesian_square( N, x, strideX, out, strideOut1, strideOut2 ); + stdlib_strided_dcartesian_square( N, x, strideX, out, LDO ); // Print the result: for ( int i = 0; i < N*N; i++ ) { diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/index.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/index.js index 03dd16115873..bf55ec6f2cfe 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/examples/index.js @@ -29,5 +29,5 @@ var x = discreteUniform( N, 1, 10, { console.log( x ); var out = new Float64Array( N * N * 2 ); -dcartesianSquare( N, x, 1, out, 2, 1 ); +dcartesianSquare( N, x, 1, out, 2 ); console.log( out ); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/include/stdlib/blas/ext/base/dcartesiansquare.h b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/include/stdlib/blas/ext/base/dcartesiansquare.h index b77da6afc922..4ec5ad0e260c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/include/stdlib/blas/ext/base/dcartesiansquare.h +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/include/stdlib/blas/ext/base/dcartesiansquare.h @@ -31,7 +31,7 @@ extern "C" { /** * Computes the Cartesian square for a double-precision floating-point strided array. */ -void API_SUFFIX(stdlib_strided_dcartesian_square)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT strideOut1, const CBLAS_INT strideOut2 ); +void API_SUFFIX(stdlib_strided_dcartesian_square)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT LDO ); /** * Computes the Cartesian square for a double-precision floating-point strided array using alternative indexing semantics. diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.js index 1be665334851..c0dea154f4db 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.js @@ -33,8 +33,7 @@ var ndarray = require( './ndarray.js' ); * @param {Float64Array} x - input array * @param {integer} strideX - stride length * @param {Float64Array} out - output array -* @param {integer} strideOut1 - stride length between consecutive output pairs -* @param {integer} strideOut2 - stride length between elements of each output pair +* @param {integer} LDO - stride of the leading dimension of `out` * @returns {Float64Array} output array * * @example @@ -43,13 +42,13 @@ var ndarray = require( './ndarray.js' ); * var x = new Float64Array( [ 1.0, 2.0 ] ); * var out = new Float64Array( 8 ); * -* dcartesianSquare( x.length, x, 1, out, 2, 1 ); +* dcartesianSquare( x.length, x, 1, out, 2 ); * // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] */ -function dcartesianSquare( N, x, strideX, out, strideOut1, strideOut2 ) { +function dcartesianSquare( N, x, strideX, out, LDO ) { var ox = stride2offset( N, strideX ); - var oo = stride2offset( N * N, strideOut1 ) + stride2offset( 2, strideOut2 ); // eslint-disable-line max-len - return ndarray( N, x, strideX, ox, out, strideOut1, strideOut2, oo ); + var oo = stride2offset( N * N, LDO ); + return ndarray( N, x, strideX, ox, out, LDO, 1, oo ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js index d6647f54f192..2de27950c08c 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js @@ -32,8 +32,7 @@ var addon = require( './../src/addon.node' ); * @param {Float64Array} x - input array * @param {integer} strideX - stride length * @param {Float64Array} out - output array -* @param {integer} strideOut1 - stride length between consecutive output pairs -* @param {integer} strideOut2 - stride length between elements of each output pair +* @param {integer} LDO - stride of the leading dimension of `out` * @returns {Float64Array} output array * * @example @@ -42,11 +41,11 @@ var addon = require( './../src/addon.node' ); * var x = new Float64Array( [ 1.0, 2.0 ] ); * var out = new Float64Array( 8 ); * -* dcartesianSquare( x.length, x, 1, out, 2, 1 ); +* dcartesianSquare( x.length, x, 1, out, 2 ); * // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] */ -function dcartesianSquare( N, x, strideX, out, strideOut1, strideOut2 ) { - addon( N, x, strideX, out, strideOut1, strideOut2 ); +function dcartesianSquare( N, x, strideX, out, LDO ) { + addon( N, x, strideX, out, LDO ); return out; } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/index.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/index.js index daf3d08371cf..bb09a4da21ae 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/index.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/index.js @@ -30,7 +30,7 @@ * var x = new Float64Array( [ 1.0, 2.0 ] ); * var out = new Float64Array( 8 ); * -* dcartesianSquare( x.length, x, 1, out, 2, 1 ); +* dcartesianSquare( x.length, x, 1, out, 2 ); * // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js index cf55ec69213d..20d1781f0c1e 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js @@ -18,18 +18,23 @@ 'use strict'; +// MODULES // + +var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major' ); + + // MAIN // /** -* Computes the Cartesian square for a double-precision floating-point strided array using alternative indeixng semantics. +* Computes the Cartesian square for a double-precision floating-point strided array using alternative indexing semantics. * * @param {NonNegativeInteger} N - number of indexed elements * @param {Float64Array} x - input array * @param {integer} strideX - stride length * @param {NonNegativeInteger} offsetX - starting index * @param {Float64Array} out - output array -* @param {integer} strideOut1 - stride length between consecutive output pairs -* @param {integer} strideOut2 - stride length between elements of each output pair +* @param {integer} strideOut1 - stride length of the first dimension of `out` +* @param {integer} strideOut2 - stride length of the second dimension of `out` * @param {NonNegativeInteger} offsetOut - starting index * @returns {Float64Array} output array * @@ -53,18 +58,40 @@ function dcartesianSquare( N, x, strideX, offsetX, out, strideOut1, strideOut2, if ( N <= 0 ) { return out; } - ix = offsetX; - io = offsetOut; - for ( i = 0; i < N; i++ ) { - v = x[ ix ]; - jx = offsetX; - for ( j = 0; j < N; j++ ) { - out[ io ] = v; - out[ io + strideOut2 ] = x[ jx ]; - io += strideOut1; - jx += strideX; + if ( isRowMajor( [ strideOut1, strideOut2 ] ) ) { + ix = offsetX; + io = offsetOut; + for ( i = 0; i < N; i++ ) { + v = x[ ix ]; + jx = offsetX; + for ( j = 0; j < N; j++ ) { + out[ io ] = v; + out[ io + strideOut2 ] = x[ jx ]; + io += strideOut1; + jx += strideX; + } + ix += strideX; + } + } else { + ix = offsetX; + io = offsetOut; + for ( i = 0; i < N; i++ ) { + v = x[ ix ]; + for ( j = 0; j < N; j++ ) { + out[ io ] = v; + io += strideOut1; + } + ix += strideX; + } + io = offsetOut + strideOut2; + for ( i = 0; i < N; i++ ) { + jx = offsetX; + for ( j = 0; j < N; j++ ) { + out[ io ] = x[ jx ]; + io += strideOut1; + jx += strideX; + } } - ix += strideX; } return out; } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js index cb6db36b82d6..18714124a160 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js @@ -33,8 +33,8 @@ var addon = require( './../src/addon.node' ); * @param {integer} strideX - stride length * @param {NonNegativeInteger} offsetX - starting index * @param {Float64Array} out - output array -* @param {integer} strideOut1 - stride length between consecutive output pairs -* @param {integer} strideOut2 - stride length between elements of each output pair +* @param {integer} strideOut1 - stride length of the first dimension of `out` +* @param {integer} strideOut2 - stride length of the second dimension of `out` * @param {NonNegativeInteger} offsetOut - starting index * @returns {Float64Array} output array * diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/manifest.json b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/manifest.json index 4e02a05fb7d8..5aef73f95ea5 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/manifest.json +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/manifest.json @@ -37,6 +37,7 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", + "@stdlib/ndarray/base/assert/is-row-major", "@stdlib/strided/base/stride2offset", "@stdlib/napi/export", "@stdlib/napi/argv", @@ -57,6 +58,7 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", + "@stdlib/ndarray/base/assert/is-row-major", "@stdlib/strided/base/stride2offset" ] }, @@ -72,6 +74,7 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", + "@stdlib/ndarray/base/assert/is-row-major", "@stdlib/strided/base/stride2offset" ] } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/addon.c b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/addon.c index 1fa1855524f7..b14286412065 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/addon.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/addon.c @@ -33,14 +33,13 @@ * @return Node-API value */ static napi_value addon( napi_env env, napi_callback_info info ) { - STDLIB_NAPI_ARGV( env, info, argv, argc, 6 ); + STDLIB_NAPI_ARGV( env, info, argv, argc, 5 ); STDLIB_NAPI_ARGV_INT64( env, N, argv, 0 ); STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 2 ); - STDLIB_NAPI_ARGV_INT64( env, strideOut1, argv, 4 ); - STDLIB_NAPI_ARGV_INT64( env, strideOut2, argv, 5 ); + STDLIB_NAPI_ARGV_INT64( env, LDO, argv, 4 ); STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, N, strideX, argv, 1 ); - STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY2D( env, Out, N*N, 2, strideOut1, strideOut2, argv, 3 ); - API_SUFFIX(stdlib_strided_dcartesian_square)( N, X, strideX, Out, strideOut1, strideOut2 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY2D( env, Out, N*N, 2, LDO, 1, argv, 3 ); + API_SUFFIX(stdlib_strided_dcartesian_square)( N, X, strideX, Out, LDO ); return NULL; } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c index 52a958b99077..d633e34b8a85 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c @@ -17,38 +17,40 @@ */ #include "stdlib/blas/ext/base/dcartesiansquare.h" +#include "stdlib/ndarray/base/assert/is_row_major.h" #include "stdlib/blas/base/shared.h" #include "stdlib/strided/base/stride2offset.h" /** * Computes the Cartesian square for a double-precision floating-point strided array. * -* @param N number of indexed elements -* @param X input array -* @param strideX stride length -* @param Out output array -* @param strideOut1 stride length between consecutive output pairs -* @param strideOut2 stride length between elements of each output pair +* @param N number of indexed elements +* @param X input array +* @param strideX stride length +* @param Out output array +* @param LDO stride of the leading dimension of Out */ -void API_SUFFIX(stdlib_strided_dcartesian_square)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT strideOut1, const CBLAS_INT strideOut2 ) { +void API_SUFFIX(stdlib_strided_dcartesian_square)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT LDO ) { CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); - CBLAS_INT oo = stdlib_strided_stride2offset( N*N, strideOut1 ) + stdlib_strided_stride2offset( 2, strideOut2 ); - API_SUFFIX(stdlib_strided_dcartesian_square_ndarray)( N, X, strideX, ox, Out, strideOut1, strideOut2, oo ); + CBLAS_INT oo = stdlib_strided_stride2offset( N*N, LDO ); + API_SUFFIX(stdlib_strided_dcartesian_square_ndarray)( N, X, strideX, ox, Out, LDO, 1, oo ); } /** -* Computes the Cartesian square for a double-precision floating-point strided array using alternative indeixng semantics. +* Computes the Cartesian square for a double-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 * @param Out output array -* @param strideOut1 stride length between consecutive output pairs -* @param strideOut2 stride length between elements of each output pair +* @param strideOut1 stride length of the first dimension of Out +* @param strideOut2 stride length of the second dimension of Out * @param offsetOut starting index */ void API_SUFFIX(stdlib_strided_dcartesian_square_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *Out, const CBLAS_INT strideOut1, const CBLAS_INT strideOut2, const CBLAS_INT offsetOut ) { + int64_t sa[ 2 ]; + CBLAS_INT isrm; CBLAS_INT ix; CBLAS_INT jx; CBLAS_INT io; @@ -59,17 +61,43 @@ void API_SUFFIX(stdlib_strided_dcartesian_square_ndarray)( const CBLAS_INT N, co if ( N <= 0 ) { return; } - ix = offsetX; - io = offsetOut; - for ( i = 0; i < N; i++ ) { - v = X[ ix ]; - jx = offsetX; - for ( j = 0; j < N; j++ ) { - Out[ io ] = v; - Out[ io + strideOut2 ] = X[ jx ]; - io += strideOut1; - jx += strideX; + sa[ 0 ] = strideOut1; + sa[ 1 ] = strideOut2; + isrm = stdlib_ndarray_is_row_major( 2, sa ); + if ( isrm ) { + ix = offsetX; + io = offsetOut; + for ( i = 0; i < N; i++ ) { + v = X[ ix ]; + jx = offsetX; + for ( j = 0; j < N; j++ ) { + Out[ io ] = v; + Out[ io + strideOut2 ] = X[ jx ]; + io += strideOut1; + jx += strideX; + } + ix += strideX; + } + } else { // isColMajor + ix = offsetX; + io = offsetOut; + for ( i = 0; i < N; i++ ) { + v = X[ ix ]; + for ( j = 0; j < N; j++ ) { + Out[ io ] = v; + io += strideOut1; + } + ix += strideX; + } + io = offsetOut + strideOut2; + for ( i = 0; i < N; i++ ) { + jx = offsetX; + for ( j = 0; j < N; j++ ) { + Out[ io ] = X[ jx ]; + io += strideOut1; + jx += strideX; + } } - ix += strideX; } + return; } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.js index 57812fd6ee8e..e3b478eeede1 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.js @@ -33,8 +33,8 @@ tape( 'main export is a function', function test( t ) { t.end(); }); -tape( 'the function has an arity of 6', function test( t ) { - t.strictEqual( dcartesianSquare.length, 6, 'has expected arity' ); +tape( 'the function has an arity of 5', function test( t ) { + t.strictEqual( dcartesianSquare.length, 5, 'has expected arity' ); t.end(); }); @@ -47,7 +47,7 @@ tape( 'the function computes the Cartesian square', function test( t ) { out = new Float64Array( 8 ); expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); - dcartesianSquare( x.length, x, 1, out, 2, 1 ); + dcartesianSquare( x.length, x, 1, out, 2 ); t.deepEqual( out, expected, 'returns expected value' ); x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); @@ -73,14 +73,14 @@ tape( 'the function computes the Cartesian square', function test( t ) { 3.0 ]); - dcartesianSquare( x.length, x, 1, out, 2, 1 ); + dcartesianSquare( x.length, x, 1, out, 2 ); t.deepEqual( out, expected, 'returns expected value' ); x = new Float64Array( [ 5.0 ] ); out = new Float64Array( 2 ); expected = new Float64Array( [ 5.0, 5.0 ] ); - dcartesianSquare( 1, x, 1, out, 2, 1 ); + dcartesianSquare( 1, x, 1, out, 2 ); t.deepEqual( out, expected, 'returns expected value' ); t.end(); @@ -93,7 +93,7 @@ tape( 'the function returns a reference to the output array', function test( t ) x = new Float64Array( [ 1.0, 2.0 ] ); out = new Float64Array( 8 ); - y = dcartesianSquare( x.length, x, 1, out, 2, 1 ); + y = dcartesianSquare( x.length, x, 1, out, 2 ); t.strictEqual( y, out, 'same reference' ); t.end(); @@ -108,7 +108,7 @@ tape( 'if provided an `N` parameter equal to `0`, the function returns the outpu out = new Float64Array( [ 3.0, 4.0, 5.0, 6.0 ] ); expected = new Float64Array( [ 3.0, 4.0, 5.0, 6.0 ] ); - dcartesianSquare( 0, x, 1, out, 2, 1 ); + dcartesianSquare( 0, x, 1, out, 2 ); t.deepEqual( out, expected, 'returns expected value' ); t.end(); @@ -128,7 +128,7 @@ tape( 'the function supports specifying a stride for `x`', function test( t ) { out = new Float64Array( 8 ); expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); - dcartesianSquare( 2, x, 2, out, 2, 1 ); + dcartesianSquare( 2, x, 2, out, 2 ); t.deepEqual( out, expected, 'returns expected value' ); t.end(); @@ -146,13 +146,13 @@ tape( 'the function supports specifying a negative stride for `x`', function tes out = new Float64Array( 8 ); expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); - dcartesianSquare( 2, x, -1, out, 2, 1 ); + dcartesianSquare( 2, x, -1, out, 2 ); t.deepEqual( out, expected, 'returns expected value' ); t.end(); }); -tape( 'the function supports specifying a stride for the output pairs', function test( t ) { +tape( 'the function supports specifying a leading dimension stride for the output array', function test( t ) { var expected; var out; var x; @@ -178,13 +178,13 @@ tape( 'the function supports specifying a stride for the output pairs', function 0.0 ]); - dcartesianSquare( 2, x, 1, out, 4, 1 ); + dcartesianSquare( 2, x, 1, out, 4 ); t.deepEqual( out, expected, 'returns expected value' ); t.end(); }); -tape( 'the function supports specifying a negative stride for the output pairs', function test( t ) { +tape( 'the function supports specifying a negative leading dimension stride for the output array', function test( t ) { var expected; var out; var x; @@ -193,22 +193,7 @@ tape( 'the function supports specifying a negative stride for the output pairs', out = new Float64Array( 8 ); expected = new Float64Array( [ 2.0, 2.0, 2.0, 1.0, 1.0, 2.0, 1.0, 1.0 ] ); - dcartesianSquare( 2, x, 1, out, -2, 1 ); - t.deepEqual( out, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying a negative stride for the output pair elements', function test( t ) { - var expected; - var out; - var x; - - x = new Float64Array( [ 1.0, 2.0 ] ); - out = new Float64Array( 8 ); - expected = new Float64Array( [ 1.0, 1.0, 2.0, 1.0, 1.0, 2.0, 2.0, 2.0 ] ); - - dcartesianSquare( 2, x, 1, out, 2, -1 ); + dcartesianSquare( 2, x, 1, out, -2 ); t.deepEqual( out, expected, 'returns expected value' ); t.end(); @@ -226,7 +211,7 @@ tape( 'the function supports view offsets', function test( t ) { out = new Float64Array( 8 ); expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); - dcartesianSquare( 2, x1, 1, out, 2, 1 ); + dcartesianSquare( 2, x1, 1, out, 2 ); t.deepEqual( out, expected, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.native.js index b1eb37dcc5d3..d06f0f272595 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.dcartesiansquare.native.js @@ -42,8 +42,8 @@ tape( 'main export is a function', opts, function test( t ) { t.end(); }); -tape( 'the function has an arity of 6', opts, function test( t ) { - t.strictEqual( dcartesianSquare.length, 6, 'has expected arity' ); +tape( 'the function has an arity of 5', opts, function test( t ) { + t.strictEqual( dcartesianSquare.length, 5, 'has expected arity' ); t.end(); }); @@ -56,7 +56,7 @@ tape( 'the function computes the Cartesian square', opts, function test( t ) { out = new Float64Array( 8 ); expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); - dcartesianSquare( x.length, x, 1, out, 2, 1 ); + dcartesianSquare( x.length, x, 1, out, 2 ); t.deepEqual( out, expected, 'returns expected value' ); x = new Float64Array( [ 1.0, 2.0, 3.0 ] ); @@ -82,14 +82,14 @@ tape( 'the function computes the Cartesian square', opts, function test( t ) { 3.0 ]); - dcartesianSquare( x.length, x, 1, out, 2, 1 ); + dcartesianSquare( x.length, x, 1, out, 2 ); t.deepEqual( out, expected, 'returns expected value' ); x = new Float64Array( [ 5.0 ] ); out = new Float64Array( 2 ); expected = new Float64Array( [ 5.0, 5.0 ] ); - dcartesianSquare( 1, x, 1, out, 2, 1 ); + dcartesianSquare( 1, x, 1, out, 2 ); t.deepEqual( out, expected, 'returns expected value' ); t.end(); @@ -102,7 +102,7 @@ tape( 'the function returns a reference to the output array', opts, function tes x = new Float64Array( [ 1.0, 2.0 ] ); out = new Float64Array( 8 ); - y = dcartesianSquare( x.length, x, 1, out, 2, 1 ); + y = dcartesianSquare( x.length, x, 1, out, 2 ); t.strictEqual( y, out, 'same reference' ); t.end(); @@ -117,7 +117,7 @@ tape( 'if provided an `N` parameter equal to `0`, the function returns the outpu out = new Float64Array( [ 3.0, 4.0, 5.0, 6.0 ] ); expected = new Float64Array( [ 3.0, 4.0, 5.0, 6.0 ] ); - dcartesianSquare( 0, x, 1, out, 2, 1 ); + dcartesianSquare( 0, x, 1, out, 2 ); t.deepEqual( out, expected, 'returns expected value' ); t.end(); @@ -137,7 +137,7 @@ tape( 'the function supports specifying a stride for `x`', opts, function test( out = new Float64Array( 8 ); expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); - dcartesianSquare( 2, x, 2, out, 2, 1 ); + dcartesianSquare( 2, x, 2, out, 2 ); t.deepEqual( out, expected, 'returns expected value' ); t.end(); @@ -155,7 +155,54 @@ tape( 'the function supports specifying a negative stride for `x`', opts, functi out = new Float64Array( 8 ); expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); - dcartesianSquare( 2, x, -1, out, 2, 1 ); + dcartesianSquare( 2, x, -1, out, 2 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a leading dimension stride for the output array', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 16 ); + expected = new Float64Array([ + 1.0, + 1.0, + 0.0, + 0.0, + 1.0, + 2.0, + 0.0, + 0.0, + 2.0, + 1.0, + 0.0, + 0.0, + 2.0, + 2.0, + 0.0, + 0.0 + ]); + + dcartesianSquare( 2, x, 1, out, 4 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a negative leading dimension stride for the output array', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 2.0, 2.0, 2.0, 1.0, 1.0, 2.0, 1.0, 1.0 ] ); + + dcartesianSquare( 2, x, 1, out, -2 ); t.deepEqual( out, expected, 'returns expected value' ); t.end(); @@ -173,7 +220,7 @@ tape( 'the function supports view offsets', opts, function test( t ) { out = new Float64Array( 8 ); expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); - dcartesianSquare( 2, x1, 1, out, 2, 1 ); + dcartesianSquare( 2, x1, 1, out, 2 ); t.deepEqual( out, expected, 'returns expected value' ); t.end(); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.js index 778a2f7abaf1..476ee48d8903 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.js @@ -254,3 +254,18 @@ tape( 'the function supports an `offsetOut` parameter', function test( t ) { t.end(); }); + +tape( 'the function supports a column-major output layout', function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 1.0, 2.0 ] ); + + dcartesianSquare( 2, x, 1, 0, out, 1, 4, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.native.js index af93542198a5..0e089eda61ed 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/test/test.ndarray.native.js @@ -143,6 +143,86 @@ tape( 'the function supports specifying a stride for `x`', opts, function test( t.end(); }); +tape( 'the function supports specifying a negative stride for `x`', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array([ + 2.0, // 1 + 1.0 // 0 + ]); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] ); + + dcartesianSquare( 2, x, -1, 1, out, 2, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a stride for the output pairs', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 16 ); + expected = new Float64Array([ + 1.0, + 1.0, + 0.0, + 0.0, + 1.0, + 2.0, + 0.0, + 0.0, + 2.0, + 1.0, + 0.0, + 0.0, + 2.0, + 2.0, + 0.0, + 0.0 + ]); + + dcartesianSquare( 2, x, 1, 0, out, 4, 1, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a negative stride for the output pairs', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 2.0, 2.0, 2.0, 1.0, 1.0, 2.0, 1.0, 1.0 ] ); + + dcartesianSquare( 2, x, 1, 0, out, -2, 1, 6 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'the function supports specifying a negative stride for the output pair elements', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 2.0, 1.0, 1.0, 2.0, 2.0, 2.0 ] ); + + dcartesianSquare( 2, x, 1, 0, out, 2, -1, 1 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + tape( 'the function supports an `offsetX` parameter', opts, function test( t ) { var expected; var out; @@ -183,3 +263,18 @@ tape( 'the function supports an `offsetOut` parameter', opts, function test( t ) t.end(); }); + +tape( 'the function supports a column-major output layout', opts, function test( t ) { + var expected; + var out; + var x; + + x = new Float64Array( [ 1.0, 2.0 ] ); + out = new Float64Array( 8 ); + expected = new Float64Array( [ 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 1.0, 2.0 ] ); + + dcartesianSquare( 2, x, 1, 0, out, 1, 4, 0 ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); From 76228dd43a2ddc28d29d4ee4d1372d7178df959c Mon Sep 17 00:00:00 2001 From: headlessNode Date: Tue, 10 Mar 2026 02:03:40 +0500 Subject: [PATCH 5/5] fix: apply suggestions from code review --- 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: passed - task: lint_javascript_src status: passed - 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: missing_dependencies - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- .../blas/ext/base/dcartesian-square/README.md | 2 +- .../blas/ext/base/dcartesian-square/docs/repl.txt | 14 +++++++------- .../base/dcartesian-square/docs/types/index.d.ts | 14 +++++++------- .../base/dcartesian-square/lib/dcartesiansquare.js | 11 +++++++---- .../lib/dcartesiansquare.native.js | 4 ++-- .../blas/ext/base/dcartesian-square/lib/ndarray.js | 10 +++++----- .../base/dcartesian-square/lib/ndarray.native.js | 10 +++++----- .../blas/ext/base/dcartesian-square/src/main.c | 14 +++++++------- 8 files changed, 41 insertions(+), 38 deletions(-) diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md index 924456994605..d7c054e499e5 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/README.md @@ -124,7 +124,7 @@ dcartesianSquare.ndarray( 2, x, 1, 2, out, 2, 1, 0 ); ## Notes -- For an input array `x` of length `N`, the output array `out` must contain at least `N^2` pairs. +- For an input array `x` of length `N`, the output array `out` must contain at least `N^2 * 2` elements. - If `N <= 0`, both functions return `out` unchanged. diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/repl.txt b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/repl.txt index b38633afc99c..79c11bed5984 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/repl.txt +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/repl.txt @@ -17,13 +17,13 @@ Input array. strideX: integer - Stride length. + Stride length for `x`. out: Float64Array Output array. LDO: integer - Stride of the leading dimension of `out`. + Stride length for the leading dimension of `out`. Returns ------- @@ -69,22 +69,22 @@ Input array. strideX: integer - Stride length. + Stride length for `x`. offsetX: integer - Starting index. + Starting index for `x`. out: Float64Array Output array. strideOut1: integer - Stride length of the first dimension of `out`. + Stride length for the first dimension of `out`. strideOut2: integer - Stride length of the second dimension of `out`. + Stride length for the second dimension of `out`. offsetOut: integer - Starting index. + Starting index for `out`. Returns ------- diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts index 039c002199f4..ec66dc0d27d9 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/docs/types/index.d.ts @@ -27,9 +27,9 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array - * @param strideX - stride length + * @param strideX - stride length for `x` * @param out - output array - * @param LDO - stride of the leading dimension of `out` + * @param LDO - stride length for the leading dimension of `out` * @returns output array * * @example @@ -48,12 +48,12 @@ interface Routine { * * @param N - number of indexed elements * @param x - input array - * @param strideX - stride length - * @param offsetX - starting index + * @param strideX - stride length for `x` + * @param offsetX - starting index for `x` * @param out - output array - * @param strideOut1 - stride length of the first dimension of `out` - * @param strideOut2 - stride length of the second dimension of `out` - * @param offsetOut - starting index + * @param strideOut1 - stride length for the first dimension of `out` + * @param strideOut2 - stride length for the second dimension of `out` + * @param offsetOut - starting index for `out` * @returns output array * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.js index c0dea154f4db..aa1889c51547 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.js @@ -31,9 +31,9 @@ var ndarray = require( './ndarray.js' ); * * @param {NonNegativeInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} strideX - stride length +* @param {integer} strideX - stride length for `x` * @param {Float64Array} out - output array -* @param {integer} LDO - stride of the leading dimension of `out` +* @param {integer} LDO - stride length for the leading dimension of `out` * @returns {Float64Array} output array * * @example @@ -46,8 +46,11 @@ var ndarray = require( './ndarray.js' ); * // out => [ 1.0, 1.0, 1.0, 2.0, 2.0, 1.0, 2.0, 2.0 ] */ function dcartesianSquare( N, x, strideX, out, LDO ) { - var ox = stride2offset( N, strideX ); - var oo = stride2offset( N * N, LDO ); + var ox; + var oo; + + ox = stride2offset( N, strideX ); + oo = stride2offset( N * N, LDO ); return ndarray( N, x, strideX, ox, out, LDO, 1, oo ); } diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js index 2de27950c08c..1cc0c8d96381 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/dcartesiansquare.native.js @@ -30,9 +30,9 @@ var addon = require( './../src/addon.node' ); * * @param {NonNegativeInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} strideX - stride length +* @param {integer} strideX - stride length for `x` * @param {Float64Array} out - output array -* @param {integer} LDO - stride of the leading dimension of `out` +* @param {integer} LDO - stride length for the leading dimension of `out` * @returns {Float64Array} output array * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js index 20d1781f0c1e..7d432754e6be 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.js @@ -30,12 +30,12 @@ var isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major' ); * * @param {NonNegativeInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} strideX - stride length -* @param {NonNegativeInteger} offsetX - starting index +* @param {integer} strideX - stride length for `x` +* @param {NonNegativeInteger} offsetX - starting index for `x` * @param {Float64Array} out - output array -* @param {integer} strideOut1 - stride length of the first dimension of `out` -* @param {integer} strideOut2 - stride length of the second dimension of `out` -* @param {NonNegativeInteger} offsetOut - starting index +* @param {integer} strideOut1 - stride length for the first dimension of `out` +* @param {integer} strideOut2 - stride length for the second dimension of `out` +* @param {NonNegativeInteger} offsetOut - starting index for `out` * @returns {Float64Array} output array * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js index 18714124a160..27bc641e2898 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/lib/ndarray.native.js @@ -30,12 +30,12 @@ var addon = require( './../src/addon.node' ); * * @param {NonNegativeInteger} N - number of indexed elements * @param {Float64Array} x - input array -* @param {integer} strideX - stride length -* @param {NonNegativeInteger} offsetX - starting index +* @param {integer} strideX - stride length for `x` +* @param {NonNegativeInteger} offsetX - starting index for `x` * @param {Float64Array} out - output array -* @param {integer} strideOut1 - stride length of the first dimension of `out` -* @param {integer} strideOut2 - stride length of the second dimension of `out` -* @param {NonNegativeInteger} offsetOut - starting index +* @param {integer} strideOut1 - stride length for the first dimension of `out` +* @param {integer} strideOut2 - stride length for the second dimension of `out` +* @param {NonNegativeInteger} offsetOut - starting index for `out` * @returns {Float64Array} output array * * @example diff --git a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c index d633e34b8a85..3ad55a3722ef 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c +++ b/lib/node_modules/@stdlib/blas/ext/base/dcartesian-square/src/main.c @@ -26,9 +26,9 @@ * * @param N number of indexed elements * @param X input array -* @param strideX stride length +* @param strideX stride length for X * @param Out output array -* @param LDO stride of the leading dimension of Out +* @param LDO stride length for the leading dimension of Out */ void API_SUFFIX(stdlib_strided_dcartesian_square)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, double *Out, const CBLAS_INT LDO ) { CBLAS_INT ox = stdlib_strided_stride2offset( N, strideX ); @@ -41,12 +41,12 @@ void API_SUFFIX(stdlib_strided_dcartesian_square)( const CBLAS_INT N, const doub * * @param N number of indexed elements * @param X input array -* @param strideX stride length -* @param offsetX starting index +* @param strideX stride length for X +* @param offsetX starting index for X * @param Out output array -* @param strideOut1 stride length of the first dimension of Out -* @param strideOut2 stride length of the second dimension of Out -* @param offsetOut starting index +* @param strideOut1 stride length for the first dimension of Out +* @param strideOut2 stride length for the second dimension of Out +* @param offsetOut starting index for Out */ void API_SUFFIX(stdlib_strided_dcartesian_square_ndarray)( const CBLAS_INT N, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, double *Out, const CBLAS_INT strideOut1, const CBLAS_INT strideOut2, const CBLAS_INT offsetOut ) { int64_t sa[ 2 ];