Mercurial > jwe > octave
diff scripts/general/pagetranspose.m @ 31145:7c5cb8f8a21e
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 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/scripts/general/pagetranspose.m Mon Jul 11 22:38:57 2022 -0700 @@ -0,0 +1,58 @@ +######################################################################## +## +## Copyright (C) 2022 The Octave Project Developers +## +## See the file COPYRIGHT.md in the top-level directory of this +## distribution or <https://octave.org/copyright/>. +## +## This file is part of Octave. +## +## Octave is free software: you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation, either version 3 of the License, or +## (at your option) any later version. +## +## Octave is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +## GNU General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with Octave; see the file COPYING. If not, see +## <https://www.gnu.org/licenses/>. +## +######################################################################## + +## -*- texinfo -*- +## @deftypefn {} {@var{B} =} pagetranspose (@var{A}) +## Return the page-wise transpose of the N-dimensional array @var{A}. +## +## This is equivalent to @tcode{@var{A}(:,:, @var{k}).@:'} for each page +## @var{k}. +## +## @seealso{pagectranspose, transpose, permute} +## @end deftypefn + +function B = pagetranspose (A) + + if (nargin != 1) + print_usage (); + endif + + B = permute (A, [2, 1, 3:ndims(A)]); + +endfunction + + +%!test +%! A = reshape (1:8, [2, 2, 2]); +%! B = pagetranspose (A); +%! assert (B, cat (3, [1,2;3,4], [5,6;7,8])); + +%!test +%! A = reshape ((1:8)*i, [2, 2, 2]); +%! B = pagetranspose (A); +%! assert (B, i * cat (3, [1,2;3,4], [5,6;7,8])); + +## Test input validation +%!error <Invalid call> pagetranspose ()