octave_packages/linear-algebra-2.2.0/@kronprod/full.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} full (@var{KP})
  18 ## Return the full matrix representation of the Kronecker product @var{KP}.
  19 ##
  20 ## If @var{KP} is the Kronecker product of an @var{n}-by-@var{m} matrix and a
  21 ## @var{q}-by-@var{r} matrix, then the result is a @var{n}@var{q}-by-@var{m}@var{r}
  22 ## matrix. Thus, the result can require vast amount of memory, so this function
  23 ## should be avoided whenever possible.
  24 ## @seealso{full, @@kronprod/sparse}
  25 ## @end deftypefn
  26
  27 function retval = full (KP)
  28   if (nargin != 1)
  29     print_usage ();
  30   endif
  31
  32   if (!isa (KP, "kronprod"))
  33     error ("full: input argument must be of class 'kronprod'");
  34   endif
  35
  36   retval = full (kron (KP.A, KP.B));
  37   if (!isempty (KP.P))
  38     #retval = KP.P * retval * KP.P';
  39     retval = retval (KP.P, KP.P);
  40   endif
  41 endfunction