octave_packages/general-1.3.1/ztvals.m

   1 ## Copyright (C) 2009 Jaroslav Hajek <highegg@gmail.com>
   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} {} function ztvals (@var{x}, @var{tol})
  18 ## Replaces tiny elements of the vector @var{x} by zeros.
  19 ## Equivalent to
  20 ## @example
  21 ##   @var{x}(abs(@var{x}) < @var{tol} * norm (@var{x}, Inf)) = 0
  22 ## @end example
  23 ## @var{tol} specifies the chopping tolerance. It defaults to
  24 ## 1e-10 for double precision and 1e-5 for single precision inputs.
  25 ## @end deftypefn
  26
  27 function x = ztvals (x, tol)
  28   if (nargin == 1)
  29     if (isa (x, 'single'))
  30       tol = 1e-5;
  31     else
  32       tol = 1e-10;
  33     endif
  34   elseif (nargin != 2)
  35     print_usage ();
  36   endif
  37
  38   if (isfloat (x))
  39     x(abs(x) < tol*norm (x, Inf)) = 0;
  40   else
  41     error ("ztvals: needs a floating-point argument");
  42   endif
  43
  44 endfunction