octave_packages/linear-algebra-2.2.0/@kronprod/display.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} display (@var{KP})
  18 ## Show the content of the Kronecker product @var{KP}. To avoid evaluating the
  19 ## Kronecker product, this function displays the two matrices defining the product.
  20 ## To display the actual values of @var{KP}, use @code{display (full (@var{KP}))}.
  21 ## @seealso{@@kronprod/displ, @@kronprod/full}
  22 ## @end deftypefn
  23
  24 function display (KP)
  25   if (nargin != 1)
  26     print_usage ();
  27   endif
  28
  29   if (!isa (KP, "kronprod"))
  30     error ("display: input argument must be of class 'kronprod'");
  31   endif
  32
  33   if (isempty (KP.P))
  34     disp ("Kronecker Product of A and B with");
  35     disp ("A = ");
  36     disp (KP.A);
  37     disp ("B = ");
  38     disp (KP.B);
  39   else
  40     disp ("Permuted Kronecker Product of A and B (i.e. P * kron (A, B) * P') with");
  41     disp ("A = ");
  42     disp (KP.A);
  43     disp ("B = ");
  44     disp (KP.B);
  45     disp ("P = ");
  46     disp (KP.P);
  47   endif
  48 endfunction