octave_packages/linear-algebra-2.2.0/@kronprod/numel.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} numel (@var{KP})
  18 ## Return the number of elements in the Kronecker product @var{KP}.
  19 ## @seealso{numel, @@kronprod/rows, @@kronprod/columns, @@kronprod/size}
  20 ## @end deftypefn
  21
  22 function retval = numel (KP)
  23   if (nargin != 1)
  24     print_usage ();
  25   endif
  26
  27   if (!isa (KP, "kronprod"))
  28     error ("numel: input must be of class 'kronprod'");
  29   endif
  30
  31   retval = prod (size (KP.A) .* size (KP.B));
  32 endfunction