view scripts/sparse/spones.m @ 18848:53af80da6781 stable

doc: Update documentation of sparse functions including seealso links. * data.cc (Fall, Fany): Use non-zero instead of nonzero. * data.cc (Fnnz, Fnzmax, Ffull): Rewrite docstrings, include more seealso links. * sparse.cc (Fsparse): Rewrite docstring to include example of "sum" behavior and "unique" behavior. Add more seealso links. * sparse.cc (Fspalloc): Rewrite docstring, include more seealso links. * spparms.cc (Fspparms): Add seealso links. * amd.cc (Famd): Use nonzero instead of "non zero". * nonzeros.m: Add seealso links. * spaugment.m: Rewrite docstring, include more seealso links. * spconvert.m: Rewrite docstring, include more seealso links. * speye.m: Rewrite docstring, include more seealso links. * spones.m: Add seealso links. * sprand.m: Rewrite docstring, include more seealso links. * sprandn.m: Rewrite docstring, include more seealso links. * sprandsym.m: Rewrite docstring, include more seealso links. * spy.m: Rewrite docstring, include more seealso links.
author Rik <rik@octave.org>
date Sun, 08 Jun 2014 16:32:12 -0700
parents d63878346099
children 9ac2357f19bc
line wrap: on
line source

## Copyright (C) 2004-2013 David Bateman and Andy Adler
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Function File} {@var{r} =} spones (@var{S})
## Replace the non-zero entries of @var{S} with ones.  This creates a
## sparse matrix with the same structure as @var{S}.
## @seealso{sparse, sprand, sprandn, sprandsym, spfun, spy}
## @end deftypefn

function r = spones (S)

  if (nargin != 1)
    print_usage ();
  endif

  [i, j, v] = find (S);
  [m, n] = size (S);

  r = sparse (i, j, 1, m, n);

endfunction


%!assert (issparse (spones ([1,2;3,0])))
%!assert (spones ([1,2;3,0]), sparse ([1,1;1,0]))
%!assert (spones (sparse ([1,2;3,0])), sparse ([1,1;1,0]))