# HG changeset patch
# User Rik <rik@octave.org>
# Date 1657604337 25200
# Node ID 7c5cb8f8a21e043c1dfd8e032e62b47bcfb74057
# Parent  22305b923761a8e9e04ce8ee49e131264a4faadd
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.

diff -r 22305b923761 -r 7c5cb8f8a21e doc/interpreter/expr.txi
--- a/doc/interpreter/expr.txi	Sat Jul 09 22:05:40 2022 -0700
+++ b/doc/interpreter/expr.txi	Mon Jul 11 22:38:57 2022 -0700
@@ -817,6 +817,8 @@
 @opindex @code{'}
 @DOCSTRING(ctranspose)
 
+@DOCSTRING(pagectranspose)
+
 @opindex .\
 @DOCSTRING(ldivide)
 
@@ -850,6 +852,8 @@
 @opindex @code{.'}
 @DOCSTRING(transpose)
 
+@DOCSTRING(pagetranspose)
+
 @opindex -
 @DOCSTRING(uminus)
 
diff -r 22305b923761 -r 7c5cb8f8a21e etc/NEWS.8.md
--- a/etc/NEWS.8.md	Sat Jul 09 22:05:40 2022 -0700
+++ b/etc/NEWS.8.md	Mon Jul 11 22:38:57 2022 -0700
@@ -65,6 +65,8 @@
 
 ### Alphabetical list of new functions added in Octave 8
 
+* `pagectranspose`
+* `pagetranspose`
 * `uifigure`
 
 ### Deprecated functions, properties, and operators
diff -r 22305b923761 -r 7c5cb8f8a21e scripts/general/module.mk
--- a/scripts/general/module.mk	Sat Jul 09 22:05:40 2022 -0700
+++ b/scripts/general/module.mk	Mon Jul 11 22:38:57 2022 -0700
@@ -47,6 +47,8 @@
   %reldir%/logspace.m \
   %reldir%/nextpow2.m \
   %reldir%/num2str.m \
+  %reldir%/pagectranspose.m \
+  %reldir%/pagetranspose.m \
   %reldir%/pol2cart.m \
   %reldir%/polyarea.m \
   %reldir%/postpad.m \
diff -r 22305b923761 -r 7c5cb8f8a21e scripts/general/pagectranspose.m
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/scripts/general/pagectranspose.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{y} =} pagectranspose (@var{A})
+## Return the page-wise complex conjugate transpose of the N-dimensional array
+## @var{A}.
+##
+## This is equivalent to @tcode{@var{A}(:,:, @var{k})'} for each page @var{k}.
+##
+## @seealso{pagetranspose, ctranspose, permute}
+## @end deftypefn
+
+function B = pagectranspose (A)
+
+  if (nargin != 1)
+    print_usage ();
+  endif
+
+  B = permute (conj (A), [2, 1, 3:ndims(A)]);
+
+endfunction
+
+
+%!test
+%! A = reshape (1:8, [2, 2, 2]);
+%! B = pagectranspose (A);
+%! assert (B, cat (3, [1,2;3,4], [5,6;7,8]));
+
+%!test
+%! A = reshape ((1:8)*i, [2, 2, 2]);
+%! B = pagectranspose (A);
+%! assert (B, -i * cat (3, [1,2;3,4], [5,6;7,8]));
+
+## Test input validation
+%!error <Invalid call> pagectranspose ()
diff -r 22305b923761 -r 7c5cb8f8a21e scripts/general/pagetranspose.m
--- /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 ()