annotate scripts/sparse/nonzeros.m @ 19007:9ac2357f19bc

doc: Replace "non-zero" with "nonzero" to match existing usage. Replace all occurrences in both documentation and code comments. * doc/interpreter/contrib.txi, doc/interpreter/diagperm.txi, doc/interpreter/external.txi, doc/interpreter/sparse.txi, doc/interpreter/stmt.txi, doc/interpreter/testfun.txi, doc/refcard/refcard.tex, examples/mysparse.c, libinterp/corefcn/balance.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/data.cc, libinterp/corefcn/filter.cc, libinterp/corefcn/find.cc, libinterp/corefcn/kron.cc, libinterp/corefcn/ls-mat5.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/mappers.cc, libinterp/corefcn/oct-fstrm.cc, libinterp/corefcn/oct-fstrm.h, libinterp/corefcn/oct-iostrm.cc, libinterp/corefcn/oct-iostrm.h, libinterp/corefcn/oct-stdstrm.h, libinterp/corefcn/oct-strstrm.h, libinterp/corefcn/spparms.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/utils.cc, libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-bool-mat.cc, liboctave/array/CSparse.cc, liboctave/array/Sparse.cc, liboctave/array/Sparse.h, liboctave/array/dSparse.cc, liboctave/numeric/randmtzig.c, liboctave/operators/Sparse-op-defs.h, scripts/help/get_first_help_sentence.m, scripts/miscellaneous/edit.m, scripts/plot/draw/pie.m, scripts/plot/draw/pie3.m, scripts/sparse/colperm.m, scripts/sparse/nonzeros.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprand.m, scripts/sparse/sprandn.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/svds.m, scripts/special-matrix/gallery.m, scripts/statistics/base/moment.m, scripts/statistics/tests/cor_test.m: Replace "non-zero" with "nonzero" to match existing usage.
author Rik <rik@octave.org>
date Sun, 08 Jun 2014 17:59:59 -0700
parents 53af80da6781
children 4197fc428c7d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 14363
diff changeset
1 ## Copyright (C) 2004-2013 Paul Kienzle
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
2 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
3 ## This file is part of Octave.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
4 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
13 ## General Public License for more details.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
14 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
15 ## You should have received a copy of the GNU General Public License
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
18
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
20 ## @deftypefn {Function File} {} nonzeros (@var{s})
19007
9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage.
Rik <rik@octave.org>
parents: 19004
diff changeset
21 ## Return a vector of the nonzero values of the sparse matrix @var{s}.
19004
53af80da6781 doc: Update documentation of sparse functions including seealso links.
Rik <rik@octave.org>
parents: 17744
diff changeset
22 ## @seealso{find, nnz}
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
23 ## @end deftypefn
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
24
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 5164
diff changeset
25 function t = nonzeros (s)
7125
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
26
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
27 if (nargin != 1)
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
28 print_usage ();
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
29 endif
f084ba47812b [project @ 2007-11-08 02:29:23 by jwe]
jwe
parents: 7017
diff changeset
30
12671
72e60cf50dce nonzeros.m: Ignore unused return arguments from find().
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
31 [~, ~, t] = find (s);
9425
e9f1329ed504 nonzeros: always return a column vector
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
32
e9f1329ed504 nonzeros: always return a column vector
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
33 t = t(:);
e9f1329ed504 nonzeros: always return a column vector
John W. Eaton <jwe@octave.org>
parents: 8920
diff changeset
34
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
35 endfunction
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
36
12671
72e60cf50dce nonzeros.m: Ignore unused return arguments from find().
Rik <octave@nomad.inbox5.com>
parents: 12575
diff changeset
37
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
38 %!assert (nonzeros ([1,2;3,0]), [1;3;2])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
39 %!assert (nonzeros ([1,2,3,0]), [1;2;3])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
40 %!assert (nonzeros (sparse ([1,2;3,0])), [1;3;2])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
41 %!assert (nonzeros (sparse ([1,2,3,0])), [1;2;3])
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
42