Copy all or part of a matrix A to another matrix B.
npm install @stdlib/lapack-base-clacpyWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js. The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases. When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there. To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
About stdlib...
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Copy all or part of a matrix A to another matrix B.
``bash`
npm install @stdlib/lapack-base-clacpy
`javascript`
var clacpy = require( '@stdlib/lapack-base-clacpy' );
#### clacpy( order, uplo, M, N, A, LDA, B, LDB )
Copies all or part of a matrix A to another matrix B.
`javascript
var Complex64Array = require( '@stdlib/array-complex64' );
var reinterpret = require( '@stdlib/strided-base-reinterpret-complex64' );
var A = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
var B = new Complex64Array( 4 );
clacpy( 'row-major', 'all', 2, 2, A, 2, B, 2 );
var viewB = reinterpret( B, 0 );
// returns
`
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.A
- M: number of rows in .A
- N: number of columns in .Complex64Array
- A: input [][@stdlib/array/complex64].A
- LDA: stride of the first dimension of (a.k.a., leading dimension of the matrix A).Complex64Array
- B: output [][@stdlib/array/complex64].B
- LDB: stride of the first dimension of (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.
`javascript
var Complex64Array = require( '@stdlib/array-complex64' );
var reinterpret = require( '@stdlib/strided-base-reinterpret-complex64' );
// Initial arrays...
var A0 = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
var B0 = new Complex64Array( 5 );
// Create offset views...
var A1 = new Complex64Array( A0.buffer, A0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
var B1 = new Complex64Array( B0.buffer, B0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
clacpy( 'row-major', 'all', 2, 2, A1, 2, B1, 2 );
var viewB = reinterpret( B0, 0 );
// returns
`
#### clacpy.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 Complex64Array = require( '@stdlib/array-complex64' );
var reinterpret = require( '@stdlib/strided-base-reinterpret-complex64' );
var A = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
var B = new Complex64Array( 4 );
clacpy.ndarray( 'all', 2, 2, A, 2, 1, 0, B, 2, 1, 0 );
var viewB = reinterpret( B, 0 );
// returns
`
The function has the following parameters:
- uplo: specifies whether to copy the upper or lower triangular/trapezoidal part of a matrix A.A
- M: number of rows in .A
- N: number of columns in .Complex64Array
- A: input [][@stdlib/array/complex64].A
- sa1: stride of the first dimension of .A
- sa2: stride of the second dimension of .A
- oa: starting index for .Complex64Array
- B: output [][@stdlib/array/complex64].B
- sb1: stride of the first dimension of .B
- sb2: stride of the second dimension of .B
- ob: starting index for .
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 Complex64Array = require( '@stdlib/array-complex64' );
var reinterpret = require( '@stdlib/strided-base-reinterpret-complex64' );
var A = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0 ] );
var B = new Complex64Array( 6 );
clacpy.ndarray( 'all', 2, 2, A, 2, 1, 1, B, 2, 1, 2 );
var viewB = reinterpret( B, 0 );
// returns
`
- clacpy() corresponds to the [LAPACK][lapack] routine [clacpy][lapack-clacpy].
`javascript
var Complex64Array = require( '@stdlib/array-complex64' );
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 clacpy = require( '@stdlib/lapack-base-clacpy' );
var shape = [ 5, 8 ];
var order = 'row-major';
var strides = shape2strides( shape, order );
var N = numel( shape );
var A = new Complex64Array( uniform( 2*N, -10, 10, {
'dtype': 'generic'
}));
console.log( ndarray2array( A, shape, strides, 0, order ) );
var B = new Complex64Array( uniform( 2*N, -10, 10, {
'dtype': 'generic'
}));
console.log( ndarray2array( B, shape, strides, 0, order ) );
clacpy( order, 'all', shape[ 0 ], shape[ 1 ], A, strides[ 0 ], B, strides[ 0 ] );
console.log( ndarray2array( B, shape, strides, 0, order ) );
`
*
`c`
TODO
#### TODO
TODO.
`c`
TODO
TODO
`c`
TODO
`c`
TODO
*
This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].
#### Community
[![Chat][chat-image]][chat-url]
---
See [LICENSE][stdlib-license].
Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/lapack-base-clacpy.svg
[npm-url]: https://npmjs.org/package/@stdlib/lapack-base-clacpy
[test-image]: https://github.com/stdlib-js/lapack-base-clacpy/actions/workflows/test.yml/badge.svg?branch=v0.1.1
[test-url]: https://github.com/stdlib-js/lapack-base-clacpy/actions/workflows/test.yml?query=branch:v0.1.1
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/lapack-base-clacpy/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/lapack-base-clacpy?branch=main
[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
[chat-url]: https://stdlib.zulipchat.com
[stdlib]: https://github.com/stdlib-js/stdlib
[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
[umd]: https://github.com/umdjs/umd
[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
[deno-url]: https://github.com/stdlib-js/lapack-base-clacpy/tree/deno
[deno-readme]: https://github.com/stdlib-js/lapack-base-clacpy/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/lapack-base-clacpy/tree/umd
[umd-readme]: https://github.com/stdlib-js/lapack-base-clacpy/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/lapack-base-clacpy/tree/esm
[esm-readme]: https://github.com/stdlib-js/lapack-base-clacpy/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/lapack-base-clacpy/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/lapack-base-clacpy/main/LICENSE
[lapack]: https://www.netlib.org/lapack/explore-html/
[lapack-clacpy]: https://netlib.org/lapack/explore-html/d0/d9e/group__lacpy_ga4eb69fef93799574c785add4eeb619f3.html#ga4eb69fef93799574c785add4eeb619f3
[@stdlib/array/complex64]: https://www.npmjs.com/package/@stdlib/array-complex64
[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray