octave_packages/linear-algebra-2.2.0/@kronprod/size.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} size (@var{KP})
  18 ## @deftypefnx{Function File} size (@var{KP}, @var{dim})
  19 ## Return the size of the Kronecker product @var{KP} as a vector.
  20 ## @seealso{size, @@kronprod/rows, @@kronprod/columns, @@kronprod/numel}
  21 ## @end deftypefn
  22
  23 function retval = size (KP, dim)
  24   if (nargin < 1)
  25     print_usage ();
  26   endif
  27
  28   if (!isa (KP, "kronprod"))
  29     error ("size: input must be of class 'kronprod'");
  30   endif
  31   if (nargin > 1 && !(isscalar (dim) && dim == round (dim) && dim > 0))
  32     error ("size: optional second input must be a positive integer");
  33   endif
  34
  35   retval = size (KP.A) .* size (KP.B);
  36   if (nargin > 1)
  37     retval = retval (dim);
  38   endif
  39 endfunction