octave-nkf: scripts/sparse/spfun.m annotate

annotate scripts/sparse/spfun.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	d63878346099
children	4197fc428c7d

rev	line source
17744 d63878346099 maint: Update copyright notices for release. John W. Eaton <jwe@octave.org> parents: 14868 diff changeset	1 ## Copyright (C) 2004-2013 David Bateman and Andy Adler
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.
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	4 ##
7016 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.
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	14 ##
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	15 ## You should have received a copy of the GNU General Public License
7016 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 --
11563 3c6e8aaa9555 Grammarcheck m-files before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	20 ## @deftypefn {Function File} {@var{y} =} spfun (@var{f}, @var{S})
19007 9ac2357f19bc doc: Replace "non-zero" with "nonzero" to match existing usage. Rik <rik@octave.org> parents: 17744 diff changeset	21 ## Compute @code{f(@var{S})} for the nonzero values of @var{S}.
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	22 ## This results in a sparse matrix with the same structure as
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10687 diff changeset	23 ## @var{S}. The function @var{f} can be passed as a string, a
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	24 ## function handle, or an inline function.
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 9245 diff changeset	25 ## @seealso{arrayfun, cellfun, structfun}
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	26 ## @end deftypefn
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	27
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10687 diff changeset	28 function y = spfun (f, S)
6498 2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe] jwe parents: 6220 diff changeset	29
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	30 if (nargin != 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5307 diff changeset	31 print_usage ();
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	32 endif
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	33
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10687 diff changeset	34 [i, j, v] = find (S);
c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10687 diff changeset	35 [m, n] = size (S);
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	36
6220 0c3537d2a844 [project @ 2006-12-30 17:29:34 by jwe] jwe parents: 6046 diff changeset	37 if (isa (f, "function_handle") \|\| isa (f, "inline function"))
11469 c776f063fefe Overhaul m-script files to use common variable name between code and documentation. Rik <octave@nomad.inbox5.com> parents: 10687 diff changeset	38 y = sparse (i, j, f(v), m, n);
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	39 else
14868 5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory Rik <octave@nomad.inbox5.com> parents: 14363 diff changeset	40 y = sparse (i, j, feval (f, v), m, n);
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	41 endif
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	42
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	43 endfunction
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	44
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	45
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	46 %!assert (spfun ("exp", [1,2;3,0]), sparse ([exp(1),exp(2);exp(3),0]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	47 %!assert (spfun ("exp", sparse ([1,2;3,0])), sparse ([exp(1),exp(2);exp(3),0]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	48 %!assert (spfun (@exp, [1,2;3,0]), sparse ([exp(1),exp(2);exp(3),0]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	49 %!assert (spfun (@exp, sparse ([1,2;3,0])), sparse ([exp(1),exp(2);exp(3),0]))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	50

Mercurial > hg > octave-nkf

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