octave_packages/m/sparse/spones.m

   1 ## Copyright (C) 2004-2012 David Bateman and Andy Adler
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Function File} {@var{r} =} spones (@var{S})
  21 ## Replace the non-zero entries of @var{S} with ones.  This creates a
  22 ## sparse matrix with the same structure as @var{S}.
  23 ## @end deftypefn
  24
  25 function r = spones (S)
  26
  27   if (nargin != 1)
  28     print_usage ();
  29   endif
  30
  31   [i, j, v] = find (S);
  32   [m, n] = size (S);
  33
  34   r = sparse (i, j, 1, m, n);
  35
  36 endfunction
  37
  38 %!assert(issparse(spones([1,2;3,0])))
  39 %!assert(spones([1,2;3,0]),sparse([1,1;1,0]))
  40 %!assert(spones(sparse([1,2;3,0])),sparse([1,1;1,0]))