feat: add lapack/base/slacpy

PR-URL: #2716
Ref: #2464
Co-authored-by: Athan Reines <[email protected]>
Reviewed-by: Athan Reines <[email protected]>

lib/node_modules/@stdlib/lapack/base/slacpy/README.md

@@ -0,0 +1,260 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# slacpy
+
+> Copy all or part of a matrix `A` to another matrix `B`.
+
+<section class = "usage">
+
+## Usage
+
+```javascript
+var slacpy = require( '@stdlib/lapack/base/slacpy' );
+```
+
+#### slacpy( order, uplo, M, N, A, LDA, B, LDB )
+
+Copies all or part of a matrix `A` to another matrix `B`.
+
+```javascript
+var Float32Array = require( '@stdlib/array/float32' );
+
+var A = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] );
+var B = new Float32Array( 4 );
+
+slacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
+// B => <Float32Array>[ 1.0, 2.0, 3.0, 4.0 ]
+```
+
+The function has the following parameters:
+
+- **order**: storage layout.
+- **uplo**: specifies whether to copy the upper or lower triangular/trapezoidal part of a matrix `A`.
+- **M**: number of rows in `A`.
+- **N**: number of columns in `A`.
+- **A**: input [`Float32Array`][mdn-Float32Array].
+- **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
+- **B**: output [`Float32Array`][mdn-Float32Array].
+- **LDB**: stride of the first dimension of `B` (a.k.a., leading dimension of the matrix `B`).
+
+Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
+
+<!-- eslint-disable stdlib/capitalized-comments -->
+
+```javascript
+var Float32Array = require( '@stdlib/array/float32' );
+
+// Initial arrays...
+var A0 = new Float32Array( [ 1.0, 2.0, 3.0, 4.0, 5.0 ] );
+var B0 = new Float32Array( 5 );
+
+// Create offset views...
+var A1 = new Float32Array( A0.buffer, A0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+var B1 = new Float32Array( B0.buffer, B0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+
+slacpy( 'row-major', 'all', 2, 2, A1, 2, B1, 2 );
+// B0 => <Float32Array>[ 0.0, 2.0, 3.0, 4.0, 5.0 ]
+```
+
+#### slacpy.ndarray( uplo, M, N, A, sa1, sa2, oa, B, sb1, sb2, ob )
+
+Copies all or part of a matrix `A` to another matrix `B` using alternative indexing semantics.
+
+```javascript
+var Float32Array = require( '@stdlib/array/float32' );
+
+var A = new Float32Array( [ 1.0, 2.0, 3.0, 4.0 ] );
+var B = new Float32Array( [ 0.0, 0.0, 0.0, 0.0 ] );
+
+slacpy.ndarray( 'all', 2, 2, A, 2, 1, 0, B, 2, 1, 0 );
+// B => <Float32Array>[ 1.0, 2.0, 3.0, 4.0 ]
+```
+
+The function has the following parameters:
+
+- **uplo**: specifies whether to copy the upper or lower triangular/trapezoidal part of a matrix `A`.
+- **M**: number of rows in `A`.
+- **N**: number of columns in `A`.
+- **A**: input [`Float32Array`][mdn-Float32Array].
+- **sa1**: stride of the first dimension of `A`.
+- **sa2**: stride of the second dimension of `A`.
+- **oa**: starting index for `A`.
+- **B**: output [`Float32Array`][mdn-Float32Array].
+- **sb1**: stride of the first dimension of `B`.
+- **sb2**: stride of the second dimension of `B`.
+- **ob**: starting index for `B`.
+
+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 Float32Array = require( '@stdlib/array/float32' );
+
+var A = new Float32Array( [ 0.0, 1.0, 2.0, 3.0, 4.0 ] );
+var B = new Float32Array( [ 0.0, 0.0, 11.0, 312.0, 53.0, 412.0 ] );
+
+slacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
+// B => <Float32Array>[ 0.0, 0.0, 1.0, 2.0, 3.0, 4.0 ]
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+- `slacpy()` corresponds to the [LAPACK][lapack] routine [`slacpy`][lapack-slacpy].
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var ndarray2array = require( '@stdlib/ndarray/base/to-array' );
+var uniform = require( '@stdlib/random/array/discrete-uniform' );
+var numel = require( '@stdlib/ndarray/base/numel' );
+var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
+var slacpy = require( '@stdlib/lapack/base/slacpy' );
+
+var shape = [ 5, 8 ];
+var order = 'row-major';
+var strides = shape2strides( shape, order );
+
+var N = numel( shape );
+
+var A = uniform( N, -10, 10, {
+ 'dtype': 'float32'
+});
+console.log( ndarray2array( A, shape, strides, 0, order ) );
+
+var B = uniform( N, -10, 10, {
+ 'dtype': 'float32'
+});
+console.log( ndarray2array( B, shape, strides, 0, order ) );
+
+slacpy( order, 'all', shape[ 0 ], shape[ 1 ], A, strides[ 0 ], B, strides[ 0 ] );
+console.log( ndarray2array( B, shape, strides, 0, order ) );
+```
+
+</section>
+
+<!-- /.examples -->
+
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+TODO
+```
+
+#### TODO
+
+TODO.
+
+```c
+TODO
+```
+
+TODO
+
+```c
+TODO
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+TODO
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[lapack]: https://www.netlib.org/lapack/explore-html/
+
+[lapack-slacpy]: https://www.netlib.org/lapack/explore-html/d0/d9e/group__lacpy_gae51b1efa5e6cb69029e83a425e773607.html#gae51b1efa5e6cb69029e83a425e773607
+
+[mdn-float32array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Float32Array
+
+[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+
+</section>
+
+<!-- /.links -->

lib/node_modules/@stdlib/lapack/base/slacpy/benchmark/benchmark.js

@@ -0,0 +1,105 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2024 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+// MODULES //
+
+var bench = require( '@stdlib/bench' );
+var uniform = require( '@stdlib/random/array/uniform' );
+var isnanf = require( '@stdlib/math/base/assert/is-nanf' );
+var pow = require( '@stdlib/math/base/special/pow' );
+var floor = require( '@stdlib/math/base/special/floor' );
+var pkg = require( './../package.json' ).name;
+var slacpy = require( './../lib/slacpy.js' );
+
+
+// FUNCTIONS //
+
+/**
+* Creates a benchmark function.
+*
+* @private
+* @param {PositiveInteger} N - number of elements along each dimension
+* @returns {Function} benchmark function
+*/
+function createBenchmark( N ) {
+ var opts;
+ var A;
+ var B;
+
+ opts = {
+ 'dtype': 'float32'
+ };
+
+ A = uniform( N*N, -10.0, 10.0, opts );
+ B = uniform( N*N, -10.0, 10.0, opts );
+ 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 = slacpy( 'column-major', 'all', N, N, A, N, B, N );
+ if ( isnanf( z[ i%z.length ] ) ) {
+ b.fail( 'should not return NaN' );
+ }
+ }
+ b.toc();
+ if ( isnanf( z[ i%z.length ] ) ) {
+ b.fail( 'should not return NaN' );
+ }
+ b.pass( 'benchmark finished' );
+ b.end();
+ }
+}
+
+
+// MAIN //
+
+/**
+* Main execution sequence.
+*
+* @private
+*/
+function main() {
+ var min;
+ var max;
+ var N;
+ var f;
+ var i;
+
+ min = 1; // 10^min
+ max = 6; // 10^max
+
+ for ( i = min; i <= max; i++ ) {
+ N = floor( pow( pow( 10, i ), 1.0/2.0 ) );
+ f = createBenchmark( N );
+ bench( pkg+':order=column-major,size='+(N*N), f );
+ }
+}
+
+main();