Skip to content

Add specification for performing a batched matrix transpose on an array instance via an .mT attribute #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 13, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions spec/API_specification/array_object.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,19 @@ Hardware device the array data resides on.

- a `device` object (see {ref}`device-support`).

(attribute-mT)=
### mT

Transpose of a matrix (or a stack of matrices).

If an array instance has fewer than two dimensions, an error should be raised.

#### Returns

- **out**: _<array>_

- array whose last two dimensions (axes) are permuted in reverse order relative to original array (i.e., for an array instance having shape `(..., M, N)`, the returned array must have shape `(..., N, M)`). The returned array must have the same data type as the original array.

(attribute-ndim)=
### ndim

Expand Down