octave_packages/communications-1.1.1/@galois/diag.m

   1 ## Copyright (C) 2011 David Bateman
   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 {Loadable Function} {} diag (@var{v}, @var{k})
  18 ## Return a diagonal matrix with Galois vector @var{v} on diagonal @var{k}.
  19 ## The second argument is optional.  If it is positive, the vector is placed on
  20 ## the @var{k}-th super-diagonal.  If it is negative, it is placed on the
  21 ## @var{-k}-th sub-diagonal.  The default value of @var{k} is 0, and the
  22 ## vector is placed on the main diagonal.  For example,
  23 ##
  24 ## @example
  25 ## diag (gf([1, 2, 3],2), 1)
  26 ## ans =
  27 ## GF(2^2) array. Primitive Polynomial = D^2+D+1 (decimal 7)
  28 ##
  29 ## Array elements =
  30 ##
  31 ##   0  1  0  0
  32 ##   0  0  2  0
  33 ##   0  0  0  3
  34 ##   0  0  0  0
  35 ## @end example
  36 ## @end deftypefn
  37
  38 function varargout = diag (varargin)
  39   varargout = cell (1, max(1, nargout));
  40   [varargout{:}] = gdiag (varargin{:});
  41 endfunction
  42