octave_packages/general-1.3.1/safeprod.m

   1 ## Copyright (C) 2008 VZLU Prague, a.s., Czech Republic
   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{Function File} {@var{p} =} safeprod (@var{x}, @var{dim})
  18 ## @deftypefnx{Function File} {[@var{p}, @var{e}] =} safeprod (@var{x}, @var{dim})
  19 ## This function forms product(s) of elements of the array @var{x} along the dimension
  20 ## specified by @var{dim}, analogically to @code{prod}, but avoids overflows and underflows
  21 ## if possible. If called with 2 output arguments, @var{p} and @var{e} are computed
  22 ## so that the product is @code{@var{p} * 2^@var{e}}.
  23 ## @seealso{prod,log2}
  24 ## @end deftypefn
  25
  26 ## Author: Jaroslav Hajek <highegg@gmail.com>
  27
  28 function [p, e] = safeprod (x, dim)
  29   if (nargin < 1 || nargin > 2)
  30     print_usage ();
  31   endif
  32
  33   if (nargin < 2)
  34     if (rows(x) == 1)
  35       dim = 2;
  36     else
  37       dim = 1;
  38     endif
  39   endif
  40
  41   % try the normal algorithm first
  42   if (nargout < 2)
  43     p = prod (x, dim);
  44   else
  45     p = 0;
  46   endif
  47
  48   % 0, Inf and NaN are possibly problematic results. If detected, use the safe
  49   % formula.
  50
  51   flag = (p == 0 | ! isfinite (p));
  52
  53   if (any (flag(:)))
  54     [f, e] = log2 (x);
  55     p = prod (f, dim);
  56     e = sum (e, dim);
  57     if (nargout < 2)
  58       p = p .* 2.^e;
  59     endif
  60   endif
  61
  62 endfunction