diff --git a/lib/node_modules/@stdlib/blas/base/dger/README.md b/lib/node_modules/@stdlib/blas/base/dger/README.md index 679b9ef2fb63..e0522f430713 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/README.md +++ b/lib/node_modules/@stdlib/blas/base/dger/README.md @@ -20,12 +20,10 @@ limitations under the License. # dger -> TODO. +> Perform the rank 1 operation `A = α*x*y^T + A`.
-TODO -
@@ -38,15 +36,102 @@ TODO var dger = require( '@stdlib/blas/base/dger' ); ``` -#### TODO +#### dger( ord, M, N, α, x, sx, y, sy, A, lda ) + +Performs the rank 1 operation `A = α*x*y^T + A`, where `α` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by `N` matrix. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var x = new Float64Array( [ 1.0, 1.0 ] ); +var y = new Float64Array( [ 1.0, 1.0, 1.0 ] ); + +dger( 'row-major', 2, 3, 1.0, x, 1, y, 1, A, 3 ); +// A => [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] +``` + +The function has the following parameters: + +- **ord**: storage layout. +- **M**: number of rows in the matrix `A`. +- **N**: number of columns in the matrix `A`. +- **α**: scalar constant. +- **x**: input [`Float64Array`][mdn-float64array]. +- **sx**: stride length for `x`. +- **y**: output [`Float64Array`][mdn-float64array]. +- **sy**: stride length for `y`. +- **A**: input matrix stored in linear memory as a [`Float64Array`][mdn-float64array]. +- **lda**: stride of the first dimension of `A` (leading dimension of `A`). + +The stride parameters determine which elements in the strided arrays are accessed at runtime. For example, to iterate over every other element in `x` and `y`, + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var A = new Float64Array( [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] ); +var x = new Float64Array( [ 1.0, 0.0, 1.0, 0.0 ] ); +var y = new Float64Array( [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ); + +dger( 'column-major', 2, 3, 1.0, x, 2, y, 2, A, 2 ); +// A => [ 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] +``` + +Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views. -TODO + ```javascript -/* to-do */ +var Float64Array = require( '@stdlib/array/float64' ); + +// Initial arrays... +var x0 = new Float64Array( [ 0.0, 1.0, 1.0 ] ); +var y0 = new Float64Array( [ 0.0, 1.0, 1.0, 1.0 ] ); +var A = new Float64Array( [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] ); + +// Create offset views... +var x1 = new Float64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element +var y1 = new Float64Array( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); // start at 2nd element + +dger( 'column-major', 2, 3, 1.0, x1, -1, y1, -1, A, 2 ); +// A => [ 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] ``` -TODO +#### dger.ndarray( M, N, α, x, sx, ox, y, sy, oy, A, sa1, sa2, oa ) + +Performs the rank 1 operation `A = α*x*y^T + A`, using alternative indexing semantics and where `α` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by `N` matrix. + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +var x = new Float64Array( [ 1.0, 1.0 ] ); +var y = new Float64Array( [ 1.0, 1.0, 1.0 ] ); + +dger.ndarray( 2, 3, 1.0, x, 1, 0, y, 1, 0, A, 3, 1, 0 ); +// A => [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] +``` + +The function has the following additional parameters: + +- **sa1**: stride of the first dimension of `A`. +- **sa2**: stride of the second dimension of `A`. +- **oa**: starting index for `A`. +- **ox**: starting index for `x`. +- **oy**: starting index for `y`. + +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, + +```javascript +var Float64Array = require( '@stdlib/array/float64' ); + +var A = new Float64Array( [ 0.0, 0.0, 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] ); +var x = new Float64Array( [ 0.0, 1.0, 0.0, 1.0, 0.0 ] ); +var y = new Float64Array( [ 0.0, 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] ); + +dger.ndarray( 2, 3, 1.0, x, 2, 1, y, 2, 1, A, 1, 2, 2 ); +// A => [ 0.0, 0.0, 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] +``` @@ -56,7 +141,7 @@ TODO ## Notes -- `dger()` corresponds to the [BLAS][blas] level 2 function [`dger`][dger]. +- `dger()` corresponds to the [BLAS][blas] level 2 function [`dger`][blas-dger]. @@ -69,7 +154,26 @@ TODO ```javascript -/* to-do */ +var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); +var dger = require( '@stdlib/blas/base/dger' ); + +var opts = { + 'dtype': 'float64' +}; + +var M = 3; +var N = 5; + +var A = discreteUniform( M*N, 0, 255, opts ); +var x = discreteUniform( M, 0, 255, opts ); +var y = discreteUniform( N, 0, 255, opts ); + +dger( 'row-major', M, N, 1.0, x, 1, y, 1, A, N ); +console.log( A ); + +dger.ndarray( M, N, 1.0, x, 1, 0, y, 1, 0, A, 1, M, 0 ); +console.log(A); + ``` @@ -102,18 +206,80 @@ TODO #include "stdlib/blas/base/dger.h" ``` -#### TODO +#### c_dger( layout, M, N, alpha, \*X, strideX, \*Y, strideY, \*A, LDA ) -TODO. +Performs the rank 1 operation `A = alpha*x*y^T + A`, where `alpha` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M`-by-`N` matrix. ```c -TODO +#include "stdlib/blas/base/shared.h" + +double A[ 3*4 ] = { + 0.0, 0.0, 0.0, 0.0, + 0.0, 0.0, 0.0, 0.0, + 0.0, 0.0, 0.0, 0.0 +}; + +const double x[ 3 ] = { 1.0, 4.0, 0.0 }; +const double y[ 4 ] = { 0.0, 1.0, 2.0, 3.0 }; + +c_dger( CblasRowMajor, 3, 4, 1.0, x, 1, y, 1, A, 4 ); ``` -TODO +The function accepts the following arguments: + +- **layout**: `[in] CBLAS_LAYOUT` storage layout. +- **M**: `[in] CBLAS_INT` number of rows in the matrix `A`. +- **N**: `[in] CBLAS_INT` number of columns in the matrix `A`. +- **alpha**: `[in] double` scalar constant. +- **X**: `[in] double*` an `M` element vector. +- **strideX**: `[in] CBLAS_INT` stride length for `X`. +- **Y**: `[in] double*` an `N` element vector. +- **strideY**: `[in] CBLAS_INT` stride length for `Y`. +- **A**: `[inout] double*` input matrix. +- **LDA**: `[in] CBLAS_INT` stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`). ```c -TODO +void c_dger( const CBLAS_LAYOUT layout, const CBLAS_INT M, const CBLAS_INT N, const double alpha, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY, double *A, const CBLAS_INT LDA ); +``` + +#### c_dger_ndarray( M, N, alpha, \*X, sx, ox, \*Y, sy, oy, \*A, sa1, sa2, oa ) + +Performs the rank 1 operation `A = alpha*x*y^T + A`, using alternative indexing semantics and where `alpha` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M`-by-`N` matrix. + +```c +#include "stdlib/blas/base/shared.h" + +double A[ 3*4 ] = { + 0.0, 0.0, 0.0, 0.0, + 0.0, 0.0, 0.0, 0.0, + 0.0, 0.0, 0.0, 0.0 +}; + +const double x[ 3 ] = { 1.0, 4.0, 0.0 }; +const double y[ 4 ] = { 0.0, 1.0, 2.0, 3.0 }; + +c_dger_ndarray( 3, 4, 1.0, x, 1, 0, y, 1, 0, A, 4, 1, 0 ); +``` + +The function accepts the following arguments: + +- **layout**: `[in] CBLAS_LAYOUT` storage layout. +- **M**: `[in] CBLAS_INT` number of rows in the matrix `A`. +- **N**: `[in] CBLAS_INT` number of columns in the matrix `A`. +- **alpha**: `[in] double` scalar constant. +- **X**: `[in] double*` an `M` element vector. +- **sx**: `[in] CBLAS_INT` stride length for `X`. +- **ox**: `[in] CBLAS_INT` starting index for `X`. +- **Y**: `[in] double*` an `N` element vector. +- **sy**: `[in] CBLAS_INT` stride length for `Y`. +- **oy**: `[in] CBLAS_INT` starting index for `Y`. +- **A**: `[inout] double*` input matrix. +- **sa1**: `[in] CBLAS_INT` stride of the first dimension of `A`. +- **sa2**: `[in] CBLAS_INT` stride of the second dimension of `A`. +- **oa**: `[in] CBLAS_INT` starting index for `A`. + +```c +void c_dger( onst CBLAS_INT M, const CBLAS_INT N, const double alpha, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY, double *A, const CBLAS_INT strideA1, const CBLAS_INT strideA2, const CBLAS_INT offsetA ); ``` @@ -135,7 +301,39 @@ TODO ### Examples ```c -TODO +#include "stdlib/blas/base/dger.h" +#include "stdlib/blas/base/shared.h" +#include + +int main( void ) { + // Define a 3x4 matrix stored in row-major order: + double A[ 3*4 ] = { + 0.0, 0.0, 0.0, 0.0, + 0.0, 0.0, 0.0, 0.0, + 0.0, 0.0, 0.0, 0.0 + }; + // Define `x` and `y^T` vectors: + const double x[ 3 ] = { 1.0, 4.0, 0.0 }; // M + const double y[ 4 ] = { 0.0, 1.0, 2.0, 3.0 }; // N + + // Specify the number of rows and columns: + const int M = 3; + const int N = 4; + + // Specify stride lengths: + const int strideX = 1; + const int strideY = 1; + + // Perform operation: + c_dger( CblasRowMajor, M, N, 1.0, x, strideX, y, strideY, A, N ); + + // Print the result: + for ( int i = 0; i < M; i++ ) { + for ( int j = 0; j < N; j++ ) { + printf( "A[%i,%i] = %lf\n", i, j, A[ (i*N)+j ] ); + } + } +} ``` @@ -160,7 +358,11 @@ TODO [blas]: http://www.netlib.org/blas -[dger]: https://www.netlib.org/lapack/explore-html/dc/da8/dger_8f_source.html +[blas-dger]: https://www.netlib.org/lapack/explore-html-3.6.1/d7/d15/group__double__blas__level2_ga458222e01b4d348e9b52b9343d52f828.html + +[mdn-float64array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float64Array + +[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray diff --git a/lib/node_modules/@stdlib/blas/base/dger/benchmark/benchmark.js b/lib/node_modules/@stdlib/blas/base/dger/benchmark/benchmark.js new file mode 100644 index 000000000000..19760efde23d --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/benchmark/benchmark.js @@ -0,0 +1,105 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 floor = require( '@stdlib/math/base/special/floor' ); +var pkg = require( './../package.json' ).name; +var dger = require( './../lib/dger.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} N - array dimension size +* @returns {Function} benchmark function +*/ +function createBenchmark( N ) { + var x = uniform( N, -10.0, 10.0, options ); + var y = uniform( N, -10.0, 10.0, options ); + var A = uniform( N*N, -10.0, 10.0, options ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var z; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + z = dger( 'row-major', N, N, 1.0, x, 1, y, 1, A, N ); + if ( isnan( z[ i%z.length ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( z[ i%z.length ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = floor( pow( pow( 10, i ), 1.0/2.0 ) ); + f = createBenchmark( len ); + bench( pkg+':size='+(len*len), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/dger/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/blas/base/dger/benchmark/benchmark.native.js new file mode 100644 index 000000000000..eab8538a3b42 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/benchmark/benchmark.native.js @@ -0,0 +1,110 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 floor = require( '@stdlib/math/base/special/floor' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var dger = tryRequire( resolve( __dirname, './../lib/dger.native.js' ) ); +var opts = { + 'skip': ( dger instanceof Error ) +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} N - array dimension size +* @returns {Function} benchmark function +*/ +function createBenchmark( N ) { + var x = uniform( N, -10.0, 10.0, options ); + var y = uniform( N, -10.0, 10.0, options ); + var A = uniform( N*N, -10.0, 10.0, options ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var z; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + z = dger( 'row-major', N, N, 1.0, x, 1, y, 1, A, N ); + if ( isnan( z[ i%z.length ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( z[ i%z.length ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = floor( pow( pow( 10, i ), 1.0/2.0 ) ); + f = createBenchmark( len ); + bench( pkg+'::native:size='+(len*len), opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/dger/benchmark/benchmark.ndarray.js b/lib/node_modules/@stdlib/blas/base/dger/benchmark/benchmark.ndarray.js new file mode 100644 index 000000000000..c6827d87000a --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/benchmark/benchmark.ndarray.js @@ -0,0 +1,105 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 floor = require( '@stdlib/math/base/special/floor' ); +var pkg = require( './../package.json' ).name; +var dger = require( './../lib/ndarray.js' ); + + +// VARIABLES // + +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} N - array dimension size +* @returns {Function} benchmark function +*/ +function createBenchmark( N ) { + var x = uniform( N, -10.0, 10.0, options ); + var y = uniform( N, -10.0, 10.0, options ); + var A = uniform( N*N, -10.0, 10.0, options ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var z; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + z = dger( N, N, 1.0, x, 1, 0, y, 1, 0, A, N, 1, 0 ); + if ( isnan( z[ i%z.length ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( z[ i%z.length ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = floor( pow( pow( 10, i ), 1.0/2.0 ) ); + f = createBenchmark( len ); + bench( pkg+':ndarray:size='+(len*len), f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/dger/benchmark/benchmark.ndarray.native.js b/lib/node_modules/@stdlib/blas/base/dger/benchmark/benchmark.ndarray.native.js new file mode 100644 index 000000000000..7ef2d4a26607 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/benchmark/benchmark.ndarray.native.js @@ -0,0 +1,110 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 floor = require( '@stdlib/math/base/special/floor' ); +var tryRequire = require( '@stdlib/utils/try-require' ); +var pkg = require( './../package.json' ).name; + + +// VARIABLES // + +var dger = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( dger instanceof Error ) +}; +var options = { + 'dtype': 'float64' +}; + + +// FUNCTIONS // + +/** +* Creates a benchmark function. +* +* @private +* @param {PositiveInteger} N - array dimension size +* @returns {Function} benchmark function +*/ +function createBenchmark( N ) { + var x = uniform( N, -10.0, 10.0, options ); + var y = uniform( N, -10.0, 10.0, options ); + var A = uniform( N*N, -10.0, 10.0, options ); + return benchmark; + + /** + * Benchmark function. + * + * @private + * @param {Benchmark} b - benchmark instance + */ + function benchmark( b ) { + var z; + var i; + + b.tic(); + for ( i = 0; i < b.iterations; i++ ) { + z = dger( N, N, 1.0, x, 1, 0, y, 1, 0, A, N, 1, 0 ); + if ( isnan( z[ i%z.length ] ) ) { + b.fail( 'should not return NaN' ); + } + } + b.toc(); + if ( isnan( z[ i%z.length ] ) ) { + b.fail( 'should not return NaN' ); + } + b.pass( 'benchmark finished' ); + b.end(); + } +} + + +// MAIN // + +/** +* Main execution sequence. +* +* @private +*/ +function main() { + var len; + var min; + var max; + var f; + var i; + + min = 1; // 10^min + max = 6; // 10^max + + for ( i = min; i <= max; i++ ) { + len = floor( pow( pow( 10, i ), 1.0/2.0 ) ); + f = createBenchmark( len ); + bench( pkg+'::native:ndarray:size='+(len*len), opts, f ); + } +} + +main(); diff --git a/lib/node_modules/@stdlib/blas/base/dger/benchmark/c/Makefile b/lib/node_modules/@stdlib/blas/base/dger/benchmark/c/Makefile new file mode 100644 index 000000000000..cce2c865d7ad --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/benchmark/c/Makefile @@ -0,0 +1,146 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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/base/dger/benchmark/c/benchmark.length.c b/lib/node_modules/@stdlib/blas/base/dger/benchmark/c/benchmark.length.c new file mode 100644 index 000000000000..7c4df3f89600 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/benchmark/c/benchmark.length.c @@ -0,0 +1,206 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/base/dger.h" +#include "stdlib/blas/base/shared.h" +#include +#include +#include +#include +#include + +#define NAME "dger" +#define ITERATIONS 10000000 +#define REPEATS 3 +#define MIN 1 +#define MAX 6 + +/** +* 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 N array dimension size +* @return elapsed time in seconds +*/ +static double benchmark1( int iterations, int N ) { + double elapsed; + double A[ N*N ]; + double x[ N ]; + double y[ N ]; + double t; + int i; + int j; + + for ( i = 0, j = 0; i < N; i++, j += 2 ) { + x[ i ] = ( rand_double()*20.0 ) - 10.0; + y[ i ] = ( rand_double()*20.0 ) - 10.0; + A[ j ] = ( rand_double()*20.0 ) - 10.0; + A[ j+1 ] = ( rand_double()*20.0 ) - 10.0; + } + t = tic(); + for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar + c_dger( CblasRowMajor, N, N, 1.0, x, 1, y, 1, A, N ); + if ( A[ i%(N*2) ] != A[ i%(N*2) ] ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( A[ i%(N*2) ] != A[ i%(N*2) ] ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Runs a benchmark. +* +* @param iterations number of iterations +* @param N array dimension size +* @return elapsed time in seconds +*/ +static double benchmark2( int iterations, int N ) { + double elapsed; + double A[ N*N ]; + double x[ N ]; + double y[ N ]; + double t; + int i; + int j; + + for ( i = 0, j = 0; i < N; i++, j += 2 ) { + x[ i ] = ( rand_double()*20.0 ) - 10.0; + y[ i ] = ( rand_double()*20.0 ) - 10.0; + A[ j ] = ( rand_double()*20.0 ) - 10.0; + A[ j+1 ] = ( rand_double()*20.0 ) - 10.0; + } + t = tic(); + for ( i = 0; i < iterations; i++ ) { + // cppcheck-suppress uninitvar + c_dger_ndarray( N, N, 1.0, x, 1, 0, y, 1, 0, A, N, 1, 0 ); + if ( A[ i%(N*2) ] != A[ i%(N*2) ] ) { + printf( "should not return NaN\n" ); + break; + } + } + elapsed = tic() - t; + if ( A[ i%(N*2) ] != A[ i%(N*2) ] ) { + printf( "should not return NaN\n" ); + } + return elapsed; +} + +/** +* Main execution sequence. +*/ +int main( void ) { + double elapsed; + int count; + int iter; + int N; + 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++ ) { + N = floor( pow( pow( 10, i ), 1.0/2.0 ) ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:size=%d\n", NAME, N*N ); + elapsed = benchmark1( iter, N ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + for ( i = MIN; i <= MAX; i++ ) { + N = floor( pow( pow( 10, i ), 1.0/2.0 ) ); + iter = ITERATIONS / pow( 10, i-1 ); + for ( j = 0; j < REPEATS; j++ ) { + count += 1; + printf( "# c::%s:ndarray:size=%d\n", NAME, N*N ); + elapsed = benchmark2( iter, N ); + print_results( iter, elapsed ); + printf( "ok %d benchmark finished\n", count ); + } + } + print_summary( count, count ); +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/benchmark/fortran/Makefile b/lib/node_modules/@stdlib/blas/base/dger/benchmark/fortran/Makefile new file mode 100644 index 000000000000..449d44a3f1c2 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/benchmark/fortran/Makefile @@ -0,0 +1,141 @@ +#/ +# @license Apache-2.0 +# +# Copyright (c) 2025 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 Fortran source files: +ifdef FORTRAN_COMPILER + FC := $(FORTRAN_COMPILER) +else + FC := gfortran +endif + +# Define the command-line options when compiling Fortran files: +FFLAGS ?= \ + -std=f95 \ + -ffree-form \ + -O3 \ + -Wall \ + -Wextra \ + -Wno-compare-reals \ + -Wimplicit-interface \ + -fno-underscoring \ + -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 ?= + +# List of Fortran source files: +SOURCE_FILES ?= ../../src/dger.f + +# List of Fortran targets: +f_targets := benchmark.length.out + + +# RULES # + +#/ +# Compiles Fortran source files. +# +# @param {string} SOURCE_FILES - list of Fortran source files +# @param {string} [INCLUDE] - list of includes (e.g., `-I /foo/bar -I /beep/boop`) +# @param {string} [FORTRAN_COMPILER] - Fortran compiler +# @param {string} [FFLAGS] - Fortran compiler flags +# @param {(string|void)} [fPIC] - compiler flag indicating whether to generate position independent code +# +# @example +# make +# +# @example +# make all +#/ +all: $(f_targets) + +.PHONY: all + +#/ +# Compiles Fortran source files. +# +# @private +# @param {string} SOURCE_FILES - list of Fortran source files +# @param {(string|void)} INCLUDE - list of includes (e.g., `-I /foo/bar -I /beep/boop`) +# @param {string} FC - Fortran compiler +# @param {string} FFLAGS - Fortran compiler flags +# @param {(string|void)} fPIC - compiler flag indicating whether to generate position independent code +#/ +$(f_targets): %.out: %.f + $(QUIET) $(FC) $(FFLAGS) $(fPIC) $(INCLUDE) -o $@ $(SOURCE_FILES) $< + +#/ +# Runs compiled benchmarks. +# +# @example +# make run +#/ +run: $(f_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/base/dger/benchmark/fortran/benchmark.length.f b/lib/node_modules/@stdlib/blas/base/dger/benchmark/fortran/benchmark.length.f new file mode 100644 index 000000000000..4a1312ef5dac --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/benchmark/fortran/benchmark.length.f @@ -0,0 +1,217 @@ +!> +! @license Apache-2.0 +! +! Copyright (c) 2025 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. +!< + +program bench + implicit none + ! .. + ! Local constants: + character(4), parameter :: name = 'dger' ! if changed, be sure to adjust length + integer, parameter :: iterations = 1000000 + integer, parameter :: repeats = 3 + integer, parameter :: min = 1 + integer, parameter :: max = 6 + ! .. + ! Run the benchmarks: + call main() + ! .. + ! Functions: +contains + ! .. + ! Prints the TAP version. + ! .. + subroutine print_version() + print '(A)', 'TAP version 13' + end subroutine print_version + ! .. + ! Prints the TAP summary. + ! + ! @param {integer} total - total number of tests + ! @param {integer} passing - total number of passing tests + ! .. + subroutine print_summary( total, passing ) + ! .. + ! Scalar arguments: + integer, intent(in) :: total, passing + ! .. + ! Local variables: + character(len=999) :: str, tmp + ! .. + ! Intrinsic functions: + intrinsic adjustl, trim + ! .. + print '(A)', '#' + ! .. + write (str, '(I15)') total ! TAP plan + tmp = adjustl( str ) + print '(A,A)', '1..', trim( tmp ) + ! .. + print '(A,A)', '# total ', trim( tmp ) + ! .. + write (str, '(I15)') passing + tmp = adjustl( str ) + print '(A,A)', '# pass ', trim( tmp ) + ! .. + print '(A)', '#' + print '(A)', '# ok' + end subroutine print_summary + ! .. + ! Prints benchmarks results. + ! + ! @param {integer} iterations - number of iterations + ! @param {double} elapsed - elapsed time in seconds + ! .. + subroutine print_results( iterations, elapsed ) + ! .. + ! Scalar arguments: + double precision, intent(in) :: elapsed + integer, intent(in) :: iterations + ! .. + ! Local variables: + double precision :: rate + character(len=999) :: str, tmp + ! .. + ! Intrinsic functions: + intrinsic dble, adjustl, trim + ! .. + rate = dble( iterations ) / elapsed + ! .. + print '(A)', ' ---' + ! .. + write (str, '(I15)') iterations + tmp = adjustl( str ) + print '(A,A)', ' iterations: ', trim( tmp ) + ! .. + write (str, '(f100.9)') elapsed + tmp = adjustl( str ) + print '(A,A)', ' elapsed: ', trim( tmp ) + ! .. + write( str, '(f100.9)') rate + tmp = adjustl( str ) + print '(A,A)', ' rate: ', trim( tmp ) + ! .. + print '(A)', ' ...' + end subroutine print_results + ! .. + ! Runs a benchmark. + ! + ! @param {integer} iterations - number of iterations + ! @param {integer} N - array dimension size + ! @return {double} elapsed time in seconds + ! .. + double precision function benchmark( iterations, N ) + ! .. + ! External functions: + interface + subroutine dger( M, N, alpha, X, strideX, Y, strideY, A, LDA ) + integer :: strideX, strideY, LDA, M, N + double precision :: X(*), Y(*), A(LDA, *) + double precision :: alpha + end subroutine dger + end interface + ! .. + ! Scalar arguments: + integer, intent(in) :: iterations, N + ! .. + ! Local scalars: + double precision :: elapsed, r + double precision :: t1, t2 + integer :: i, j + ! .. + ! Local arrays: + double precision, allocatable :: x(:), y(:), A(:,:) + ! .. + ! Intrinsic functions: + intrinsic random_number, cpu_time, mod + ! .. + ! Allocate arrays: + allocate( x(N), y(N), A(N,N) ) + ! .. + do i = 1, N + call random_number( r ) + x( i ) = ( r*20.0 ) - 10.0 + call random_number( r ) + y( i ) = ( r*20.0 ) - 10.0 + do j = 1, N + call random_number( r ) + A(i, j) = ( r*20.0 ) - 10.0 + end do + end do + ! .. + call cpu_time( t1 ) + ! .. + j = 1 + do i = 1, iterations + call dger( N, N, 1.0d0, x, 1, y, 1, A, N ) + j = mod( i, N ) + 1 + if ( A( j, j ) /= A( j, j ) ) then + print '(A)', 'should not return NaN' + exit + end if + end do + ! .. + call cpu_time( t2 ) + ! .. + elapsed = t2 - t1 + ! .. + if ( A( j, j ) /= A( j, j ) ) then + print '(A)', 'should not return NaN' + end if + ! .. + ! Deallocate arrays: + deallocate( x, y, A ) + ! .. + benchmark = elapsed + return + end function benchmark + ! .. + ! Main execution sequence. + ! .. + subroutine main() + ! .. + ! Local variables: + character(len=999) :: str, tmp + double precision :: elapsed + integer :: i, j, N, count, iter + ! .. + ! Intrinsic functions: + intrinsic adjustl, trim, floor, sqrt + ! .. + call print_version() + count = 0 + do i = min, max + N = floor( ( 10**i )**(1.0/2.0) ) + iter = iterations / 10**(i-1) + do j = 1, repeats + count = count + 1 + ! .. + write (str, '(I15)') N*N + tmp = adjustl( str ) + print '(A,A,A,A)', '# fortran::', name, ':size=', trim(tmp) + ! .. + elapsed = benchmark( iter, N ) + ! .. + call print_results( iter, elapsed ) + ! .. + write (str, '(I15)') count + tmp = adjustl( str ) + print '(A,A,A)', 'ok ', trim( tmp ), ' benchmark finished' + end do + end do + call print_summary( count, count ) + end subroutine main +end program bench diff --git a/lib/node_modules/@stdlib/blas/base/dger/docs/repl.txt b/lib/node_modules/@stdlib/blas/base/dger/docs/repl.txt new file mode 100644 index 000000000000..a6ea82361bd8 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/docs/repl.txt @@ -0,0 +1,141 @@ + +{{alias}}( ord, M, N, α, x, sx, y, sy, A, lda ) + Performs the rank 1 operation `A = α*x*y^T + A`, where `α` is a scalar, `x` + is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by + `N` matrix. + + Indexing is relative to the first index. To introduce an offset, use typed + array views. + + If `M`, `N`, or `α` is equal to `0`, the function returns `A` unchanged. + + Parameters + ---------- + ord: string + Row-major (C-style) or column-major (Fortran-style) order. + + M: integer + Number of rows in `A`. + + N: integer + Number of columns in `A`. + + α: number + Scalar constant. + + x: Float64Array + First input vector. + + sx: integer + Stride length for `x`. + + y: Float64Array + Second input vector. + + sy: integer + Stride length for `y`. + + A: Float64Array + Input Matrix. + + lda: integer + Stride of the first dimension of `A` (a.k.a., leading dimension of the + matrix `A`). + + Returns + ------- + A: Float64Array + Input Matrix. + + Examples + -------- + // Standard usage: + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0 ] ); + > var y = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0 ] ); + > var A = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] ); + > var ord = 'row-major'; + > {{alias}}( ord, 2, 2, 1.0, x, 1, y, 1, A, 2 ) + [ 2.0, 3.0, 4.0, 5.0 ] + + // Advanced indexing: + > x = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0 ] ); + > y = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0 ] ); + > A = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] ); + > {{alias}}( ord, 2, 2, 1.0, x, -1, y, -1, A, 2 ) + [ 2.0, 3.0, 4.0, 5.0 ] + + // Using typed array views: + > var x0 = new {{alias:@stdlib/array/float64}}( [ 0.0, 1.0, 1.0 ] ); + > var y0 = new {{alias:@stdlib/array/float64}}( [ 0.0, 1.0, 1.0 ] ); + > A = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] ); + > var x1 = new {{alias:@stdlib/array/float64}}( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); + > var y1 = new {{alias:@stdlib/array/float64}}( y0.buffer, y0.BYTES_PER_ELEMENT*1 ); + > {{alias}}( ord, 2, 2, 1.0, x1, -1, y1, -1, A, 2 ) + [ 2.0, 3.0, 4.0, 5.0 ] + + +{{alias}}.ndarray( M, N, α, x, sx, ox, y, sy, oy, A, sa1, sa2, oa ) + Performs the rank 1 operation `A = α*x*y^T + A`, using alternative indexing + semantics and where `α` is a scalar, `x` is an `M` element vector, `y` is an + `N` element vector, and `A` is an `M` by `N` matrix. + + While typed array views mandate a view offset based on the underlying + buffer, the offset parameters support indexing semantics based on starting + indices. + + Parameters + ---------- + M: integer + Number of rows in `A`. + + N: integer + Number of columns in `A`. + + α: number + Scalar constant. + + x: Float64Array + First input vector. + + sx: integer + Stride length for `x`. + + ox: integer + Starting index for `x`. + + y: Float64Array + Second input vector. + + sy: integer + Stride length for `y`. + + oy: integer + Starting index for `y`. + + A: Float64Array + Input Matrix. + + sa1: integer + Stride of the first dimension of `A`. + + sa2: integer + Stride of the second dimension of `A`. + + oa: integer + Starting index for `A`. + + Returns + ------- + A: Float64Array + Input Matrix. + + Examples + -------- + > var x = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0 ] ); + > var y = new {{alias:@stdlib/array/float64}}( [ 1.0, 1.0 ] ); + > var A = new {{alias:@stdlib/array/float64}}( [ 1.0, 2.0, 3.0, 4.0 ] ); + > {{alias}}.ndarray( 2, 2, 1.0, x, 1, 0, y, 1, 0, A, 2, 1, 0 ) + [ 2.0, 3.0, 4.0, 5.0 ] + + See Also + -------- diff --git a/lib/node_modules/@stdlib/blas/base/dger/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/base/dger/docs/types/index.d.ts new file mode 100644 index 000000000000..27457a7d214f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/docs/types/index.d.ts @@ -0,0 +1,127 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 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 + +/// + +import { Layout } from '@stdlib/types/blas'; + +/** +* Interface describing `dger`. +*/ +interface Routine { + /** + * Performs the rank 1 operation `A = α*x*y^T + A`, where `α` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by `N` matrix. + * + * @param order - storage layout + * @param M - number of rows in the matrix `A` + * @param N - number of columns in the matrix `A` + * @param alpha - scalar constant + * @param x - first input vector + * @param strideX - `x` stride length + * @param y - second input vector + * @param strideY - `y` stride length + * @param A - input matrix + * @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) + * @returns `A` + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + * var x = new Float64Array( [ 1.0, 1.0 ] ); + * var y = new Float64Array( [ 1.0, 1.0, 1.0 ] ); + * + * dger( 'row-major', 2, 3, 1.0, x, 1, y, 1, A, 3 ); + * // A => [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] + */ + ( order: Layout, M: number, N: number, alpha: number, x: Float64Array, strideX: number, y: Float64Array, strideY: number, A: Float64Array, LDA: number ): Float64Array; + + /** + * Performs the rank 1 operation `A = α*x*y^T + A`, using alternative indexing semantics and where `α` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by `N` matrix. + * + * @param M - number of rows in the matrix `A` + * @param N - number of columns in the matrix `A` + * @param alpha - scalar constant + * @param x - first input vector + * @param strideX - `x` stride length + * @param offsetX - starting index for `x` + * @param y - second input vector + * @param strideY - `y` stride length + * @param offsetY - starting index for `y` + * @param A - input matrix + * @param strideA1 - stride of the first dimension of `A` + * @param strideA2 - stride of the second dimension of `A` + * @param offsetA - starting index for `A` + * @returns `A` + * + * @example + * var Float64Array = require( '@stdlib/array/float64' ); + * + * var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); + * var x = new Float64Array( [ 1.0, 1.0 ] ); + * var y = new Float64Array( [ 1.0, 1.0, 1.0 ] ); + * + * dger.ndarray( 2, 3, 1.0, x, 1, 0, y, 1, 0, A, 3, 1, 0 ); + * // A => [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] + */ + ndarray( M: number, N: number, alpha: number, x: Float64Array, strideX: number, offsetX: number, y: Float64Array, strideY: number, offsetY: number, A: Float64Array, strideA1: number, strideA2: number, offsetA: number ): Float64Array; +} + +/** +* Performs the rank 1 operation `A = α*x*y^T + A`, where `α` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by `N` matrix. +* +* @param order - storage layout +* @param M - number of rows in the matrix `A` +* @param N - number of columns in the matrix `A` +* @param alpha - scalar constant +* @param x - first input vector +* @param strideX - `x` stride length +* @param y - second input vector +* @param strideY - `y` stride length +* @param A - input matrix +* @param LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) +* @returns `A` +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var A = new Float64Array( [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] ); +* var x = new Float64Array( [ 1.0, 1.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0 ] ); +* +* dger( 'column-major', 2, 3, 1.0, x, 1, y, 1, A, 2 ); +* // A => [ 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var A = new Float64Array( [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] ); +* var x = new Float64Array( [ 1.0, 1.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0 ] ); +* +* dger.ndarray( 2, 3, 1.0, x, 1, 0, y, 1, 0, A, 1, 2, 0 ); +* // A => [ 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] +*/ +declare var dger: Routine; + + +// EXPORTS // + +export = dger; diff --git a/lib/node_modules/@stdlib/blas/base/dger/docs/types/test.ts b/lib/node_modules/@stdlib/blas/base/dger/docs/types/test.ts new file mode 100644 index 000000000000..05a2df32cdef --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/docs/types/test.ts @@ -0,0 +1,449 @@ +/* +* @license Apache-2.0 +* +* Copyright (c) 2025 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 dger = require( './index' ); + + +// TESTS // + +// The function returns a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectType Float64Array +} + +// The compiler throws an error if the function is provided a first argument which is not a string... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger( 10, 10, 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( true, 10, 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( false, 10, 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( null, 10, 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( undefined, 10, 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( [], 10, 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( {}, 10, 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( ( x: number ): number => x, 10, 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger( 'row-major', '10', 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', true, 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', false, 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', null, 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', undefined, 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', [], 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', {}, 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', ( x: number ): number => x, 10, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger( 'row-major', 10, '10', 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, true, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, false, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, null, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, undefined, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, [], 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, {}, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, ( x: number ): number => x, 1.0, x, 1, y, 1, A, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger( 'row-major', 10, 10, '10', x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, true, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, false, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, null, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, undefined, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, [], x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, {}, x, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, ( x: number ): number => x, x, 1, y, 1, A, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fifth argument which is not a Float64Array... +{ + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger( 'row-major', 10, 10, 1.0, 10, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, '10', 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, true, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, false, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, null, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, undefined, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, [ '1' ], 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, {}, 1, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, ( x: number ): number => x, 1, y, 1, A, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a sixth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger( 'row-major', 10, 10, 1.0, x, '10', y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, true, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, false, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, null, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, undefined, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, [], y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, {}, y, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, ( x: number ): number => x, y, 1, A, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a seventh argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger( 'row-major', 10, 10, 1.0, x, 1, 10, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, '10', 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, true, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, false, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, null, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, undefined, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, [ '1' ], 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, {}, 1, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, ( x: number ): number => x, 1, A, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided an eighth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger( 'row-major', 10, 10, 1.0, x, 1, y, '10', A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, true, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, false, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, null, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, undefined, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, [], A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, {}, A, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, ( x: number ): number => x, A, 10 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a ninth argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, 10, 1 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, '10', 1 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, true, 1 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, false, 1 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, null, 1 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, undefined, 1 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, [ '1' ], 1 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, {}, 1 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, ( x: number ): number => x, 1 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a tenth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, A, '10' ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, A, true ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, A, false ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, A, null ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, A, undefined ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, A, [] ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, A, {} ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, A, ( x: number ): number => x ); // $ExpectError +} + +// The compiler throws an error if the function is provided an unsupported number of arguments... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger(); // $ExpectError + dger( 'row-major' ); // $ExpectError + dger( 'row-major', 10 ); // $ExpectError + dger( 'row-major', 10, 10 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1 ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, A ); // $ExpectError + dger( 'row-major', 10, 10, 1.0, x, 1, y, 1, A, 10, 10 ); // $ExpectError +} + +// Attached to main export is an `ndarray` method which returns a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectType Float64Array +} + +// The compiler throws an error if the function is provided a first argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger.ndarray( '10', 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( true, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( false, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( null, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( undefined, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( [], 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( {}, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( ( x: number ): number => x, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a second argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger.ndarray( 10, '10', 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, true, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, false, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, null, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, undefined, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, [], 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, {}, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, ( x: number ): number => x, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a third argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger.ndarray( 10, 10, '10', x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, true, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, false, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, null, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, undefined, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, [], x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, {}, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, ( x: number ): number => x, x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fourth argument which is not a Float64Array... +{ + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger.ndarray( 10, 10, 1.0, 10, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, '10', 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, true, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, false, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, null, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, undefined, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, [ '1' ], 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, {}, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, ( x: number ): number => x, 1, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a fifth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger.ndarray( 10, 10, 1.0, x, '10', 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, true, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, false, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, null, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, undefined, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, [], 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, {}, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, ( x: number ): number => x, 0, y, 1, 0, A, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a sixth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger.ndarray( 10, 10, 1.0, x, 1, '10', y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, true, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, false, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, null, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, undefined, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, [], y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, {}, y, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, ( x: number ): number => x, y, 1, 0, A, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a seventh argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger.ndarray( 10, 10, 1.0, x, 1, 0, 10, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, '10', 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, true, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, false, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, null, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, undefined, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, [ '1' ], 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, {}, 1, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, ( x: number ): number => x, 1, 0, A, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided an eighth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, '10', 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, true, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, false, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, null, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, undefined, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, [], 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, {}, 0, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, ( x: number ): number => x, 0, A, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a ninth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, '10', A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, true, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, false, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, null, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, undefined, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, [], A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, {}, A, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, ( x: number ): number => x, A, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a tenth argument which is not a Float64Array... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, 10, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, '10', 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, true, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, false, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, null, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, undefined, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, [ '1' ], 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, {}, 10, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, ( x: number ): number => x, 10, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided an eleventh argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, '10', 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, true, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, false, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, null, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, undefined, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, [], 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, {}, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, ( x: number ): number => x, 1, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a twelfth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, '10', 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, true, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, false, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, null, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, undefined, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, [], 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, {}, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, ( x: number ): number => x, 0 ); // $ExpectError +} + +// The compiler throws an error if the function is provided a thirteenth argument which is not a number... +{ + const x = new Float64Array( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, '10' ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, true ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, false ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, null ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, undefined ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, [] ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, {} ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 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( 10 ); + const y = new Float64Array( 10 ); + const A = new Float64Array( 20 ); + + dger.ndarray(); // $ExpectError + dger.ndarray( 10 ); // $ExpectError + dger.ndarray( 10, 10 ); // $ExpectError + dger.ndarray( 10, 10, 1.0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1 ); // $ExpectError + dger.ndarray( 10, 10, 1.0, x, 1, 0, y, 1, 0, A, 10, 1, 0, 10 ); // $ExpectError +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/examples/c/example.c b/lib/node_modules/@stdlib/blas/base/dger/examples/c/example.c index 63fb90b3ea5a..ec0acd6191b6 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/examples/c/example.c +++ b/lib/node_modules/@stdlib/blas/base/dger/examples/c/example.c @@ -21,34 +21,31 @@ #include int main( void ) { - // Define a 4x3 matrix `B` stored in row-major order (i.e., equivalent to the transpose `A^T` of a 3x4 matrix `A` stored in column-major order): - double B[ 4*3 ] = { + // Define a 3x4 matrix stored in row-major order: + double A[ 3*4 ] = { 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0 }; - // Define `x^T` and `y` vectors: - double x[ 4 ] = { 0.0, 1.0, 2.0, 3.0 }; // M - double y[ 3 ] = { 1.0, 4.0, 0.0 }; // N + // Define `x` and `y^T` vectors: + const double x[ 3 ] = { 1.0, 4.0, 0.0 }; // M + const double y[ 4 ] = { 0.0, 1.0, 2.0, 3.0 }; // N // Specify the number of rows and columns: - const int M = 4; - const int N = 3; + const int M = 3; + const int N = 4; // Specify stride lengths: const int strideX = 1; const int strideY = 1; - // Specify the matrix layout: - const CBLAS_LAYOUT layout = CblasRowMajor; - - // Perform operation (note: arguments are reordered as: A_{M,N} = α⋅x_M⋅y^T_N + A_{M,N} => B = A^T = α⋅y⋅x^T + A^T = α⋅y⋅x^T + B): - c_dger( layout, N, M, 1.0, y, strideY, x, strideX, B, M ); + // Perform operation: + c_dger( CblasRowMajor, M, N, 1.0, x, strideX, y, strideY, A, N ); // Print the result: - for ( int i = 0; i < N; i++ ) { - for ( int j = 0; j < M; j++ ) { - printf( "B[%i,%i] = %lf\n", i, j, B[ (i*M)+j ] ); + for ( int i = 0; i < M; i++ ) { + for ( int j = 0; j < N; j++ ) { + printf( "A[%i,%i] = %lf\n", i, j, A[ (i*N)+j ] ); } } } diff --git a/lib/node_modules/@stdlib/blas/base/dger/examples/index.js b/lib/node_modules/@stdlib/blas/base/dger/examples/index.js index 9e6f484ac7b4..00bd66217fb6 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/examples/index.js +++ b/lib/node_modules/@stdlib/blas/base/dger/examples/index.js @@ -16,41 +16,24 @@ * limitations under the License. */ -/* eslint-disable */ // FIXME - 'use strict'; var discreteUniform = require( '@stdlib/random/array/discrete-uniform' ); -var zeros = require( '@stdlib/array/zeros' ); var dger = require( './../lib' ); -// var M = 4; -// var N = 3; -// var B = zeros( M*N, 'float64' ); - -// var opts = { -// 'dtype': 'float64' -// }; -// var x = discreteUniform( M, 0, 500, opts ); -// console.log( x ); - -// var y = discreteUniform( N, 0, 255, opts ); -// console.log( y ); - -// dger( 'row-major', N, M, 1.0, y, 1, x, 1, B, N ); -// console.log( B ); - -var Float64Array = require( '@stdlib/array/float64' ); +var opts = { + 'dtype': 'float32' +}; -var M = 4; -var N = 3; -var B = zeros( M*N, 'float64' ); +var M = 3; +var N = 5; -var x = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); -console.log( x ); +var A = discreteUniform( M*N, 0, 255, opts ); +var x = discreteUniform( M, 0, 255, opts ); +var y = discreteUniform( N, 0, 255, opts ); -var y = new Float64Array( [ 1.0, 4.0, 0.0 ] ); -console.log( y ); +dger( 'row-major', M, N, 1.0, x, 1, y, 1, A, N ); +console.log( A ); -dger( 'row-major', N, M, 1.0, y, 1, x, 1, B, M ); -console.log( B ); +dger.ndarray( M, N, 1.0, x, 1, 0, y, 1, 0, A, 1, M, 0 ); +console.log( A ); diff --git a/lib/node_modules/@stdlib/blas/base/dger/include/stdlib/blas/base/dger.h b/lib/node_modules/@stdlib/blas/base/dger/include/stdlib/blas/base/dger.h index 1b774738e5c5..3e2f97d528e6 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/include/stdlib/blas/base/dger.h +++ b/lib/node_modules/@stdlib/blas/base/dger/include/stdlib/blas/base/dger.h @@ -36,6 +36,11 @@ extern "C" { */ void API_SUFFIX(c_dger)( const CBLAS_LAYOUT layout, const CBLAS_INT M, const CBLAS_INT N, const double alpha, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY, double *A, const CBLAS_INT LDA ); +/** +* Performs the rank 1 operation `A = alpha*x*y^T + A`, using alternative indexing semantics and where `alpha` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M`-by-`N` matrix. +*/ +void API_SUFFIX(c_dger_ndarray)( const CBLAS_INT M, const CBLAS_INT N, const double alpha, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY, double *A, const CBLAS_INT strideA1, const CBLAS_INT strideA2, const CBLAS_INT offsetA ); + #ifdef __cplusplus } #endif diff --git a/lib/node_modules/@stdlib/blas/base/dger/lib/base.js b/lib/node_modules/@stdlib/blas/base/dger/lib/base.js new file mode 100644 index 000000000000..f5466c874cfe --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/lib/base.js @@ -0,0 +1,189 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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 isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major' ); + + +// MAIN // + +/** +* Performs the rank 1 operation `A = α*x*y^T + A`, where `α` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by `N` matrix. +* +* ## Notes +* +* - To help motivate the use of loop interchange below, we first recognize that a matrix stored in row-major order is equivalent to storing the matrix's transpose in column-major order. For example, consider the following 2-by-3 matrix `A` +* +* ```tex +* A = \begin{bmatrix} +* 1 & 2 & 3 \\ +* 4 & 5 & 6 +* \end{bmatrix} +* ``` +* +* When stored in a linear buffer in column-major order, `A` becomes +* +* ```text +* [ 1 4 2 5 3 6] +* ``` +* +* When stored in a linear buffer in row-major order, `A` becomes +* +* ```text +* [ 1 2 3 4 5 6] +* ``` +* +* Now consider the transpose of `A` +* +* ```tex +* A^T = \begin{bmatrix} +* 1 & 4 \\ +* 2 & 5 \\ +* 3 & 6 +* \end{bmatrix} +* ``` +* +* When the transpose is stored in a linear buffer in column-major order, the transpose becomes +* +* ```text +* [ 1 2 3 4 5 6 ] +* ``` +* +* Similarly, when stored in row-major order, the transpose becomes +* +* ```text +* [ 1 4 2 5 3 6 ] +* ``` +* +* As may be observed, `A` stored in column-major order is equivalent to storing the transpose of `A` in row-major order, and storing `A` in row-major order is equivalent to storing the transpose of `A` in column-major order, and vice versa. +* +* Hence, we can interpret an `M` by `N` row-major matrix `B` as the matrix `A^T` stored in column-major order. In which case, we can derive an update equation for `B` as follows: +* +* ```tex +* \begin{align*} +* B &= A^T \\ +* &= (\alpha \bar{x} \bar{y}^T + A)^T \\ +* &= (\alpha \bar{x} \bar{y}^T)^T + A^T \\ +* &= \alpha (\bar{x} \bar{y}^T)^T + A^T \\ +* &= \alpha \bar{y} \bar{x}^T + A^T \\ +* &= \alpha \bar{y} \bar{x}^T + B +* \end{align*} +* ``` +* +* Accordingly, we can reuse the same loop logic for column-major and row-major `A` by simply swapping `x` and `y` and `M` and `N` when `A` is row-major order. That is the essence of loop interchange. +* +* @private +* @param {NonNegativeInteger} M - number of rows in the matrix `A` +* @param {NonNegativeInteger} N - number of columns in the matrix `A` +* @param {number} alpha - scalar constant +* @param {Float64Array} x - first input vector +* @param {integer} strideX - `x` stride length +* @param {NonNegativeInteger} offsetX - starting index for `x` +* @param {Float64Array} y - second input vector +* @param {integer} strideY - `y` stride length +* @param {NonNegativeInteger} offsetY - starting index for `y` +* @param {Float64Array} A - input matrix +* @param {integer} strideA1 - stride of the first dimension of `A` +* @param {integer} strideA2 - stride of the second dimension of `A` +* @param {NonNegativeInteger} offsetA - starting index for `A` +* @returns {Float64Array} `A` +* +* @example +* var Float64Array = require( '@stdlib/array/float64' ); +* +* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var x = new Float64Array( [ 1.0, 1.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0 ] ); +* +* dger( 2, 3, 1.0, x, 1, 0, y, 1, 0, A, 3, 1, 0 ); +* // A => [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] +*/ +function dger( M, N, alpha, x, strideX, offsetX, y, strideY, offsetY, A, strideA1, strideA2, offsetA ) { // eslint-disable-line max-params, max-len + var tmp; + var da0; + var da1; + var S0; + var S1; + var sx; + var sy; + var ia; + var ix; + var iy; + var i0; + var i1; + + // Note on variable naming convention: S#, da#, ia#, i# where # corresponds to the loop number, with `0` being the innermost loop... + + // Extract loop variables for purposes of loop interchange: dimensions and loop offset (pointer) increments... + if ( isRowMajor( [ strideA1, strideA2 ] ) ) { + // For row-major matrices, the last dimension has the fastest changing index... + S0 = N; + S1 = M; + da0 = strideA2; // offset increment for innermost loop + da1 = strideA1 - ( S0*strideA2 ); // offset increment for outermost loop + + // Swap the vectors... + tmp = x; + x = y; + y = tmp; + + tmp = strideX; + strideX = strideY; + strideY = tmp; + + tmp = offsetX; + offsetX = offsetY; + offsetY = tmp; + } else { // order === 'column-major' + // For column-major matrices, the first dimension has the fastest changing index... + S0 = M; + S1 = N; + da0 = strideA1; // offset increment for innermost loop + da1 = strideA2 - ( S0*strideA1 ); // offset increment for outermost loop + } + sx = strideX; + sy = strideY; + ix = offsetX; + iy = offsetY; + ia = offsetA; + for ( i1 = 0; i1 < S1; i1++ ) { + // Check whether we can avoid the inner loop entirely... + if ( y[ iy ] === 0.0 ) { + ia += da0 * S0; + } else { + tmp = alpha * y[ iy ]; + ix = offsetX; + for ( i0 = 0; i0 < S0; i0++ ) { + A[ ia ] += x[ ix ] * tmp; + ix += sx; + ia += da0; + } + } + iy += sy; + ia += da1; + } + return A; +} + + +// EXPORTS // + +module.exports = dger; diff --git a/lib/node_modules/@stdlib/blas/base/dger/lib/dger.js b/lib/node_modules/@stdlib/blas/base/dger/lib/dger.js index c3f3eb2fa88e..640c7e2423e9 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/lib/dger.js +++ b/lib/node_modules/@stdlib/blas/base/dger/lib/dger.js @@ -16,45 +16,97 @@ * limitations under the License. */ -/* eslint-disable */ // FIXME - 'use strict'; +// MODULES // + +var isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' ); +var isLayout = require( '@stdlib/blas/base/assert/is-layout' ); +var stride2offset = require( '@stdlib/strided/base/stride2offset' ); +var max = require( '@stdlib/math/base/special/fast/max' ); +var format = require( '@stdlib/string/format' ); +var base = require( './base.js' ); + + // MAIN // /** -* Performs the rank 1 operation `A = alpha*x*y^T + A`. +* Performs the rank 1 operation `A = α*x*y^T + A`, where `α` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by `N` matrix. * -* @param {*} order - storage layout +* @param {string} order - storage layout * @param {NonNegativeInteger} M - number of rows in the matrix `A` * @param {NonNegativeInteger} N - number of columns in the matrix `A` * @param {number} alpha - scalar constant -* @param {Float64Array} x - an `M` element vector +* @param {Float64Array} x - first input vector * @param {integer} strideX - `x` stride length -* @param {Float64Array} y - an `N` element vector +* @param {Float64Array} y - second input vector * @param {integer} strideY - `y` stride length -* @param {Float64Array} A - matrix of coefficients +* @param {Float64Array} A - input matrix * @param {PositiveInteger} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) +* @throws {TypeError} first argument must be a valid order +* @throws {RangeError} second argument must be a nonnegative integer +* @throws {RangeError} third argument must be a nonnegative integer +* @throws {RangeError} sixth argument must be non-zero +* @throws {RangeError} eighth argument must be non-zero +* @throws {RangeError} tenth argument must be a valid stride * @returns {Float64Array} `A` * * @example * var Float64Array = require( '@stdlib/array/float64' ); * -* var M = 4; -* var N = 3; -* -* var B = new Float64Array( M*N ); -* -* var x = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); -* var y = new Float64Array( [ 1.0, 4.0, 0.0 ] ); +* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var x = new Float64Array( [ 1.0, 1.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0 ] ); * -* dger( 'row-major', N, M, 1.0, y, 1, x, 1, B, M ); -* // B => [ 0.0, 1.0, 2.0, 3.0, 0.0, 4.0, 8.0, 12.0, 0.0, 0.0, 0.0, 0.0 ] +* dger( 'row-major', 2, 3, 1.0, x, 1, y, 1, A, 3 ); +* // A => [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] */ function dger( order, M, N, alpha, x, strideX, y, strideY, A, LDA ) { - // TODO: implementation + var iscm; + var vala; + var sa1; + var sa2; + var ox; + var oy; - return A; + if ( !isLayout( order ) ) { + throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) ); + } + if ( M < 0 ) { + throw new RangeError( format( 'invalid argument. Second argument must be a nonnegative integer. Value: `%d`.', M ) ); + } + if ( N < 0 ) { + throw new RangeError( format( 'invalid argument. Third argument must be a nonnegative integer. Value: `%d`.', N ) ); + } + if ( strideX === 0 ) { + throw new RangeError( format( 'invalid argument. Sixth argument must be non-zero. Value: `%d`.', strideX ) ); + } + if ( strideY === 0 ) { + throw new RangeError( format( 'invalid argument. Eighth argument must be non-zero. Value: `%d`.', strideY ) ); + } + iscm = isColumnMajor( order ); + if ( iscm ) { + vala = M; + } else { + vala = N; + } + if ( LDA < max( 1, vala ) ) { + throw new RangeError( format( 'invalid argument. Tenth argument must be greater than or equal to max(1,%d). Value: `%d`.', vala, LDA ) ); + } + // Check if we can early return... + if ( M === 0 || N === 0 || alpha === 0.0 ) { + return A; + } + ox = stride2offset( M, strideX ); + oy = stride2offset( N, strideY ); + if ( iscm ) { + sa1 = 1; + sa2 = LDA; + } else { // order === 'row-major' + sa1 = LDA; + sa2 = 1; + } + return base( M, N, alpha, x, strideX, ox, y, strideY, oy, A, sa1, sa2, 0 ); } diff --git a/lib/node_modules/@stdlib/blas/base/dger/lib/dger.native.js b/lib/node_modules/@stdlib/blas/base/dger/lib/dger.native.js index 80779dd74619..3a823879e860 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/lib/dger.native.js +++ b/lib/node_modules/@stdlib/blas/base/dger/lib/dger.native.js @@ -20,7 +20,10 @@ // MODULES // +var isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' ); +var isLayout = require( '@stdlib/blas/base/assert/is-layout' ); var resolve = require( '@stdlib/blas/base/layout-resolve-enum' ); +var max = require( '@stdlib/math/base/special/fast/max' ); var format = require( '@stdlib/string/format' ); var addon = require( './../src/addon.node' ); @@ -28,41 +31,66 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Performs the rank 1 operation `A = alpha*x*y^T + A`. +* Performs the rank 1 operation `A = α*x*y^T + A`, where `α` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by `N` matrix. * * @param {*} order - storage layout * @param {NonNegativeInteger} M - number of rows in the matrix `A` * @param {NonNegativeInteger} N - number of columns in the matrix `A` * @param {number} alpha - scalar constant -* @param {Float64Array} x - an `M` element vector +* @param {Float64Array} x - first input vector * @param {integer} strideX - `x` stride length -* @param {Float64Array} y - an `N` element vector +* @param {Float64Array} y - second input vector * @param {integer} strideY - `y` stride length * @param {Float64Array} A - matrix of coefficients * @param {PositiveInteger} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) -* @throws {TypeError} first argument must be a supported BLAS memory layout +* @throws {TypeError} first argument must be a valid order +* @throws {RangeError} second argument must be a nonnegative integer +* @throws {RangeError} third argument must be a nonnegative integer +* @throws {RangeError} sixth argument must be non-zero +* @throws {RangeError} eighth argument must be non-zero +* @throws {RangeError} tenth argument must be a valid stride * @returns {Float64Array} `A` * * @example * var Float64Array = require( '@stdlib/array/float64' ); * -* var M = 4; -* var N = 3; +* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var x = new Float64Array( [ 1.0, 1.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0 ] ); * -* var B = new Float64Array( M*N ); -* -* var x = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); -* var y = new Float64Array( [ 1.0, 4.0, 0.0 ] ); -* -* dger( 'row-major', N, M, 1.0, y, 1, x, 1, B, M ); -* // B => [ 0.0, 1.0, 2.0, 3.0, 0.0, 4.0, 8.0, 12.0, 0.0, 0.0, 0.0, 0.0 ] +* dger( 'row-major', 2, 3, 1.0, x, 1, y, 1, A, 3 ); +* // A => [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] */ function dger( order, M, N, alpha, x, strideX, y, strideY, A, LDA ) { - var ord = resolve( order ); - if ( ord === null ) { - throw new TypeError( format( 'invalid argument. First argument must be a supported BLAS memory layout. Value: `%s`.', order ) ); + var vala; + if ( !isLayout( order ) ) { + throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) ); + } + if ( M < 0 ) { + throw new RangeError( format( 'invalid argument. Second argument must be a nonnegative integer. Value: `%d`.', M ) ); + } + if ( N < 0 ) { + throw new RangeError( format( 'invalid argument. Third argument must be a nonnegative integer. Value: `%d`.', N ) ); + } + if ( strideX === 0 ) { + throw new RangeError( format( 'invalid argument. Sixth argument must be non-zero. Value: `%d`.', strideX ) ); + } + if ( strideY === 0 ) { + throw new RangeError( format( 'invalid argument. Eighth argument must be non-zero. Value: `%d`.', strideY ) ); + } + if ( isColumnMajor( order ) ) { + vala = M; + } else { + vala = N; + } + if ( LDA < max( 1, vala ) ) { + throw new RangeError( format( 'invalid argument. Tenth argument must be greater than or equal to max(1,%d). Value: `%d`.', vala, LDA ) ); + } + // Check if we can early return... + if ( M === 0 || N === 0 || alpha === 0.0 ) { + return A; } - addon( ord, M, N, alpha, x, strideX, y, strideY, A, LDA ); + addon( resolve( order ), M, N, alpha, x, strideX, y, strideY, A, LDA ); return A; } diff --git a/lib/node_modules/@stdlib/blas/base/dger/lib/index.js b/lib/node_modules/@stdlib/blas/base/dger/lib/index.js index 5641b87166fd..1464ad6f7991 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/lib/index.js +++ b/lib/node_modules/@stdlib/blas/base/dger/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* BLAS level 2 routine to perform the rank 1 operation `A = alpha*x*y^T + A`. +* BLAS level 2 routine to perform the rank 1 operation `A = α*x*y^T + A`, where `α` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by `N` matrix. * * @module @stdlib/blas/base/dger * @@ -27,31 +27,23 @@ * var Float64Array = require( '@stdlib/array/float64' ); * var dger = require( '@stdlib/blas/base/dger' ); * -* var M = 4; -* var N = 3; +* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var x = new Float64Array( [ 1.0, 1.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0 ] ); * -* var B = new Float64Array( M*N ); -* -* var x = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); -* var y = new Float64Array( [ 1.0, 4.0, 0.0 ] ); -* -* dger( 'row-major', N, M, 1.0, y, 1, x, 1, B, M ); -* // B => [ 0.0, 1.0, 2.0, 3.0, 0.0, 4.0, 8.0, 12.0, 0.0, 0.0, 0.0, 0.0 ] +* dger( 'row-major', 2, 3, 1.0, x, 1, y, 1, A, 3 ); +* // A => [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] * * @example * var Float64Array = require( '@stdlib/array/float64' ); * var dger = require( '@stdlib/blas/base/dger' ); * -* var M = 4; -* var N = 3; -* -* var B = new Float64Array( M*N ); -* -* var x = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); -* var y = new Float64Array( [ 1.0, 4.0, 0.0 ] ); +* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var x = new Float64Array( [ 1.0, 1.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0 ] ); * -* dger.ndarray( 'row-major', N, M, 1.0, y, 1, 0, x, 1, 0, B, M ); -* // B => [ 0.0, 1.0, 2.0, 3.0, 0.0, 4.0, 8.0, 12.0, 0.0, 0.0, 0.0, 0.0 ] +* dger.ndarray( 2, 3, 1.0, x, 1, 0, y, 1, 0, A, 3, 1, 0 ); +* // A => [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] */ // MODULES // diff --git a/lib/node_modules/@stdlib/blas/base/dger/lib/ndarray.js b/lib/node_modules/@stdlib/blas/base/dger/lib/ndarray.js index 5bc5629a9200..28ba2cafbd49 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/lib/ndarray.js +++ b/lib/node_modules/@stdlib/blas/base/dger/lib/ndarray.js @@ -16,48 +16,66 @@ * limitations under the License. */ -/* eslint-disable */ // FIXME - 'use strict'; +// MODULES // + +var format = require( '@stdlib/string/format' ); +var base = require( './base.js' ); + + // MAIN // /** -* Performs the rank 1 operation `A = alpha*x*y^T + A`. +* Performs the rank 1 operation `A = α*x*y^T + A`, where `α` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by `N` matrix. * -* @param {*} order - storage layout * @param {NonNegativeInteger} M - number of rows in the matrix `A` * @param {NonNegativeInteger} N - number of columns in the matrix `A` * @param {number} alpha - scalar constant -* @param {Float64Array} x - an `M` element vector +* @param {Float64Array} x - first input vector * @param {integer} strideX - `x` stride length -* @param {NonNegativeInteger} offsetX - starting `x` index -* @param {Float64Array} y - an `N` element vector +* @param {NonNegativeInteger} offsetX - starting index for `x` +* @param {Float64Array} y - second input vector * @param {integer} strideY - `y` stride length -* @param {NonNegativeInteger} offsetY - starting `y` index -* @param {Float64Array} A - matrix of coefficients -* @param {PositiveInteger} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) +* @param {NonNegativeInteger} offsetY - starting index for `y` +* @param {Float64Array} A - input matrix +* @param {integer} strideA1 - stride of the first dimension of `A` +* @param {integer} strideA2 - stride of the second dimension of `A` +* @param {NonNegativeInteger} offsetA - starting index for `A` +* @throws {RangeError} first argument must be a nonnegative integer +* @throws {RangeError} second argument must be a nonnegative integer +* @throws {RangeError} fifth argument must be non-zero +* @throws {RangeError} eighth argument must be non-zero * @returns {Float64Array} `A` * * @example * var Float64Array = require( '@stdlib/array/float64' ); * -* var M = 4; -* var N = 3; +* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var x = new Float64Array( [ 1.0, 1.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0 ] ); * -* var B = new Float64Array( M*N ); -* -* var x = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); -* var y = new Float64Array( [ 1.0, 4.0, 0.0 ] ); -* -* dger( 'row-major', N, M, 1.0, y, 1, 0, x, 1, 0, B, M ); -* // B => [ 0.0, 1.0, 2.0, 3.0, 0.0, 4.0, 8.0, 12.0, 0.0, 0.0, 0.0, 0.0 ] +* dger( 2, 3, 1.0, x, 1, 0, y, 1, 0, A, 3, 1, 0 ); +* // A => [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] */ -function dger( order, M, N, alpha, x, strideX, offsetX, y, strideY, offsetY, A, LDA ) { - - // TODO: implementation - - return A; +function dger( M, N, alpha, x, strideX, offsetX, y, strideY, offsetY, A, strideA1, strideA2, offsetA ) { // eslint-disable-line max-params, max-len + if ( M < 0 ) { + throw new RangeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%d`.', M ) ); + } + if ( N < 0 ) { + throw new RangeError( format( 'invalid argument. Second argument must be a nonnegative integer. Value: `%d`.', N ) ); + } + if ( strideX === 0 ) { + throw new RangeError( format( 'invalid argument. Fifth argument must be non-zero. Value: `%d`.', strideX ) ); + } + if ( strideY === 0 ) { + throw new RangeError( format( 'invalid argument. Eighth argument must be non-zero. Value: `%d`.', strideY ) ); + } + // Check if we can early return... + if ( M === 0 || N === 0 || alpha === 0.0 ) { + return A; + } + return base( M, N, alpha, x, strideX, offsetX, y, strideY, offsetY, A, strideA1, strideA2, offsetA ); // eslint-disable-line max-len } diff --git a/lib/node_modules/@stdlib/blas/base/dger/lib/ndarray.native.js b/lib/node_modules/@stdlib/blas/base/dger/lib/ndarray.native.js index c91cf81824e2..4ce3449dcb01 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/lib/ndarray.native.js +++ b/lib/node_modules/@stdlib/blas/base/dger/lib/ndarray.native.js @@ -20,63 +20,62 @@ // MODULES // -var minViewBufferIndex = require( '@stdlib/strided/base/min-view-buffer-index' ); -var offsetView = require( '@stdlib/strided/base/offset-view' ); -var resolve = require( '@stdlib/blas/base/layout-resolve-enum' ); var format = require( '@stdlib/string/format' ); -var addon = require( './dger.native.js' ); +var addon = require( './../src/addon.node' ); // MAIN // /** -* Performs the rank 1 operation `A = alpha*x*y^T + A`. +* Performs the rank 1 operation `A = α*x*y^T + A`, where `α` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M` by `N` matrix. * -* @param {*} order - storage layout * @param {NonNegativeInteger} M - number of rows in the matrix `A` * @param {NonNegativeInteger} N - number of columns in the matrix `A` * @param {number} alpha - scalar constant -* @param {Float64Array} x - an `M` element vector +* @param {Float64Array} x - first input vector * @param {integer} strideX - `x` stride length * @param {NonNegativeInteger} offsetX - starting `x` index -* @param {Float64Array} y - an `N` element vector +* @param {Float64Array} y - second input vector * @param {integer} strideY - `y` stride length * @param {NonNegativeInteger} offsetY - starting `y` index -* @param {Float64Array} A - matrix of coefficients -* @param {PositiveInteger} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) -* @throws {TypeError} first argument must be a supported BLAS memory layout +* @param {Float64Array} A - input matrix +* @param {integer} strideA1 - stride of the first dimension of `A` +* @param {integer} strideA2 - stride of the second dimension of `A` +* @param {NonNegativeInteger} offsetA - starting index for `A +* @throws {RangeError} first argument must be a nonnegative integer +* @throws {RangeError} second argument must be a nonnegative integer +* @throws {RangeError} fifth argument must be non-zero +* @throws {RangeError} eighth argument must be non-zero * @returns {Float64Array} `A` * * @example * var Float64Array = require( '@stdlib/array/float64' ); * -* var M = 4; -* var N = 3; +* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] ); +* var x = new Float64Array( [ 1.0, 1.0 ] ); +* var y = new Float64Array( [ 1.0, 1.0, 1.0 ] ); * -* var B = new Float64Array( M*N ); -* -* var x = new Float64Array( [ 0.0, 1.0, 2.0, 3.0 ] ); -* var y = new Float64Array( [ 1.0, 4.0, 0.0 ] ); -* -* dger( 'row-major', N, M, 1.0, y, 1, 0, x, 1, 0, B, M ); -* // B => [ 0.0, 1.0, 2.0, 3.0, 0.0, 4.0, 8.0, 12.0, 0.0, 0.0, 0.0, 0.0 ] +* dger( 2, 3, 1.0, x, 1, 0, y, 1, 0, A, 3, 1, 0 ); +* // A => [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] */ -function dger( order, M, N, alpha, x, strideX, offsetX, y, strideY, offsetY, A, LDA ) { // eslint-disable-line max-len, max-params - var viewX; - var viewY; - var ord; - - ord = resolve( order ); - if ( ord === null ) { - throw new TypeError( format( 'invalid argument. First argument must be a supported BLAS memory layout. Value: `%s`.', order ) ); +function dger( M, N, alpha, x, strideX, offsetX, y, strideY, offsetY, A, strideA1, strideA2, offsetA ) { // eslint-disable-line max-len, max-params + if ( M < 0 ) { + throw new RangeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%d`.', M ) ); } - offsetX = minViewBufferIndex( N, strideX, offsetX ); - offsetY = minViewBufferIndex( N, strideY, offsetY ); - - viewX = offsetView( x, offsetX ); - viewY = offsetView( y, offsetY ); - - addon( ord, M, N, alpha, viewX, strideX, viewY, strideY, A, LDA ); + if ( N < 0 ) { + throw new RangeError( format( 'invalid argument. Second argument must be a nonnegative integer. Value: `%d`.', N ) ); + } + if ( strideX === 0 ) { + throw new RangeError( format( 'invalid argument. Fifth argument must be non-zero. Value: `%d`.', strideX ) ); + } + if ( strideY === 0 ) { + throw new RangeError( format( 'invalid argument. Eighth argument must be non-zero. Value: `%d`.', strideY ) ); + } + // Check if we can early return... + if ( M === 0 || N === 0 || alpha === 0.0 ) { + return A; + } + addon.ndarray( M, N, alpha, x, strideX, offsetX, y, strideY, offsetY, A, strideA1, strideA2, offsetA ); // eslint-disable-line max-len return A; } diff --git a/lib/node_modules/@stdlib/blas/base/dger/manifest.json b/lib/node_modules/@stdlib/blas/base/dger/manifest.json index 7494358b4d85..1e7f47b3c13b 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/manifest.json +++ b/lib/node_modules/@stdlib/blas/base/dger/manifest.json @@ -35,7 +35,8 @@ "wasm": false, "src": [ "./src/dger.f", - "./src/dger_f.c" + "./src/dger_f.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -50,7 +51,9 @@ "@stdlib/napi/argv-int64", "@stdlib/napi/argv-int32", "@stdlib/napi/argv-strided-float64array", - "@stdlib/napi/argv-double" + "@stdlib/napi/argv-strided-float64array2d", + "@stdlib/napi/argv-double", + "@stdlib/ndarray/base/assert/is-row-major" ] }, { @@ -59,7 +62,8 @@ "blas": "", "wasm": false, "src": [ - "./src/dger.c" + "./src/dger.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -68,7 +72,9 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", - "@stdlib/blas/base/xerbla" + "@stdlib/blas/base/xerbla", + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/strided/base/stride2offset" ] }, { @@ -77,7 +83,8 @@ "blas": "", "wasm": false, "src": [ - "./src/dger.c" + "./src/dger.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -86,7 +93,9 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", - "@stdlib/blas/base/xerbla" + "@stdlib/blas/base/xerbla", + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/strided/base/stride2offset" ] }, @@ -96,7 +105,8 @@ "blas": "openblas", "wasm": false, "src": [ - "./src/dger_cblas.c" + "./src/dger_cblas.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -113,7 +123,9 @@ "@stdlib/napi/argv-int64", "@stdlib/napi/argv-int32", "@stdlib/napi/argv-strided-float64array", - "@stdlib/napi/argv-double" + "@stdlib/napi/argv-strided-float64array2d", + "@stdlib/napi/argv-double", + "@stdlib/ndarray/base/assert/is-row-major" ] }, { @@ -122,7 +134,8 @@ "blas": "openblas", "wasm": false, "src": [ - "./src/dger_cblas.c" + "./src/dger_cblas.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -133,7 +146,8 @@ ], "libpath": [], "dependencies": [ - "@stdlib/blas/base/shared" + "@stdlib/blas/base/shared", + "@stdlib/ndarray/base/assert/is-row-major" ] }, { @@ -142,7 +156,8 @@ "blas": "openblas", "wasm": false, "src": [ - "./src/dger_cblas.c" + "./src/dger_cblas.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -153,7 +168,8 @@ ], "libpath": [], "dependencies": [ - "@stdlib/blas/base/shared" + "@stdlib/blas/base/shared", + "@stdlib/ndarray/base/assert/is-row-major" ] }, @@ -164,7 +180,8 @@ "wasm": false, "src": [ "./src/dger.f", - "./src/dger_f.c" + "./src/dger_f.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -179,7 +196,9 @@ "@stdlib/napi/argv-int64", "@stdlib/napi/argv-int32", "@stdlib/napi/argv-strided-float64array", - "@stdlib/napi/argv-double" + "@stdlib/napi/argv-strided-float64array2d", + "@stdlib/napi/argv-double", + "@stdlib/ndarray/base/assert/is-row-major" ] }, { @@ -188,7 +207,8 @@ "blas": "", "wasm": false, "src": [ - "./src/dger.c" + "./src/dger.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -197,7 +217,9 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", - "@stdlib/blas/base/xerbla" + "@stdlib/blas/base/xerbla", + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/strided/base/stride2offset" ] }, { @@ -206,7 +228,8 @@ "blas": "", "wasm": false, "src": [ - "./src/dger.c" + "./src/dger.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -215,7 +238,9 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", - "@stdlib/blas/base/xerbla" + "@stdlib/blas/base/xerbla", + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/strided/base/stride2offset" ] }, @@ -225,7 +250,8 @@ "blas": "apple_accelerate_framework", "wasm": false, "src": [ - "./src/dger_cblas.c" + "./src/dger_cblas.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -241,7 +267,9 @@ "@stdlib/napi/argv-int64", "@stdlib/napi/argv-int32", "@stdlib/napi/argv-strided-float64array", - "@stdlib/napi/argv-double" + "@stdlib/napi/argv-strided-float64array2d", + "@stdlib/napi/argv-double", + "@stdlib/ndarray/base/assert/is-row-major" ] }, { @@ -250,7 +278,8 @@ "blas": "apple_accelerate_framework", "wasm": false, "src": [ - "./src/dger_cblas.c" + "./src/dger_cblas.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -260,7 +289,8 @@ ], "libpath": [], "dependencies": [ - "@stdlib/blas/base/shared" + "@stdlib/blas/base/shared", + "@stdlib/ndarray/base/assert/is-row-major" ] }, { @@ -269,7 +299,8 @@ "blas": "apple_accelerate_framework", "wasm": false, "src": [ - "./src/dger_cblas.c" + "./src/dger_cblas.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -279,7 +310,8 @@ ], "libpath": [], "dependencies": [ - "@stdlib/blas/base/shared" + "@stdlib/blas/base/shared", + "@stdlib/ndarray/base/assert/is-row-major" ] }, @@ -289,7 +321,8 @@ "blas": "openblas", "wasm": false, "src": [ - "./src/dger_cblas.c" + "./src/dger_cblas.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -306,7 +339,9 @@ "@stdlib/napi/argv-int64", "@stdlib/napi/argv-int32", "@stdlib/napi/argv-strided-float64array", - "@stdlib/napi/argv-double" + "@stdlib/napi/argv-strided-float64array2d", + "@stdlib/napi/argv-double", + "@stdlib/ndarray/base/assert/is-row-major" ] }, { @@ -315,7 +350,8 @@ "blas": "openblas", "wasm": false, "src": [ - "./src/dger_cblas.c" + "./src/dger_cblas.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -326,7 +362,8 @@ ], "libpath": [], "dependencies": [ - "@stdlib/blas/base/shared" + "@stdlib/blas/base/shared", + "@stdlib/ndarray/base/assert/is-row-major" ] }, { @@ -335,7 +372,8 @@ "blas": "openblas", "wasm": false, "src": [ - "./src/dger_cblas.c" + "./src/dger_cblas.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -346,7 +384,8 @@ ], "libpath": [], "dependencies": [ - "@stdlib/blas/base/shared" + "@stdlib/blas/base/shared", + "@stdlib/ndarray/base/assert/is-row-major" ] }, @@ -356,7 +395,8 @@ "blas": "", "wasm": false, "src": [ - "./src/dger.c" + "./src/dger.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -371,7 +411,10 @@ "@stdlib/napi/argv-int64", "@stdlib/napi/argv-int32", "@stdlib/napi/argv-strided-float64array", - "@stdlib/napi/argv-double" + "@stdlib/napi/argv-strided-float64array2d", + "@stdlib/napi/argv-double", + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/strided/base/stride2offset" ] }, { @@ -380,7 +423,8 @@ "blas": "", "wasm": false, "src": [ - "./src/dger.c" + "./src/dger.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -389,7 +433,9 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", - "@stdlib/blas/base/xerbla" + "@stdlib/blas/base/xerbla", + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/strided/base/stride2offset" ] }, { @@ -398,7 +444,8 @@ "blas": "", "wasm": false, "src": [ - "./src/dger.c" + "./src/dger.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -407,7 +454,9 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", - "@stdlib/blas/base/xerbla" + "@stdlib/blas/base/xerbla", + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/strided/base/stride2offset" ] }, @@ -417,7 +466,8 @@ "blas": "", "wasm": true, "src": [ - "./src/dger.c" + "./src/dger.c", + "./src/dger_ndarray.c" ], "include": [ "./include" @@ -426,7 +476,9 @@ "libpath": [], "dependencies": [ "@stdlib/blas/base/shared", - "@stdlib/blas/base/xerbla" + "@stdlib/blas/base/xerbla", + "@stdlib/ndarray/base/assert/is-row-major", + "@stdlib/strided/base/stride2offset" ] } ] diff --git a/lib/node_modules/@stdlib/blas/base/dger/package.json b/lib/node_modules/@stdlib/blas/base/dger/package.json index 62732f278dd4..541862fac43c 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/package.json +++ b/lib/node_modules/@stdlib/blas/base/dger/package.json @@ -1,7 +1,7 @@ { "name": "@stdlib/blas/base/dger", "version": "0.0.0", - "description": "Perform the rank 1 operation A = alpha⋅x⋅y^T + A.", + "description": "Perform the rank 1 operation A = α⋅x⋅y^T + A.", "license": "Apache-2.0", "author": { "name": "The Stdlib Authors", @@ -17,6 +17,8 @@ "browser": "./lib/main.js", "gypfile": true, "directories": { + "benchmark": "./benchmark", + "doc": "./docs", "example": "./examples", "include": "./include", "lib": "./lib", diff --git a/lib/node_modules/@stdlib/blas/base/dger/src/addon.c b/lib/node_modules/@stdlib/blas/base/dger/src/addon.c index 10b035c54414..a000fb01e1c6 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/src/addon.c +++ b/lib/node_modules/@stdlib/blas/base/dger/src/addon.c @@ -25,6 +25,7 @@ #include "stdlib/napi/argv_int32.h" #include "stdlib/napi/argv_double.h" #include "stdlib/napi/argv_strided_float64array.h" +#include "stdlib/napi/argv_strided_float64array2d.h" #include /** @@ -51,11 +52,46 @@ static napi_value addon( napi_env env, napi_callback_info info ) { STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, M, strideX, argv, 4 ); STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, Y, N, strideY, argv, 6 ); - STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, A, ((M-1)*LDA) + N, 1, argv, 8 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY2D( env, A, M, N, LDA, 1, argv, 8 ); API_SUFFIX(c_dger)( layout, M, N, alpha, X, strideX, Y, strideY, A, LDA ); return NULL; } -STDLIB_NAPI_MODULE_EXPORT_FCN( addon ) +/** +* 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, 13 ); + + STDLIB_NAPI_ARGV_INT64( env, M, argv, 0 ); + STDLIB_NAPI_ARGV_INT64( env, N, argv, 1 ); + + STDLIB_NAPI_ARGV_DOUBLE( env, alpha, argv, 2 ); + + STDLIB_NAPI_ARGV_INT64( env, strideX, argv, 4 ); + STDLIB_NAPI_ARGV_INT64( env, offsetX, argv, 5 ); + + STDLIB_NAPI_ARGV_INT64( env, strideY, argv, 7 ); + STDLIB_NAPI_ARGV_INT64( env, offsetY, argv, 8 ); + + STDLIB_NAPI_ARGV_INT64( env, strideA1, argv, 10 ); + STDLIB_NAPI_ARGV_INT64( env, strideA2, argv, 11 ); + STDLIB_NAPI_ARGV_INT64( env, offsetA, argv, 12 ); + + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, X, M, strideX, argv, 3 ); + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY( env, Y, N, strideY, argv, 6 ); + + STDLIB_NAPI_ARGV_STRIDED_FLOAT64ARRAY2D( env, A, M, N, strideA1, strideA2, argv, 9 ); + + API_SUFFIX(c_dger_ndarray)( M, N, alpha, X, strideX, offsetX, Y, strideY, offsetY, A, strideA1, strideA2, offsetA ); + + return NULL; +} + +STDLIB_NAPI_MODULE_EXPORT_FCN_WITH_METHOD( addon, "ndarray", addon_method ) diff --git a/lib/node_modules/@stdlib/blas/base/dger/src/dger.c b/lib/node_modules/@stdlib/blas/base/dger/src/dger.c index c96e481b7293..6c9e9a8251f3 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/src/dger.c +++ b/lib/node_modules/@stdlib/blas/base/dger/src/dger.c @@ -17,142 +17,81 @@ */ #include "stdlib/blas/base/dger.h" -#include "stdlib/blas/base/xerbla.h" #include "stdlib/blas/base/shared.h" +#include "stdlib/blas/base/xerbla.h" +#include "stdlib/strided/base/stride2offset.h" /** * Performs the rank 1 operation `A = alpha*x*y^T + A`, where `alpha` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M`-by-`N` matrix. * -* ## Notes -* -* - The function follows the CBLAS interface which reflects the corresponding Fortran interface, which in turn assumes column-major order. As a matrix stored in row-major order is equivalent to storing the matrix's transpose in column-major order, we can interpret an M-by-N row-major matrix "B" as the matrix "A^T" stored in column-major. In which case, we can derive an update equation for `B` as follows: -* -* ```tex -* \begin{align*} -* B &= A^T \\ -* &= (\alpha \bar{x} \bar{y}^T + A)^T \\ -* &= (\alpha \bar{x} \bar{y}^T)^T + A^T \\ -* &= \alpha (\bar{x} \bar{y}^T)^T + A^T \\ -* &= \alpha \bar{y} \bar{x}^T + A^T \\ -* &= \alpha \bar{y} \bar{x}^T + B -* \end{align*} -* ``` -* -* Accordingly, the C calling convention for row-major order is to swap the order of input arguments such that for a column-major `A` where the stride of the "major" (outer) dimension is `LDA = N` -* -* ```c -* c_dger( CblasColMajor, M, N, alpha, X, strideX, Y, strideY, A, N ) -* ``` -* -* and for a row-major `B = A^T` where the stride of the "major" (outer) dimension is `LDA = M` -* -* ```c -* c_dger( CblasRowMajor, N, M, alpha, Y, strideY, X, strideX, A^T, M ) -* ``` -* * @param layout storage layout * @param M number of rows in the matrix `A` * @param N number of columns in the matrix `A` * @param alpha scalar constant * @param X an `M` element vector -* @param strideX X stride length +* @param strideX stride length for `X` * @param Y an `N` element vector -* @param strideY Y stride length +* @param strideY stride length for `Y` * @param A matrix of coefficients * @param LDA stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) */ -void API_SUFFIX(c_dger)( const CBLAS_LAYOUT layout, const CBLAS_INT M, const CBLAS_INT N, const double alpha, double *X, const CBLAS_INT strideX, double *Y, const CBLAS_INT strideY, double *A, const CBLAS_INT LDA ) { - CBLAS_INT info; - CBLAS_INT sx; - CBLAS_INT sy; - CBLAS_INT ix; - CBLAS_INT jy; - CBLAS_INT kx; - CBLAS_INT i; - CBLAS_INT j; - CBLAS_INT m; - CBLAS_INT n; - double tmp; - double *x; - double *y; +void API_SUFFIX(c_dger)( const CBLAS_LAYOUT layout, const CBLAS_INT M, const CBLAS_INT N, const double alpha, const double *X, const CBLAS_INT strideX, const double *Y, const CBLAS_INT strideY, double *A, const CBLAS_INT LDA ) { + CBLAS_INT vala; + CBLAS_INT sa1; + CBLAS_INT sa2; + CBLAS_INT ox; + CBLAS_INT oy; + CBLAS_INT v; // Perform input argument validation... - info = 0; + if ( layout != CblasRowMajor && layout != CblasColMajor ) { + c_xerbla( 1, "c_dger", "Error: invalid argument. First argument must be a valid storage layout. Value: `%d`.", layout ); + return; + } if ( M < 0 ) { - info = 1; - } else if ( N < 0 ) { - info = 2; - } else if ( strideX == 0 ) { - info = 5; - } else if ( strideY == 0 ) { - info = 7; - } else { - if ( M < 1 ) { - j = 1; - } else { - j = M; - } - if ( LDA < j ) { - info = 9; - } + c_xerbla( 2, "c_dger", "Error: invalid argument. Second argument must be a nonnegative integer. Value: `%d`.", M ); + return; } - if ( info != 0 ) { - c_xerbla( info, "c_dger", "" ); + if ( N < 0 ) { + c_xerbla( 3, "c_dger", "Error: invalid argument. Third argument must be a nonnegative integer. Value: `%d`.", N ); return; } - // Check whether we can avoid computation altogether... - if ( M == 0 || N == 0 || alpha == 0.0 ) { + if ( strideX == 0 ) { + c_xerbla( 6, "c_dger", "Error: invalid argument. Sixth argument must be nonzero. Value: `%d`.", strideX ); + return; + } + if ( strideY == 0 ) { + c_xerbla( 8, "c_dger", "Error: invalid argument. Eighth argument must be nonzero. Value: `%d`.", strideX ); return; } - // When provided a row-major matrix, we need to swap arguments... - if ( layout == CblasRowMajor ) { - x = Y; - y = X; - m = N; - n = M; - sx = strideY; - sy = strideX; + if ( layout == CblasColMajor ) { + v = M; } else { - x = X; - y = Y; - m = M; - n = N; - sx = strideX; - sy = strideY; + v = N; } - // Proceed with computation... - if ( sy > 0 ) { - jy = 0; + // max(1, v) + if ( v < 1 ) { + vala = 1; } else { - jy = ( 1 - n ) * sy; + vala = v; } - if ( sx == 1 ) { - for ( j = 0; j < n; j++ ) { - if ( y[ jy ] != 0.0 ) { - tmp = alpha * y[ jy ]; - for ( i = 0; i < m; i++ ) { - A[ (j*LDA)+i ] += x[ i ] * tmp; // per above, x has unit stride - } - } - jy += sy; - } + if ( LDA < v ) { + c_xerbla( 10, "c_dger", "Error: invalid argument. Tenth argument must be greater than or equal to max(1,%d). Value: `%d`.", vala, LDA ); return; } - if ( sx > 0 ) { - kx = 0; - } else { - kx = ( 1 - m ) * sx; + // Check whether we can avoid computation altogether... + if ( M == 0 || N == 0 || alpha == 0.0 ) { + return; } - for ( j = 0; j < n; j++ ) { - if ( y[ jy ] != 0.0 ) { - tmp = alpha * y[ jy ]; - ix = kx; - for ( i = 0; i < m; i++ ) { - A[ (j*LDA)+i ] += x[ ix ] * tmp; - ix += sx; - } - } - jy += sy; + ox = stdlib_strided_stride2offset( N, strideX ); + oy = stdlib_strided_stride2offset( N, strideY ); + if ( layout == CblasColMajor ) { + sa1 = 1; + sa2 = LDA; + } else { // layout == CblasRowMajor + sa1 = LDA; + sa2 = 1; } + API_SUFFIX(c_dger_ndarray)( M, N, alpha, X, strideX, ox, Y, strideY, oy, A, sa1, sa2, 0 ); return; } diff --git a/lib/node_modules/@stdlib/blas/base/dger/src/dger.f b/lib/node_modules/@stdlib/blas/base/dger/src/dger.f index 0a56eb9da5c4..687dffb4b58f 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/src/dger.f +++ b/lib/node_modules/@stdlib/blas/base/dger/src/dger.f @@ -54,9 +54,9 @@ ! @param {integer} N - number of columns in the matrix `A` ! @param {double} alpha - scalar constant ! @param {Array} X - an `M` element vector -! @param {integer} strideX - `X` stride length +! @param {integer} strideX - stride length for `X` ! @param {Array} Y - an `N` element vector -! @param {integer} strideY - `Y` stride length +! @param {integer} strideY - stride length for `Y` ! @param {Array} A - matrix of coefficients ! @param {integer} LDA - stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) !< @@ -145,4 +145,4 @@ end subroutine xerbla end do end if return -end subroutine dger \ No newline at end of file +end subroutine dger diff --git a/lib/node_modules/@stdlib/blas/base/dger/src/dger_cblas.c b/lib/node_modules/@stdlib/blas/base/dger/src/dger_cblas.c index d2445a4ed309..0b0394609285 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/src/dger_cblas.c +++ b/lib/node_modules/@stdlib/blas/base/dger/src/dger_cblas.c @@ -28,9 +28,9 @@ * @param N number of columns in the matrix `A` * @param alpha scalar constant * @param X an `M` element vector -* @param strideX X stride length +* @param strideX stride length for `X` * @param Y an `N` element vector -* @param strideY Y stride length +* @param strideY stride length for `Y` * @param A matrix of coefficients * @param LDA index of the first dimension of `A` */ diff --git a/lib/node_modules/@stdlib/blas/base/dger/src/dger_f.c b/lib/node_modules/@stdlib/blas/base/dger/src/dger_f.c index 0be9e8b58350..96f95a4a86c7 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/src/dger_f.c +++ b/lib/node_modules/@stdlib/blas/base/dger/src/dger_f.c @@ -29,9 +29,9 @@ * @param N number of columns in the matrix `A` * @param alpha scalar constant * @param X an `M` element vector -* @param strideX X stride length +* @param strideX stride length for `X` * @param Y an `N` element vector -* @param strideY Y stride length +* @param strideY stride length for `Y` * @param A matrix of coefficients * @param LDA stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`) */ diff --git a/lib/node_modules/@stdlib/blas/base/dger/src/dger_ndarray.c b/lib/node_modules/@stdlib/blas/base/dger/src/dger_ndarray.c new file mode 100644 index 000000000000..daddc65a6544 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/src/dger_ndarray.c @@ -0,0 +1,199 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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/base/dger.h" +#include "stdlib/blas/base/shared.h" +#include "stdlib/blas/base/xerbla.h" +#include "stdlib/ndarray/base/assert/is_row_major.h" +#include + +/** +* Performs the rank 1 operation `A = alpha*x*y^T + A`, using alternative indexing semantics and where `alpha` is a scalar, `x` is an `M` element vector, `y` is an `N` element vector, and `A` is an `M`-by-`N` matrix. +* +* ## Notes +* +* - To help motivate the use of loop interchange below, we first recognize that a matrix stored in row-major order is equivalent to storing the matrix's transpose in column-major order. For example, consider the following 2-by-3 matrix `A` +* +* ```tex +* A = \begin{bmatrix} +* 1 & 2 & 3 \\ +* 4 & 5 & 6 +* \end{bmatrix} +* ``` +* +* When stored in a linear buffer in column-major order, `A` becomes +* +* ```text +* [ 1 4 2 5 3 6] +* ``` +* +* When stored in a linear buffer in row-major order, `A` becomes +* +* ```text +* [ 1 2 3 4 5 6] +* ``` +* +* Now consider the transpose of `A` +* +* ```tex +* A^T = \begin{bmatrix} +* 1 & 4 \\ +* 2 & 5 \\ +* 3 & 6 +* \end{bmatrix} +* ``` +* +* When the transpose is stored in a linear buffer in column-major order, the transpose becomes +* +* ```text +* [ 1 2 3 4 5 6 ] +* ``` +* +* Similarly, when stored in row-major order, the transpose becomes +* +* ```text +* [ 1 4 2 5 3 6 ] +* ``` +* +* As may be observed, `A` stored in column-major order is equivalent to storing the transpose of `A` in row-major order, and storing `A` in row-major order is equivalent to storing the transpose of `A` in column-major order, and vice versa. +* +* Hence, we can interpret an `M` by `N` row-major matrix `B` as the matrix `A^T` stored in column-major order. In which case, we can derive an update equation for `B` as follows: +* +* ```tex +* \begin{align*} +* B &= A^T \\ +* &= (\alpha \bar{x} \bar{y}^T + A)^T \\ +* &= (\alpha \bar{x} \bar{y}^T)^T + A^T \\ +* &= \alpha (\bar{x} \bar{y}^T)^T + A^T \\ +* &= \alpha \bar{y} \bar{x}^T + A^T \\ +* &= \alpha \bar{y} \bar{x}^T + B +* \end{align*} +* ``` +* +* Accordingly, we can reuse the same loop logic for column-major and row-major `A` by simply swapping `x` and `y` and `M` and `N` when `A` is row-major order. That is the essence of loop interchange. +* +* @param layout storage layout +* @param M number of rows in the matrix `A` +* @param N number of columns in the matrix `A` +* @param alpha scalar constant +* @param X an `M` element vector +* @param strideX stride length for `X` +* @param offsetX starting index for `X` +* @param Y an `N` element vector +* @param strideY stride length for `Y` +* @param offsetY starting index for `Y` +* @param A matrix of coefficients +* @param strideA1 stride length of the first dimnension of `A` +* @param strideA2 stride length of the second dimension of `A` +* @param offsetA starting index for `A` +*/ +void API_SUFFIX(c_dger_ndarray)( const CBLAS_INT M, const CBLAS_INT N, const double alpha, const double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX, const double *Y, const CBLAS_INT strideY, const CBLAS_INT offsetY, double *A, const CBLAS_INT strideA1, const CBLAS_INT strideA2, const CBLAS_INT offsetA ) { + const double *x; + const double *y; + int64_t sa[ 2 ]; + CBLAS_INT da0; + CBLAS_INT da1; + CBLAS_INT S0; + CBLAS_INT S1; + CBLAS_INT sx; + CBLAS_INT sy; + CBLAS_INT ox; + CBLAS_INT ia; + CBLAS_INT ix; + CBLAS_INT iy; + CBLAS_INT i0; + CBLAS_INT i1; + double tmp; + + // Note on variable naming convention: S#, da#, ia#, i# where # corresponds to the loop number, with `0` being the innermost loop... + + // Perform input argument validation... + if ( M < 0 ) { + c_xerbla( 1, "c_dger_ndarray", "Error: invalid argument. First argument must be a nonnegative integer. Value: `%d`.", M ); + return; + } + if ( N < 0 ) { + c_xerbla( 2, "c_dger_ndarray", "Error: invalid argument. Second argument must be a nonnegative integer. Value: `%d`.", N ); + return; + } + if ( strideX == 0 ) { + c_xerbla( 5, "c_dger_ndarray", "Error: invalid argument. Fifth argument must be a nonzero. Value: `%d`.", strideX ); + return; + } + if ( strideY == 0 ) { + c_xerbla( 8, "c_dger_ndarray", "Error: invalid argument. Eighth argument must be a nonzero. Value: `%d`.", strideY ); + return; + } + // Check whether we can avoid computation altogether... + if ( M == 0 || N == 0 || alpha == 0.0 ) { + return; + } + // Extract loop variables for purposes of loop interchange: dimensions and loop offset (pointer) increments... + sa[ 0 ] = strideA1; + sa[ 1 ] = strideA2; + if ( stdlib_ndarray_is_row_major( 2, sa ) ) { + // For row-major matrices, the last dimension has the fastest changing index... + S0 = N; + S1 = M; + da0 = strideA2; // offset increment for innermost loop + da1 = strideA1 - ( S0*strideA2 ); // offset increment for outermost loop + + // Swap the vectors... + x = Y; + y = X; + + sx = strideY; + sy = strideX; + + ox = offsetY; + iy = offsetX; + } else { // order === 'column-major' + // For column-major matrices, the first dimension has the fastest changing index... + S0 = M; + S1 = N; + da0 = strideA1; // offset increment for innermost loop + da1 = strideA2 - ( S0*strideA1 ); // offset increment for outermost loop + + x = X; + y = Y; + + sx = strideX; + sy = strideY; + + ox = offsetX; + iy = offsetY; + } + ia = offsetA; + for ( i1 = 0; i1 < S1; i1++ ) { + // Check whether we can avoid the inner loop entirely... + if ( y[ iy ] == 0.0 ) { + ia += da0 * S0; + } else { + tmp = alpha * y[ iy ]; + ix = ox; + for ( i0 = 0; i0 < S0; i0++ ) { + A[ ia ] += x[ ix ] * tmp; + ix += sx; + ia += da0; + } + } + iy += sy; + ia += da1; + } + return; +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major.json new file mode 100644 index 000000000000..277c350146f0 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major.json @@ -0,0 +1,22 @@ +{ + "order": "column-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 1.0 ], + "strideX": 1, + "offsetX": 0, + "y": [ 1.0, 1.0, 1.0 ], + "strideY": 1, + "offsetY": 0, + "A": [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 2, + "strideA1": 1, + "strideA2": 2, + "offsetA": 0, + "A_out": [ 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_complex_access_pattern.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_complex_access_pattern.json new file mode 100644 index 000000000000..220746be33c5 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_complex_access_pattern.json @@ -0,0 +1,21 @@ +{ + "order": "column-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 2.0, 0.0, 1.0, 0.0 ], + "strideX": -2, + "offsetX": 2, + "y": [ 3.0, 0.0, 2.0, 0.0, 1.0, 0.0 ], + "strideY": -2, + "offsetY": 4, + "A": [ 0.0, 0.0, 0.0, 0.0, 6.0, 0.0, 3.0, 0.0, 0.0, 0.0, 0.0, 0.0, 5.0, 0.0, 2.0, 0.0, 0.0, 0.0, 0.0, 0.0, 4.0, 0.0, 1.0, 0.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "strideA1": -2, + "strideA2": -8, + "offsetA": 22, + "A_out": [ 0.0, 0.0, 0.0, 0.0, 12.0, 0.0, 6.0, 0.0, 0.0, 0.0, 0.0, 0.0, 9.0, 0.0, 4.0, 0.0, 0.0, 0.0, 0.0, 0.0, 6.0, 0.0, 2.0, 0.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_oa.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_oa.json new file mode 100644 index 000000000000..fd257c7fba48 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_oa.json @@ -0,0 +1,21 @@ +{ + "order": "column-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 1.0, 0.0 ], + "strideX": 2, + "offsetX": 0, + "y": [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ], + "strideY": 2, + "offsetY": 0, + "A": [ 0.0, 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "strideA1": 1, + "strideA2": 2, + "offsetA": 1, + "A_out": [ 0.0, 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_ox.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_ox.json new file mode 100644 index 000000000000..ac3db51d9545 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_ox.json @@ -0,0 +1,22 @@ +{ + "order": "column-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 0.0, 0.0, 1.0, 1.0 ], + "strideX": 1, + "offsetX": 2, + "y": [ 1.0, 1.0, 1.0 ], + "strideY": 1, + "offsetY": 0, + "A": [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 2, + "strideA1": 1, + "strideA2": 2, + "offsetA": 0, + "A_out": [ 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_oy.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_oy.json new file mode 100644 index 000000000000..d11a7ca06684 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_oy.json @@ -0,0 +1,22 @@ +{ + "order": "column-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 1.0 ], + "strideX": 1, + "offsetX": 0, + "y": [ 0.0, 0.0, 1.0, 1.0, 1.0 ], + "strideY": 1, + "offsetY": 2, + "A": [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 2, + "strideA1": 1, + "strideA2": 2, + "offsetA": 0, + "A_out": [ 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_sa1_sa2.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_sa1_sa2.json new file mode 100644 index 000000000000..702e051e70b9 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_sa1_sa2.json @@ -0,0 +1,21 @@ +{ + "order": "column-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 2.0, 0.0 ], + "strideX": 2, + "offsetX": 0, + "y": [ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ], + "strideY": 2, + "offsetY": 0, + "A": [ 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 4.0, 0.0, 0.0, 0.0, 0.0, 0.0, 2.0, 0.0, 5.0, 0.0, 0.0, 0.0, 0.0, 0.0, 3.0, 0.0, 6.0, 0.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "strideA1": 2, + "strideA2": 8, + "offsetA": 4, + "A_out": [ 0.0, 0.0, 0.0, 0.0, 2.0, 0.0, 6.0, 0.0, 0.0, 0.0, 0.0, 0.0, 4.0, 0.0, 9.0, 0.0, 0.0, 0.0, 0.0, 0.0, 6.0, 0.0, 12.0, 0.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_sa1_sa2n.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_sa1_sa2n.json new file mode 100644 index 000000000000..f6b6b56f07a6 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_sa1_sa2n.json @@ -0,0 +1,21 @@ +{ + "order": "column-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 2.0, 0.0 ], + "strideX": 2, + "offsetX": 0, + "y": [ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ], + "strideY": 2, + "offsetY": 0, + "A": [ 0.0, 0.0, 0.0, 0.0, 3.0, 0.0, 6.0, 0.0, 0.0, 0.0, 0.0, 0.0, 2.0, 0.0, 5.0, 0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 4.0, 0.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "strideA1": 2, + "strideA2": -8, + "offsetA": 20, + "A_out": [ 0.0, 0.0, 0.0, 0.0, 6.0, 0.0, 12.0, 0.0, 0.0, 0.0, 0.0, 0.0, 4.0, 0.0, 9.0, 0.0, 0.0, 0.0, 0.0, 0.0, 2.0, 0.0, 6.0, 0.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_sa1n_sa2.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_sa1n_sa2.json new file mode 100644 index 000000000000..a4df499c44c5 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_sa1n_sa2.json @@ -0,0 +1,21 @@ +{ + "order": "column-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 2.0, 0.0 ], + "strideX": 2, + "offsetX": 0, + "y": [ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ], + "strideY": 2, + "offsetY": 0, + "A": [ 0.0, 0.0, 0.0, 0.0, 4.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 5.0, 0.0, 2.0, 0.0, 0.0, 0.0, 0.0, 0.0, 6.0, 0.0, 3.0, 0.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "strideA1": -2, + "strideA2": 8, + "offsetA": 6, + "A_out": [ 0.0, 0.0, 0.0, 0.0, 6.0, 0.0, 2.0, 0.0, 0.0, 0.0, 0.0, 0.0, 9.0, 0.0, 4.0, 0.0, 0.0, 0.0, 0.0, 0.0, 12.0, 0.0, 6.0, 0.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_sa1n_sa2n.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_sa1n_sa2n.json new file mode 100644 index 000000000000..9bbdcc5d25ff --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_sa1n_sa2n.json @@ -0,0 +1,21 @@ +{ + "order": "column-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 2.0, 0.0 ], + "strideX": 2, + "offsetX": 0, + "y": [ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ], + "strideY": 2, + "offsetY": 0, + "A": [ 0.0, 0.0, 0.0, 0.0, 6.0, 0.0, 3.0, 0.0, 0.0, 0.0, 0.0, 0.0, 5.0, 0.0, 2.0, 0.0, 0.0, 0.0, 0.0, 0.0, 4.0, 0.0, 1.0, 0.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "strideA1": -2, + "strideA2": -8, + "offsetA": 22, + "A_out": [ 0.0, 0.0, 0.0, 0.0, 12.0, 0.0, 6.0, 0.0, 0.0, 0.0, 0.0, 0.0, 9.0, 0.0, 4.0, 0.0, 0.0, 0.0, 0.0, 0.0, 6.0, 0.0, 2.0, 0.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_x_zeros.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_x_zeros.json new file mode 100644 index 000000000000..7b48b4908fde --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_x_zeros.json @@ -0,0 +1,22 @@ +{ + "order": "column-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 0.0, 0.0 ], + "strideX": 1, + "offsetX": 0, + "y": [ 1.0, 1.0, 1.0 ], + "strideY": 1, + "offsetY": 0, + "A": [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 2, + "strideA1": 1, + "strideA2": 2, + "offsetA": 0, + "A_out": [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_xnyn.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_xnyn.json new file mode 100644 index 000000000000..df5d1cf78f43 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_xnyn.json @@ -0,0 +1,22 @@ +{ + "order": "column-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 1.0, 0.0 ], + "strideX": -2, + "offsetX": 2, + "y": [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ], + "strideY": -2, + "offsetY": 4, + "A": [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 2, + "strideA1": 1, + "strideA2": 2, + "offsetA": 0, + "A_out": [ 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_xnyp.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_xnyp.json new file mode 100644 index 000000000000..33979ab2d0af --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_xnyp.json @@ -0,0 +1,22 @@ +{ + "order": "column-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 1.0, 0.0 ], + "strideX": -2, + "offsetX": 2, + "y": [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ], + "strideY": 2, + "offsetY": 0, + "A": [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 2, + "strideA1": 1, + "strideA2": 2, + "offsetA": 0, + "A_out": [ 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_xpyn.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_xpyn.json new file mode 100644 index 000000000000..96cb5e88b6c9 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_xpyn.json @@ -0,0 +1,22 @@ +{ + "order": "column-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 1.0, 0.0 ], + "strideX": 2, + "offsetX": 0, + "y": [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ], + "strideY": -2, + "offsetY": 4, + "A": [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 2, + "strideA1": 1, + "strideA2": 2, + "offsetA": 0, + "A_out": [ 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_xpyp.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_xpyp.json new file mode 100644 index 000000000000..33fbd18fdb62 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_xpyp.json @@ -0,0 +1,22 @@ +{ + "order": "column-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 1.0, 0.0 ], + "strideX": 2, + "offsetX": 0, + "y": [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ], + "strideY": 2, + "offsetY": 0, + "A": [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 2, + "strideA1": 1, + "strideA2": 2, + "offsetA": 0, + "A_out": [ 2.0, 5.0, 3.0, 6.0, 4.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_y_zeros.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_y_zeros.json new file mode 100644 index 000000000000..3f7881dd3860 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/column_major_y_zeros.json @@ -0,0 +1,22 @@ +{ + "order": "column-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 1.0 ], + "strideX": 1, + "offsetX": 0, + "y": [ 0.0, 0.0, 0.0 ], + "strideY": 1, + "offsetY": 0, + "A": [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 2, + "strideA1": 1, + "strideA2": 2, + "offsetA": 0, + "A_out": [ 1.0, 4.0, 2.0, 5.0, 3.0, 6.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major.json new file mode 100644 index 000000000000..2ab84ca7d4d3 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major.json @@ -0,0 +1,22 @@ +{ + "order": "row-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 1.0 ], + "strideX": 1, + "offsetX": 0, + "y": [ 1.0, 1.0, 1.0 ], + "strideY": 1, + "offsetY": 0, + "A": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 3, + "strideA1": 3, + "strideA2": 1, + "offsetA": 0, + "A_out": [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_complex_access_pattern.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_complex_access_pattern.json new file mode 100644 index 000000000000..545a9ac46edc --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_complex_access_pattern.json @@ -0,0 +1,21 @@ +{ + "order": "row-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 2.0, 0.0, 1.0, 0.0 ], + "strideX": -2, + "offsetX": 2, + "y": [ 3.0, 0.0, 2.0, 0.0, 1.0, 0.0 ], + "strideY": -2, + "offsetY": 4, + "A": [ 0.0, 6.0, 0.0, 5.0, 0.0, 4.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 3.0, 0.0, 2.0, 0.0, 1.0, 0.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "strideA1": -14, + "strideA2": -2, + "offsetA": 19, + "A_out": [ 0.0, 12.0, 0.0, 9.0, 0.0, 6.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 6.0, 0.0, 4.0, 0.0, 2.0, 0.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_oa.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_oa.json new file mode 100644 index 000000000000..e85a1ca258c6 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_oa.json @@ -0,0 +1,21 @@ +{ + "order": "row-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 1.0, 0.0 ], + "strideX": 2, + "offsetX": 0, + "y": [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ], + "strideY": 2, + "offsetY": 0, + "A": [ 0.0, 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "strideA1": 3, + "strideA2": 1, + "offsetA": 1, + "A_out": [ 0.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_ox.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_ox.json new file mode 100644 index 000000000000..776f9aadfadb --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_ox.json @@ -0,0 +1,22 @@ +{ + "order": "row-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 0.0, 0.0, 1.0, 1.0 ], + "strideX": 1, + "offsetX": 2, + "y": [ 1.0, 1.0, 1.0 ], + "strideY": 1, + "offsetY": 0, + "A": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 3, + "strideA1": 3, + "strideA2": 1, + "offsetA": 0, + "A_out": [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_oy.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_oy.json new file mode 100644 index 000000000000..c95e6b470f60 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_oy.json @@ -0,0 +1,22 @@ +{ + "order": "row-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 1.0 ], + "strideX": 1, + "offsetX": 0, + "y": [ 0.0, 0.0, 1.0, 1.0, 1.0 ], + "strideY": 1, + "offsetY": 2, + "A": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 3, + "strideA1": 3, + "strideA2": 1, + "offsetA": 0, + "A_out": [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_sa1_sa2.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_sa1_sa2.json new file mode 100644 index 000000000000..b48f82809b26 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_sa1_sa2.json @@ -0,0 +1,21 @@ +{ + "order": "row-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 2.0, 0.0 ], + "strideX": 2, + "offsetX": 0, + "y": [ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ], + "strideY": 2, + "offsetY": 0, + "A": [ 0.0, 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 4.0, 0.0, 5.0, 0.0, 6.0, 0.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "strideA1": 14, + "strideA2": 2, + "offsetA": 1, + "A_out": [ 0.0, 2.0, 0.0, 4.0, 0.0, 6.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 6.0, 0.0, 9.0, 0.0, 12.0, 0.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_sa1_sa2n.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_sa1_sa2n.json new file mode 100644 index 000000000000..37ad4b28b117 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_sa1_sa2n.json @@ -0,0 +1,57 @@ +{ + "order": "row-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 2.0, 0.0 ], + "strideX": 2, + "offsetX": 0, + "y": [ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ], + "strideY": 2, + "offsetY": 0, + "A": [ + 999.0, + 999.0, + 3.0, + 999.0, + 2.0, + 999.0, + 1.0, + 999.0, + 999.0, + 999.0, + 6.0, + 999.0, + 5.0, + 999.0, + 4.0, + 999.0, + 999.0 + ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "strideA1": 8, + "strideA2": -2, + "offsetA": 6, + "A_out": [ + 999.0, + 999.0, + 6.0, + 999.0, + 4.0, + 999.0, + 2.0, + 999.0, + 999.0, + 999.0, + 12.0, + 999.0, + 9.0, + 999.0, + 6.0, + 999.0, + 999.0 + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_sa1n_sa2.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_sa1n_sa2.json new file mode 100644 index 000000000000..5feaa8e8f17b --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_sa1n_sa2.json @@ -0,0 +1,61 @@ +{ + "order": "row-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 2.0, 0.0 ], + "strideX": 2, + "offsetX": 0, + "y": [ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ], + "strideY": 2, + "offsetY": 0, + "A": [ + 999.0, + 999.0, + 4.0, + 999.0, + 999.0, + 5.0, + 999.0, + 999.0, + 6.0, + 999.0, + 1.0, + 999.0, + 999.0, + 2.0, + 999.0, + 999.0, + 3.0, + 999.0, + 999.0 + ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "strideA1": -8, + "strideA2": 3, + "offsetA": 10, + "A_out": [ + 999.0, + 999.0, + 6.0, + 999.0, + 999.0, + 9.0, + 999.0, + 999.0, + 12.0, + 999.0, + 2.0, + 999.0, + 999.0, + 4.0, + 999.0, + 999.0, + 6.0, + 999.0, + 999.0 + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_sa1n_sa2n.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_sa1n_sa2n.json new file mode 100644 index 000000000000..e989a4189495 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_sa1n_sa2n.json @@ -0,0 +1,57 @@ +{ + "order": "row-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 2.0, 0.0 ], + "strideX": 2, + "offsetX": 0, + "y": [ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ], + "strideY": 2, + "offsetY": 0, + "A": [ + 999.0, + 999.0, + 6.0, + 999.0, + 5.0, + 999.0, + 4.0, + 999.0, + 999.0, + 999.0, + 3.0, + 999.0, + 2.0, + 999.0, + 1.0, + 999.0, + 999.0 + ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "strideA1": -8, + "strideA2": -2, + "offsetA": 14, + "A_out": [ + 999.0, + 999.0, + 12.0, + 999.0, + 9.0, + 999.0, + 6.0, + 999.0, + 999.0, + 999.0, + 6.0, + 999.0, + 4.0, + 999.0, + 2.0, + 999.0, + 999.0 + ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_x_zeros.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_x_zeros.json new file mode 100644 index 000000000000..e677e3e2b655 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_x_zeros.json @@ -0,0 +1,22 @@ +{ + "order": "row-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 0.0, 0.0 ], + "strideX": 1, + "offsetX": 0, + "y": [ 1.0, 1.0, 1.0 ], + "strideY": 1, + "offsetY": 0, + "A": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 3, + "strideA1": 3, + "strideA2": 1, + "offsetA": 0, + "A_out": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_xnyn.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_xnyn.json new file mode 100644 index 000000000000..f158f9dc7d90 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_xnyn.json @@ -0,0 +1,22 @@ +{ + "order": "row-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 1.0, 0.0 ], + "strideX": -2, + "offsetX": 2, + "y": [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ], + "strideY": -2, + "offsetY": 4, + "A": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 3, + "strideA1": 3, + "strideA2": 1, + "offsetA": 0, + "A_out": [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_xnyp.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_xnyp.json new file mode 100644 index 000000000000..7fb10bf73ee5 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_xnyp.json @@ -0,0 +1,22 @@ +{ + "order": "row-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 1.0, 0.0 ], + "strideX": -2, + "offsetX": 2, + "y": [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ], + "strideY": 2, + "offsetY": 0, + "A": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 3, + "strideA1": 3, + "strideA2": 1, + "offsetA": 0, + "A_out": [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_xpyn.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_xpyn.json new file mode 100644 index 000000000000..66a5aedb4406 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_xpyn.json @@ -0,0 +1,22 @@ +{ + "order": "row-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 1.0, 0.0 ], + "strideX": 2, + "offsetX": 0, + "y": [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ], + "strideY": -2, + "offsetY": 4, + "A": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 3, + "strideA1": 3, + "strideA2": 1, + "offsetA": 0, + "A_out": [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_xpyp.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_xpyp.json new file mode 100644 index 000000000000..43f67e9fb316 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_xpyp.json @@ -0,0 +1,22 @@ +{ + "order": "row-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 0.0, 1.0, 0.0 ], + "strideX": 2, + "offsetX": 0, + "y": [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ], + "strideY": 2, + "offsetY": 0, + "A": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 3, + "strideA1": 3, + "strideA2": 1, + "offsetA": 0, + "A_out": [ 2.0, 3.0, 4.0, 5.0, 6.0, 7.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_y_zeros.json b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_y_zeros.json new file mode 100644 index 000000000000..3aadc0dd60ca --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/fixtures/row_major_y_zeros.json @@ -0,0 +1,22 @@ +{ + "order": "row-major", + "M": 2, + "N": 3, + "alpha": 1.0, + "x": [ 1.0, 1.0 ], + "strideX": 1, + "offsetX": 0, + "y": [ 0.0, 0.0, 0.0 ], + "strideY": 1, + "offsetY": 0, + "A": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ], + "A_mat": [ + [ 1.0, 2.0, 3.0 ], + [ 4.0, 5.0, 6.0 ] + ], + "lda": 3, + "strideA1": 3, + "strideA2": 1, + "offsetA": 0, + "A_out": [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] +} diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/test.dger.js b/lib/node_modules/@stdlib/blas/base/dger/test/test.dger.js new file mode 100644 index 000000000000..9a6d9d88635f --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/test.dger.js @@ -0,0 +1,653 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +/* eslint-disable max-len */ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var dger = require( './../lib/dger.js' ); + + +// FIXTURES // + +var cm = require( './fixtures/column_major.json' ); +var cxpyp = require( './fixtures/column_major_xpyp.json' ); +var cxnyp = require( './fixtures/column_major_xnyp.json' ); +var cxpyn = require( './fixtures/column_major_xpyn.json' ); +var cxnyn = require( './fixtures/column_major_xnyn.json' ); +var cx0 = require( './fixtures/column_major_x_zeros.json' ); +var cy0 = require( './fixtures/column_major_y_zeros.json' ); + +var rm = require( './fixtures/row_major.json' ); +var rxpyp = require( './fixtures/row_major_xpyp.json' ); +var rxnyp = require( './fixtures/row_major_xnyp.json' ); +var rxpyn = require( './fixtures/row_major_xpyn.json' ); +var rxnyn = require( './fixtures/row_major_xnyn.json' ); +var rx0 = require( './fixtures/row_major_x_zeros.json' ); +var ry0 = require( './fixtures/row_major_y_zeros.json' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dger, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 10', function test( t ) { + t.strictEqual( dger.length, 10, 'returns expected value' ); + t.end(); +}); + +tape( 'the function throws an error if provided an invalid first argument', function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + 'foo', + 'bar', + 'beep', + 'boop' + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( value, data.M, data.N, data.alpha, new Float64Array( data.x ), data.strideX, new Float64Array( data.y ), data.strideY, new Float64Array( data.A ), data.LDA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid second argument', function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + -1, + -2, + -3 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.order, value, data.N, data.alpha, new Float64Array( data.x ), data.strideX, new Float64Array( data.y ), data.strideY, new Float64Array( data.A ), data.LDA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid third argument', function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + -1, + -2, + -3 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.order, data.M, value, data.alpha, new Float64Array( data.x ), data.strideX, new Float64Array( data.y ), data.strideY, new Float64Array( data.A ), data.LDA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid sixth argument', function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + 0 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.order, data.M, data.N, data.alpha, new Float64Array( data.x ), value, new Float64Array( data.y ), data.strideY, new Float64Array( data.A ), data.LDA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid eighth argument', function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + 0 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.order, data.M, data.N, data.alpha, new Float64Array( data.x ), data.strideX, new Float64Array( data.y ), value, new Float64Array( data.A ), data.LDA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid tenth argument', function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + -3, + -2, + -1, + 0, + 1 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.order, data.M, data.N, data.alpha, new Float64Array( data.x ), data.strideX, new Float64Array( data.y ), data.strideY, new Float64Array( data.A ), value ); + }; + } +}); + +tape( 'the function the rank 1 operation `A = α*x*y^T + A` (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function the rank 1 operation `A = α*x*y^T + A` (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns a reference to the input matrix (row-major)', function test( t ) { + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns a reference to the input matrix (column-major)', function test( t ) { + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.end(); +}); + +tape( 'if either `M` or `N` is `0`, the function returns the input matrix unchanged (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( data.order, 0, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + out = dger( data.order, data.M, 0, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if either `M` or `N` is `0`, the function returns the input matrix unchanged (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( data.order, 0, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + out = dger( data.order, data.M, 0, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `α` is `0.0`, the function returns the input matrix unchanged (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( data.order, data.M, data.N, 0.0, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `α` is `0.0`, the function returns the input matrix unchanged (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( data.order, data.M, data.N, 0.0, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `x` contains only zeros, the function returns the input matrix unchanged (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rx0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if `x` contains only zeros, the function returns the input matrix unchanged (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cx0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if `y` contains only zeros, the function returns the input matrix unchanged (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = ry0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if `y` contains only zeros, the function returns the input matrix unchanged (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cy0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying `x` and `y` strides (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxpyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying `x` and `y` strides (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxpyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `x` stride (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxnyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `x` stride (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxnyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `y` stride (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxpyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `y` stride (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxpyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxnyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxnyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/test.dger.native.js b/lib/node_modules/@stdlib/blas/base/dger/test/test.dger.native.js new file mode 100644 index 000000000000..239d64c91413 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/test.dger.native.js @@ -0,0 +1,662 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +/* eslint-disable max-len */ + +'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 dger = tryRequire( resolve( __dirname, './../lib/dger.native.js' ) ); +var opts = { + 'skip': ( dger instanceof Error ) +}; + + +// FIXTURES // + +var cm = require( './fixtures/column_major.json' ); +var cxpyp = require( './fixtures/column_major_xpyp.json' ); +var cxnyp = require( './fixtures/column_major_xnyp.json' ); +var cxpyn = require( './fixtures/column_major_xpyn.json' ); +var cxnyn = require( './fixtures/column_major_xnyn.json' ); +var cx0 = require( './fixtures/column_major_x_zeros.json' ); +var cy0 = require( './fixtures/column_major_y_zeros.json' ); + +var rm = require( './fixtures/row_major.json' ); +var rxpyp = require( './fixtures/row_major_xpyp.json' ); +var rxnyp = require( './fixtures/row_major_xnyp.json' ); +var rxpyn = require( './fixtures/row_major_xpyn.json' ); +var rxnyn = require( './fixtures/row_major_xnyn.json' ); +var rx0 = require( './fixtures/row_major_x_zeros.json' ); +var ry0 = require( './fixtures/row_major_y_zeros.json' ); + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dger, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 10', opts, function test( t ) { + t.strictEqual( dger.length, 10, 'returns expected value' ); + t.end(); +}); + +tape( 'the function throws an error if provided an invalid first argument', opts, function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + 'foo', + 'bar', + 'beep', + 'boop' + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), TypeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( value, data.M, data.N, data.alpha, new Float64Array( data.x ), data.strideX, new Float64Array( data.y ), data.strideY, new Float64Array( data.A ), data.LDA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid second argument', opts, function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + -1, + -2, + -3 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.order, value, data.N, data.alpha, new Float64Array( data.x ), data.strideX, new Float64Array( data.y ), data.strideY, new Float64Array( data.A ), data.LDA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid third argument', opts, function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + -1, + -2, + -3 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.order, data.M, value, data.alpha, new Float64Array( data.x ), data.strideX, new Float64Array( data.y ), data.strideY, new Float64Array( data.A ), data.LDA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid sixth argument', opts, function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + 0 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.order, data.M, data.N, data.alpha, new Float64Array( data.x ), value, new Float64Array( data.y ), data.strideY, new Float64Array( data.A ), data.LDA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid eighth argument', opts, function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + 0 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.order, data.M, data.N, data.alpha, new Float64Array( data.x ), data.strideX, new Float64Array( data.y ), value, new Float64Array( data.A ), data.LDA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid tenth argument', opts, function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + -3, + -2, + -1, + 0, + 1 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.order, data.M, data.N, data.alpha, new Float64Array( data.x ), data.strideX, new Float64Array( data.y ), data.strideY, new Float64Array( data.A ), value ); + }; + } +}); + +tape( 'the function the rank 1 operation `A = α*x*y^T + A` (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function the rank 1 operation `A = α*x*y^T + A` (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns a reference to the input matrix (row-major)', opts, function test( t ) { + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns a reference to the input matrix (column-major)', opts, function test( t ) { + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.end(); +}); + +tape( 'if either `M` or `N` is `0`, the function returns the input matrix unchanged (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( data.order, 0, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + out = dger( data.order, data.M, 0, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if either `M` or `N` is `0`, the function returns the input matrix unchanged (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( data.order, 0, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + out = dger( data.order, data.M, 0, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `α` is `0.0`, the function returns the input matrix unchanged (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( data.order, data.M, data.N, 0.0, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `α` is `0.0`, the function returns the input matrix unchanged (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( data.order, data.M, data.N, 0.0, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `x` contains only zeros, the function returns the input matrix unchanged (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rx0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if `x` contains only zeros, the function returns the input matrix unchanged (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cx0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if `y` contains only zeros, the function returns the input matrix unchanged (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = ry0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if `y` contains only zeros, the function returns the input matrix unchanged (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cy0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying `x` and `y` strides (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxpyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying `x` and `y` strides (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxpyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `x` stride (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxnyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `x` stride (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxnyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `y` stride (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxpyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `y` stride (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxpyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxnyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxnyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.order, data.M, data.N, data.alpha, x, data.strideX, y, data.strideY, a, data.lda ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/test.js b/lib/node_modules/@stdlib/blas/base/dger/test/test.js index eb3153fe3685..d1a424ff92d7 100644 --- a/lib/node_modules/@stdlib/blas/base/dger/test/test.js +++ b/lib/node_modules/@stdlib/blas/base/dger/test/test.js @@ -22,14 +22,14 @@ var tape = require( 'tape' ); var proxyquire = require( 'proxyquire' ); -var isBrowser = require( '@stdlib/assert/is-browser' ); +var IS_BROWSER = require( '@stdlib/assert/is-browser' ); var dger = require( './../lib' ); // VARIABLES // var opts = { - 'skip': isBrowser + 'skip': IS_BROWSER }; diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/test.ndarray.js b/lib/node_modules/@stdlib/blas/base/dger/test/test.ndarray.js new file mode 100644 index 000000000000..744fca0da1de --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/test.ndarray.js @@ -0,0 +1,968 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +/* eslint-disable max-len */ + +'use strict'; + +// MODULES // + +var tape = require( 'tape' ); +var Float64Array = require( '@stdlib/array/float64' ); +var dger = require( './../lib/ndarray.js' ); + + +// FIXTURES // + +var cm = require( './fixtures/column_major.json' ); +var coa = require( './fixtures/column_major_oa.json' ); +var cox = require( './fixtures/column_major_ox.json' ); +var coy = require( './fixtures/column_major_oy.json' ); +var cxpyp = require( './fixtures/column_major_xpyp.json' ); +var cxnyp = require( './fixtures/column_major_xnyp.json' ); +var cxpyn = require( './fixtures/column_major_xpyn.json' ); +var cxnyn = require( './fixtures/column_major_xnyn.json' ); +var csa1sa2 = require( './fixtures/column_major_sa1_sa2.json' ); +var csa1nsa2 = require( './fixtures/column_major_sa1n_sa2.json' ); +var csa1sa2n = require( './fixtures/column_major_sa1_sa2n.json' ); +var csa1nsa2n = require( './fixtures/column_major_sa1n_sa2n.json' ); +var ccap = require( './fixtures/column_major_complex_access_pattern.json' ); +var cx0 = require( './fixtures/column_major_x_zeros.json' ); +var cy0 = require( './fixtures/column_major_y_zeros.json' ); + +var rm = require( './fixtures/row_major.json' ); +var roa = require( './fixtures/row_major_oa.json' ); +var rox = require( './fixtures/row_major_ox.json' ); +var roy = require( './fixtures/row_major_oy.json' ); +var rxpyp = require( './fixtures/row_major_xpyp.json' ); +var rxnyp = require( './fixtures/row_major_xnyp.json' ); +var rxpyn = require( './fixtures/row_major_xpyn.json' ); +var rxnyn = require( './fixtures/row_major_xnyn.json' ); +var rsa1sa2 = require( './fixtures/row_major_sa1_sa2.json' ); +var rsa1nsa2 = require( './fixtures/row_major_sa1n_sa2.json' ); +var rsa1sa2n = require( './fixtures/row_major_sa1_sa2n.json' ); +var rsa1nsa2n = require( './fixtures/row_major_sa1n_sa2n.json' ); +var rcap = require( './fixtures/row_major_complex_access_pattern.json' ); +var rx0 = require( './fixtures/row_major_x_zeros.json' ); +var ry0 = require( './fixtures/row_major_y_zeros.json' ); + + +// TESTS // + +tape( 'main export is a function', function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dger, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 13', function test( t ) { + t.strictEqual( dger.length, 13, 'returns expected value' ); + t.end(); +}); + +tape( 'the function throws an error if provided an invalid first argument', function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + -1, + -2, + -3 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( value, data.N, data.alpha, new Float64Array( data.x ), data.strideX, data.offsetX, new Float64Array( data.y ), data.strideY, data.offsetY, new Float64Array( data.A ), data.strideA1, data.strideA2, data.offsetA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid second argument', function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + -1, + -2, + -3 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.M, value, data.alpha, new Float64Array( data.x ), data.strideX, data.offsetX, new Float64Array( data.y ), data.strideY, data.offsetY, new Float64Array( data.A ), data.strideA1, data.strideA2, data.offsetA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid fifth argument', function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + 0 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.M, data.N, data.alpha, new Float64Array( data.x ), value, data.offsetX, new Float64Array( data.y ), data.strideY, data.offsetY, new Float64Array( data.A ), data.strideA1, data.strideA2, data.offsetA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid eighth argument', function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + 0 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.M, data.N, data.alpha, new Float64Array( data.x ), data.strideX, data.offsetX, new Float64Array( data.y ), value, data.offsetY, new Float64Array( data.A ), data.strideA1, data.strideA2, data.offsetA ); + }; + } +}); + +tape( 'the function the rank 1 operation `A = α*x*y^T + A` (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function the rank 1 operation `A = α*x*y^T + A` (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns a reference to the input matrix (row-major)', function test( t ) { + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns a reference to the input matrix (column-major)', function test( t ) { + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.end(); +}); + +tape( 'if either `M` or `N` is `0`, the function returns the input matrix unchanged (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( 0, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + out = dger( data.M, 0, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if either `M` or `N` is `0`, the function returns the input matrix unchanged (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( 0, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + out = dger( data.M, 0, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `α` is `0.0`, the function returns the input matrix unchanged (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( data.M, data.N, 0.0, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `α` is `0.0`, the function returns the input matrix unchanged (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( data.M, data.N, 0.0, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `x` contains only zeros, the function returns the input matrix unchanged (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rx0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if `x` contains only zeros, the function returns the input matrix unchanged (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cx0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if `y` contains only zeros, the function returns the input matrix unchanged (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = ry0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if `y` contains only zeros, the function returns the input matrix unchanged (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cy0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying the strides of the first and second dimensions of `A` (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rsa1sa2; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying the strides of the first and second dimensions of `A` (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = csa1sa2; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative stride for the first dimension of `A` (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rsa1nsa2; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative stride for the first dimension of `A` (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = csa1nsa2; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative stride for the second dimension of `A` (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rsa1sa2n; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative stride for the second dimension of `A` (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = csa1sa2n; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative strides for `A` (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rsa1nsa2n; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative strides for `A` (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = csa1nsa2n; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying an offset parameter for `A` (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = roa; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying an offset parameter for `A` (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = coa; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying `x` and `y` strides (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxpyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying `x` and `y` strides (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxpyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `x` stride (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxnyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `x` stride (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxnyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `y` stride (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxpyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `y` stride (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxpyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying negative strides for `x` and `y` (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxnyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying negative strides for `x` and `y` (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxnyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying an offset parameter for `x` (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rox; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying an offset parameter for `x` (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cox; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying an offset parameter for `y` (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = roy; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying an offset parameter for `y` (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = coy; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns (row-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rcap; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns (column-major)', function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = ccap; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); diff --git a/lib/node_modules/@stdlib/blas/base/dger/test/test.ndarray.native.js b/lib/node_modules/@stdlib/blas/base/dger/test/test.ndarray.native.js new file mode 100644 index 000000000000..d9720c66bca7 --- /dev/null +++ b/lib/node_modules/@stdlib/blas/base/dger/test/test.ndarray.native.js @@ -0,0 +1,977 @@ +/** +* @license Apache-2.0 +* +* Copyright (c) 2025 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. +*/ + +/* eslint-disable max-len */ + +'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 dger = tryRequire( resolve( __dirname, './../lib/ndarray.native.js' ) ); +var opts = { + 'skip': ( dger instanceof Error ) +}; + + +// FIXTURES // + +var cm = require( './fixtures/column_major.json' ); +var coa = require( './fixtures/column_major_oa.json' ); +var cox = require( './fixtures/column_major_ox.json' ); +var coy = require( './fixtures/column_major_oy.json' ); +var cxpyp = require( './fixtures/column_major_xpyp.json' ); +var cxnyp = require( './fixtures/column_major_xnyp.json' ); +var cxpyn = require( './fixtures/column_major_xpyn.json' ); +var cxnyn = require( './fixtures/column_major_xnyn.json' ); +var csa1sa2 = require( './fixtures/column_major_sa1_sa2.json' ); +var csa1nsa2 = require( './fixtures/column_major_sa1n_sa2.json' ); +var csa1sa2n = require( './fixtures/column_major_sa1_sa2n.json' ); +var csa1nsa2n = require( './fixtures/column_major_sa1n_sa2n.json' ); +var ccap = require( './fixtures/column_major_complex_access_pattern.json' ); +var cx0 = require( './fixtures/column_major_x_zeros.json' ); +var cy0 = require( './fixtures/column_major_y_zeros.json' ); + +var rm = require( './fixtures/row_major.json' ); +var roa = require( './fixtures/row_major_oa.json' ); +var rox = require( './fixtures/row_major_ox.json' ); +var roy = require( './fixtures/row_major_oy.json' ); +var rxpyp = require( './fixtures/row_major_xpyp.json' ); +var rxnyp = require( './fixtures/row_major_xnyp.json' ); +var rxpyn = require( './fixtures/row_major_xpyn.json' ); +var rxnyn = require( './fixtures/row_major_xnyn.json' ); +var rsa1sa2 = require( './fixtures/row_major_sa1_sa2.json' ); +var rsa1nsa2 = require( './fixtures/row_major_sa1n_sa2.json' ); +var rsa1sa2n = require( './fixtures/row_major_sa1_sa2n.json' ); +var rsa1nsa2n = require( './fixtures/row_major_sa1n_sa2n.json' ); +var rcap = require( './fixtures/row_major_complex_access_pattern.json' ); +var rx0 = require( './fixtures/row_major_x_zeros.json' ); +var ry0 = require( './fixtures/row_major_y_zeros.json' ); + + +// TESTS // + +tape( 'main export is a function', opts, function test( t ) { + t.ok( true, __filename ); + t.strictEqual( typeof dger, 'function', 'main export is a function' ); + t.end(); +}); + +tape( 'the function has an arity of 13', opts, function test( t ) { + t.strictEqual( dger.length, 13, 'returns expected value' ); + t.end(); +}); + +tape( 'the function throws an error if provided an invalid first argument', opts, function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + -1, + -2, + -3 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( value, data.N, data.alpha, new Float64Array( data.x ), data.strideX, data.offsetX, new Float64Array( data.y ), data.strideY, data.offsetY, new Float64Array( data.A ), data.strideA1, data.strideA2, data.offsetA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid second argument', opts, function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + -1, + -2, + -3 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.M, value, data.alpha, new Float64Array( data.x ), data.strideX, data.offsetX, new Float64Array( data.y ), data.strideY, data.offsetY, new Float64Array( data.A ), data.strideA1, data.strideA2, data.offsetA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid fifth argument', opts, function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + 0 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.M, data.N, data.alpha, new Float64Array( data.x ), value, data.offsetX, new Float64Array( data.y ), data.strideY, data.offsetY, new Float64Array( data.A ), data.strideA1, data.strideA2, data.offsetA ); + }; + } +}); + +tape( 'the function throws an error if provided an invalid eighth argument', opts, function test( t ) { + var values; + var data; + var i; + + data = rm; + + values = [ + 0 + ]; + + for ( i = 0; i < values.length; i++ ) { + t.throws( badValue( values[ i ] ), RangeError, 'throws an error when provided ' + values[ i ] ); + } + t.end(); + + function badValue( value ) { + return function badValue() { + dger( data.M, data.N, data.alpha, new Float64Array( data.x ), data.strideX, data.offsetX, new Float64Array( data.y ), value, data.offsetY, new Float64Array( data.A ), data.strideA1, data.strideA2, data.offsetA ); + }; + } +}); + +tape( 'the function the rank 1 operation `A = α*x*y^T + A` (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function the rank 1 operation `A = α*x*y^T + A` (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns a reference to the input matrix (row-major)', opts, function test( t ) { + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.end(); +}); + +tape( 'the function returns a reference to the input matrix (column-major)', opts, function test( t ) { + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.end(); +}); + +tape( 'if either `M` or `N` is `0`, the function returns the input matrix unchanged (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( 0, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + out = dger( data.M, 0, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if either `M` or `N` is `0`, the function returns the input matrix unchanged (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( 0, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + out = dger( data.M, 0, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `α` is `0.0`, the function returns the input matrix unchanged (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( data.M, data.N, 0.0, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `α` is `0.0`, the function returns the input matrix unchanged (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cm; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A ); + + out = dger( data.M, data.N, 0.0, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + + t.end(); +}); + +tape( 'if `x` contains only zeros, the function returns the input matrix unchanged (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rx0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if `x` contains only zeros, the function returns the input matrix unchanged (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cx0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if `y` contains only zeros, the function returns the input matrix unchanged (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = ry0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'if `y` contains only zeros, the function returns the input matrix unchanged (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cy0; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying the strides of the first and second dimensions of `A` (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rsa1sa2; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying the strides of the first and second dimensions of `A` (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = csa1sa2; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative stride for the first dimension of `A` (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rsa1nsa2; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative stride for the first dimension of `A` (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = csa1nsa2; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative stride for the second dimension of `A` (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rsa1sa2n; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports a negative stride for the second dimension of `A` (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = csa1sa2n; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative strides for `A` (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rsa1nsa2n; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports negative strides for `A` (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = csa1nsa2n; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying an offset parameter for `A` (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = roa; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying an offset parameter for `A` (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = coa; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying `x` and `y` strides (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxpyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying `x` and `y` strides (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxpyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `x` stride (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxnyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `x` stride (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxnyp; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `y` stride (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxpyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying a negative `y` stride (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxpyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying negative strides for `x` and `y` (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rxnyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying negative strides for `x` and `y` (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cxnyn; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying an offset parameter for `x` (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rox; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying an offset parameter for `x` (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = cox; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying an offset parameter for `y` (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = roy; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports specifying an offset parameter for `y` (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = coy; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns (row-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = rcap; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +}); + +tape( 'the function supports complex access patterns (column-major)', opts, function test( t ) { + var expected; + var data; + var out; + var a; + var x; + var y; + + data = ccap; + + a = new Float64Array( data.A ); + x = new Float64Array( data.x ); + y = new Float64Array( data.y ); + + expected = new Float64Array( data.A_out ); + + out = dger( data.M, data.N, data.alpha, x, data.strideX, data.offsetX, y, data.strideY, data.offsetY, a, data.strideA1, data.strideA2, data.offsetA ); + t.strictEqual( out, a, 'returns expected value' ); + t.deepEqual( out, expected, 'returns expected value' ); + t.end(); +});