octave_packages/m/miscellaneous/swapbytes.m

   1 ## Copyright (C) 2007-2012 David Bateman
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {} swapbytes (@var{x})
  21 ## Swap the byte order on values, converting from little endian to big
  22 ## endian and vice versa.  For example:
  23 ##
  24 ## @example
  25 ## @group
  26 ## swapbytes (uint16 (1:4))
  27 ## @result{} [   256   512   768  1024]
  28 ## @end group
  29 ## @end example
  30 ##
  31 ## @seealso{typecast, cast}
  32 ## @end deftypefn
  33
  34 function y = swapbytes (x)
  35
  36   if (nargin != 1)
  37     print_usage ();
  38   endif
  39
  40   clx = class (x);
  41   if (strcmp (clx, "int8") || strcmp (clx, "uint8") || isempty (x))
  42     y = x;
  43   else
  44     if (strcmp (clx, "int16") || strcmp (clx, "uint16"))
  45       nb = 2;
  46     elseif (strcmp (clx, "int32") || strcmp (clx, "uint32"))
  47       nb = 4;
  48     elseif (strcmp (clx, "int64") || strcmp (clx, "uint64")
  49             || strcmp (clx, "double"))
  50       nb = 8;
  51     else
  52       error ("swapbytes: invalid class of object");
  53     endif
  54     y = reshape (typecast (reshape (typecast (x(:), "uint8"), nb, numel (x))
  55                            ([nb : -1 : 1], :) (:), clx), size(x));
  56   endif
  57
  58 endfunction
  59
  60
  61 %!assert (double (swapbytes (uint16 (1:4))), [256 512 768 1024])
  62 %!error (swapbytes ())
  63 %!error (swapbytes (1, 2))
  64