octave_packages/linear-algebra-2.2.0/@kronprod/kronprod.m

   1 ## Copyright (C) 2010  Soren Hauberg
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify
   4 ## it under the terms of the GNU General Public License as published by
   5 ## the Free Software Foundation; either version 3, or (at your option)
   6 ## any later version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful, but
   9 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 ## General Public License for more details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License
  14 ## along with this file.  If not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Function File} kronprod (@var{A}, @var{B})
  18 ## @deftypefnx{Function File} kronprod (@var{A}, @var{B}, @var{P})
  19 ## Construct a Kronecker product object.
  20 ## XXX: Write proper documentation
  21 ##
  22 ## With two input arguments, the following matrix is represented: kron (A, B);
  23 ##
  24 ## With three input arguments, the following matrix is represented: P * kron (A, B) * P'
  25 ## (P must be a permutation matrix)
  26 ##
  27 ## @end deftypefn
  28
  29 function retval = kronprod (A, B, P)
  30   if (nargin == 0)
  31     KP.A = KP.B = KP.P = [];
  32   elseif (nargin == 2 && ismatrix (A) && ismatrix (B))
  33     KP.A = A;
  34     KP.B = B;
  35     KP.P = [];
  36   elseif (nargin == 3 && ismatrix (A) && ismatrix (B))
  37 #          && strcmp (typeinfo (P), "permutation matrix"))
  38     ## XXX: Check that the size of P is correct
  39     KP.A = A;
  40     KP.B = B;
  41     KP.P = P;
  42   else
  43     print_usage ();
  44   endif
  45
  46   retval = class (KP, "kronprod");
  47 endfunction