octave_packages/communications-1.1.1/bi2de.m

   1 ## Copyright (C) 2001 Laurent Mazet
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify it under
   4 ## the terms of the GNU General Public License as published by the Free Software
   5 ## Foundation; either version 3 of the License, or (at your option) any later
   6 ## version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful, but WITHOUT
   9 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  11 ## details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License along with
  14 ## this program; if not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function File} {@var{d} = } bi2de (@var{b})
  18 ## @deftypefnx {Function File} {@var{d} = } bi2de (@var{b},@var{f})
  19 ## @deftypefnx {Function File} {@var{d} = } bi2de (@var{b},@var{p})
  20 ## @deftypefnx {Function File} {@var{d} = } bi2de (@var{b},@var{p},@var{f})
  21 ##
  22 ## Convert bit matrix to a vector of integers
  23 ##
  24 ## Each row of the matrix @var{b} is treated as a single integer represented
  25 ## in binary form. The elements of @var{b}, must therefore be '0' or '1'
  26 ##
  27 ## If @var{p} is defined then it is treated as the base of the decomposition
  28 ## and the elements of @var{b} must then lie between '0' and 'p-1'.
  29 ##
  30 ## The variable @var{f} defines whether the first or last element of @var{b}
  31 ## is considered to be the most-significant. Valid values of @var{f} are
  32 ## 'right-msb' or 'left-msb'. By default @var{f} is 'right-msb'.
  33 ##
  34 ## @seealso{de2bi}
  35 ## @end deftypefn
  36
  37 function d = bi2de (b, p, f)
  38
  39   switch (nargin)
  40     case 1,
  41       p = 2;
  42       f = 'right-msb';
  43     case 2,
  44       if (ischar (p))
  45         f = p;
  46         p = 2;
  47       else
  48         f = 'right-msb';
  49       endif
  50     case 3,
  51       if (ischar (p))
  52         tmp = f;
  53         f = p;
  54         p = tmp;
  55       endif
  56     otherwise
  57       print_usage ();
  58   endswitch
  59
  60   if ( any (b(:) < 0) || any (b(:) != floor (b(:))) || any (b(:) > p - 1) )
  61     error ("bi2de: d must only contain integers in the range [0, p-1]");
  62   endif
  63
  64   if (strcmp (f, 'left-msb'))
  65     b = b(:,size(b,2):-1:1);
  66   elseif (!strcmp (f, 'right-msb'))
  67     error ("bi2de: unrecognized flag");
  68   endif
  69
  70   if (length (b) == 0)
  71     d = [];
  72   else
  73     d = b * ( p .^ [ 0 : (columns(b)-1) ]' );
  74   endif
  75
  76 endfunction
  77
  78                                 %!shared x
  79                                 %! x = randi ([0 1], 100, 16);
  80                                 %!assert (bi2de (0), 0)
  81                                 %!assert (bi2de (1), 1)
  82                                 %!assert (bi2de (ones (1, 8)), 255)
  83                                 %!assert (bi2de ([7 7 7 7], 8), 4095)
  84                                 %!assert (size (bi2de (x)), [100 1])
  85                                 %!assert (bi2de (x, "right-msb"), bi2de (x))
  86                                 %!assert (bi2de (x, "left-msb"), bi2de (fliplr (x)))
  87
  88 %% Test input validation
  89                                 %!error bi2de ()
  90                                 %!error bi2de (1, 2, 3, 4)
  91                                 %!error bi2de (1, 2, 3)
  92                                 %!error bi2de (1, 2, "invalid")
  93                                 %!error bi2de (0.1)
  94                                 %!error bi2de (-1)
  95                                 %!error bi2de (2)
  96                                 %!error bi2de (7, 6)