octave_packages/communications-1.1.1/@galois/sumsq.m

   1 ## Copyright (C) 2011 David Bateman
   2 ##
   3 ## This program is free software; you can redistribute it and/or modify it under
   4 ## the terms of the GNU General Public License as published by the Free Software
   5 ## Foundation; either version 3 of the License, or (at your option) any later
   6 ## version.
   7 ##
   8 ## This program is distributed in the hope that it will be useful, but WITHOUT
   9 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  11 ## details.
  12 ##
  13 ## You should have received a copy of the GNU General Public License along with
  14 ## this program; if not, see <http://www.gnu.org/licenses/>.
  15
  16 ## -*- texinfo -*-
  17 ## @deftypefn {Loadable Function} {} sumsq (@var{x}, @var{dim})
  18 ## Sum of squares of elements along dimension @var{dim} of Galois array.
  19 ## If @var{dim} is omitted, it defaults to 1 (column-wise sum of squares).
  20 ##
  21 ## This function is equivalent to computing
  22 ## @example
  23 ## gsum (x .* conj (x), dim)
  24 ## @end example
  25 ## but it uses less memory.
  26 ## @end deftypefn
  27
  28 function varargout = sumsq (varargin)
  29   varargout = cell (1, max(1, nargout));
  30   [varargout{:}] = gsumsq (varargin{:});
  31 endfunction