octave_packages/linear-algebra-2.2.0/@kronprod/minus.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} minus (@var{a}, @var{a})
  18 ## Return the difference between a Kronecker product and another matrix. This is performed
  19 ## by forming the full matrix of both inputs and is as such a potential expensive
  20 ## operation.
  21 ## @seealso{minus, @@kronprod/plus}
  22 ## @end deftypefn
  23
  24 function retval = minus (M1, M2)
  25   if (nargin != 2)
  26     print_usage ();
  27   endif
  28
  29   if (!ismatrix (M1) || !ismatrix (M2))
  30     error ("minus: both input arguments must be matrices");
  31   endif
  32
  33   if (!size_equal (M1, M2))
  34     error ("minus: nonconformant arguments (op1 is %dx%d, op2 is %dx%d)",
  35            rows (M1), columns (M1), rows (M2), columns (M2));
  36   endif
  37
  38   ## XXX: Can we do something smarter here?
  39   if (issparse (M1))
  40     M1 = sparse (M1);
  41   else
  42     M1 = full (M1);
  43   endif
  44
  45   if (issparse (M2))
  46     M2 = sparse (M2);
  47   else
  48     M2 = full (M2);
  49   endif
  50
  51   retval = M1 - M2;
  52 endfunction