Mercurial > jwe > octave

annotate scripts/general/pagectranspose.m @ 31145:7c5cb8f8a21e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array. * pagectranspose.m, pagetranspose.m: New functions. * scripts/general/module.mk: Add new functions to build system. * etc/NEWS.8.md: Announce new functions. * expr.txi: Add functions to Octave manual.
author Rik <rik@octave.org>
date Mon, 11 Jul 2022 22:38:57 -0700
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
31145
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
1 ########################################################################
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
2 ##
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
3 ## Copyright (C) 2022 The Octave Project Developers
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
4 ##
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
5 ## See the file COPYRIGHT.md in the top-level directory of this
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
6 ## distribution or <https://octave.org/copyright/>.
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
7 ##
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
8 ## This file is part of Octave.
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
9 ##
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
10 ## Octave is free software: you can redistribute it and/or modify it
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
11 ## under the terms of the GNU General Public License as published by
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
12 ## the Free Software Foundation, either version 3 of the License, or
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
13 ## (at your option) any later version.
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
14 ##
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
15 ## Octave is distributed in the hope that it will be useful, but
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
18 ## GNU General Public License for more details.
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
19 ##
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
20 ## You should have received a copy of the GNU General Public License
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
21 ## along with Octave; see the file COPYING. If not, see
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
22 ## <https://www.gnu.org/licenses/>.
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
23 ##
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
24 ########################################################################
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
25
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
26 ## -*- texinfo -*-
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
27 ## @deftypefn {} {@var{y} =} pagectranspose (@var{A})
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
28 ## Return the page-wise complex conjugate transpose of the N-dimensional array
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
29 ## @var{A}.
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
30 ##
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
31 ## This is equivalent to @tcode{@var{A}(:,:, @var{k})'} for each page @var{k}.
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
32 ##
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
33 ## @seealso{pagetranspose, ctranspose, permute}
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
34 ## @end deftypefn
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
35
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
36 function B = pagectranspose (A)
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
37
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
38 if (nargin != 1)
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
39 print_usage ();
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
40 endif
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
41
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
42 B = permute (conj (A), [2, 1, 3:ndims(A)]);
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
43
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
44 endfunction
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
45
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
46
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
47 %!test
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
48 %! A = reshape (1:8, [2, 2, 2]);
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
49 %! B = pagectranspose (A);
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
50 %! assert (B, cat (3, [1,2;3,4], [5,6;7,8]));
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
51
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
52 %!test
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
53 %! A = reshape ((1:8)*i, [2, 2, 2]);
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
54 %! B = pagectranspose (A);
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
55 %! assert (B, -i * cat (3, [1,2;3,4], [5,6;7,8]));
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
56
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
57 ## Test input validation
7c5cb8f8a21e pagetranspose.m, pagectranspose.m: New functions for transposing the page (3-D) of an N-D array.
Rik <rik@octave.org>
parents:
diff changeset
58 %!error <Invalid call> pagectranspose ()