octave_packages/miscellaneous-1.1.0/nze.m

   1 ## Copyright (C) 2010 VZLU Prague
   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{y}, @var{f}] = } nze (@var{x})
  18 ## Extract nonzero elements of @var{x}. Equivalent to @code{@var{x}(@var{x} != 0)}.
  19 ## Optionally, returns also linear indices.
  20 ## @end deftypefn
  21
  22 ## Author:        Etienne Grossmann <etienne@cs.uky.edu>
  23 ## Author:        Jaroslav Hajek <highegg@gmail.com>
  24
  25 function [y, f] = nze (x)
  26   nz = x != 0;
  27   y = x(nz);
  28   if (nargout > 1)
  29     f = find (nz);
  30   endif
  31 endfunction