https://github.com/stdlib-js/ndarray-base-transpose
Transpose a matrix (or a stack of matrices).
https://github.com/stdlib-js/ndarray-base-transpose
base data javascript matrix ndarray node node-js nodejs permute stack stdlib structure swap swapaxes transpose types
Last synced: 8 months ago
JSON representation
Transpose a matrix (or a stack of matrices).
- Host: GitHub
- URL: https://github.com/stdlib-js/ndarray-base-transpose
- Owner: stdlib-js
- License: apache-2.0
- Created: 2022-01-26T00:40:39.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-09T02:32:14.000Z (over 1 year ago)
- Last Synced: 2025-02-10T17:54:15.296Z (over 1 year ago)
- Topics: base, data, javascript, matrix, ndarray, node, node-js, nodejs, permute, stack, stdlib, structure, swap, swapaxes, transpose, types
- Language: JavaScript
- Homepage: https://github.com/stdlib-js/stdlib
- Size: 619 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Citation: CITATION.cff
- Security: SECURITY.md
Awesome Lists containing this project
README
About stdlib...
We 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!
# transpose
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
> Transpose a matrix (or a stack of matrices).
## Installation
```bash
npm install @stdlib/ndarray-base-transpose
```
Alternatively,
- To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).
- If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).
- For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).
The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.
To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.
## Usage
```javascript
var transpose = require( '@stdlib/ndarray-base-transpose' );
```
#### transpose( x )
Transposes a matrix (or a stack of matrices) `x`.
```javascript
var array = require( '@stdlib/ndarray-array' );
var x = array( [ [ 1, 2, 3 ], [ 4, 5, 6 ] ] );
// returns
var sh = x.shape;
// returns [ 2, 3 ]
var y = transpose( x );
// returns
sh = y.shape;
// returns [ 3, 2 ]
var bool = ( x.data === y.data );
// returns true
bool = ( x.get( 0, 1 ) === y.get( 1, 0 ) );
// returns true
```
## Notes
- The returned ndarray is a **view** of the input ndarray. Accordingly, writing to the original ndarray will **mutate** the returned ndarray and vice versa. While powerful, this can lead to subtle bugs. In general, one should handle the returned ndarray as **read-only**.
- If provided an ndarray with fewer than two dimensions, the function raises an exception.
## Examples
```javascript
var Float64Array = require( '@stdlib/array-float64' );
var ndarray = require( '@stdlib/ndarray-ctor' );
var rpad = require( '@stdlib/string-right-pad' );
var transpose = require( '@stdlib/ndarray-base-transpose' );
function print( arr, name ) {
var str;
var sh;
var p;
var i;
var j;
var k;
sh = arr.shape;
for ( i = 0; i < sh[0]; i++ ) {
str = name+'['+i+',:,:] = [ ';
p = str.length + 1;
for ( j = 0; j < sh[1]; j++ ) {
if ( j > 0 ) {
str += rpad( '\n', p, ' ' );
}
for ( k = 0; k < sh[2]; k++ ) {
str += arr.get( i, j, k );
if ( k < sh[2]-1 ) {
str += ', ';
}
}
}
console.log( str + ' ]\n' );
}
}
// Create a data buffer:
var buf = new Float64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0 ] );
// Create a stack of matrices:
var x = new ndarray( 'float64', buf, [ 2, 2, 3 ], [ 0, 3, 1 ], 0, 'row-major' );
// Transpose the stack of matrices:
var y = transpose( x );
// Print the stacks:
console.log( '' );
print( x, 'X' );
console.log( '' );
print( y, 'Y' );
```
* * *
## See Also
- [`@stdlib/ndarray-ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor.
* * *
## Notice
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]
---
## License
See [LICENSE][stdlib-license].
## Copyright
Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].
[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-transpose.svg
[npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-transpose
[test-image]: https://github.com/stdlib-js/ndarray-base-transpose/actions/workflows/test.yml/badge.svg?branch=main
[test-url]: https://github.com/stdlib-js/ndarray-base-transpose/actions/workflows/test.yml?query=branch:main
[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-transpose/main.svg
[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-transpose?branch=main
[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
[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/ndarray-base-transpose/tree/deno
[deno-readme]: https://github.com/stdlib-js/ndarray-base-transpose/blob/deno/README.md
[umd-url]: https://github.com/stdlib-js/ndarray-base-transpose/tree/umd
[umd-readme]: https://github.com/stdlib-js/ndarray-base-transpose/blob/umd/README.md
[esm-url]: https://github.com/stdlib-js/ndarray-base-transpose/tree/esm
[esm-readme]: https://github.com/stdlib-js/ndarray-base-transpose/blob/esm/README.md
[branches-url]: https://github.com/stdlib-js/ndarray-base-transpose/blob/main/branches.md
[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-transpose/main/LICENSE
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor