Mercurial > octave-antonio
annotate scripts/sparse/spy.m @ 20164:df437a52bcaf stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed miscellaneous, sparse, strings in scripts directory.
* scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m,
scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m,
scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m,
scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m,
scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m,
scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m,
scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m,
scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m,
scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m,
scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m,
scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m,
scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m,
scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m,
scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m,
scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m,
scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m,
scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m,
scripts/sparse/treeplot.m, scripts/strings/base2dec.m,
scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m,
scripts/strings/deblank.m, scripts/strings/dec2base.m,
scripts/strings/dec2bin.m, scripts/strings/dec2hex.m,
scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m,
scripts/strings/isletter.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/ostrsplit.m,
scripts/strings/regexptranslate.m, scripts/strings/rindex.m,
scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m,
scripts/strings/strjoin.m, scripts/strings/strjust.m,
scripts/strings/strmatch.m, scripts/strings/strsplit.m,
scripts/strings/strtok.m, scripts/strings/strtrim.m,
scripts/strings/strtrunc.m, scripts/strings/substr.m,
scripts/strings/untabify.m, scripts/time/datenum.m:
Update more docstrings to have one sentence summary as first line.
| author | Rik <rik@octave.org> |
|---|---|
| date | Mon, 04 May 2015 14:22:02 -0700 |
| parents | 9fc020886ae9 |
| children |
| rev | line source |
|---|---|
|
19697
4197fc428c7d
maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents:
19593
diff
changeset
|
1 ## Copyright (C) 1998-2015 Andy Adler |
| 7016 | 2 ## |
| 3 ## This file is part of Octave. | |
| 5164 | 4 ## |
| 7016 | 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. | |
| 5164 | 9 ## |
| 7016 | 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. | |
| 5164 | 14 ## |
| 15 ## You should have received a copy of the GNU General Public License | |
| 7016 | 16 ## along with Octave; see the file COPYING. If not, see |
| 17 ## <http://www.gnu.org/licenses/>. | |
| 5164 | 18 |
| 19 ## -*- texinfo -*- | |
|
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10714
diff
changeset
|
20 ## @deftypefn {Function File} {} spy (@var{x}) |
| 6607 | 21 ## @deftypefnx {Function File} {} spy (@dots{}, @var{markersize}) |
| 8507 | 22 ## @deftypefnx {Function File} {} spy (@dots{}, @var{line_spec}) |
|
18809
53af80da6781
doc: Update documentation of sparse functions including seealso links.
Rik <rik@octave.org>
parents:
18672
diff
changeset
|
23 ## Plot the sparsity pattern of the sparse matrix @var{x}. |
|
19593
446c46af4b42
strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents:
18809
diff
changeset
|
24 ## |
|
18809
53af80da6781
doc: Update documentation of sparse functions including seealso links.
Rik <rik@octave.org>
parents:
18672
diff
changeset
|
25 ## If the argument @var{markersize} is given as a scalar value, it is used to |
|
20164
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
26 ## determine the point size in the plot. |
|
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
27 ## |
|
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
28 ## If the string @var{line_spec} is given it is passed to @code{plot} and |
|
df437a52bcaf
doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents:
19833
diff
changeset
|
29 ## determines the appearance of the plot. |
|
18809
53af80da6781
doc: Update documentation of sparse functions including seealso links.
Rik <rik@octave.org>
parents:
18672
diff
changeset
|
30 ## @seealso{plot, gplot} |
| 5164 | 31 ## @end deftypefn |
| 32 | |
|
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11523
diff
changeset
|
33 function spy (x, varargin) |
| 6607 | 34 |
| 7125 | 35 if (nargin < 1) |
| 36 print_usage (); | |
| 37 endif | |
| 38 | |
| 6607 | 39 markersize = NaN; |
|
18672
3994a1c2b994
spy.m: Use nnz, not numel, to avoid overflowing octave_idx_type (bug #42116).
Rik <rik@octave.org>
parents:
17744
diff
changeset
|
40 if (nnz (x) < 1000) |
| 8507 | 41 line_spec = "*"; |
| 6607 | 42 else |
| 8507 | 43 line_spec = "."; |
| 6607 | 44 endif |
| 8507 | 45 for i = 1:length (varargin) |
| 46 if (ischar (varargin{i})) | |
|
13692
9d7233ec8cbc
add only color change possibility in spy.m
Fotios Kasolis <fotios.kasolis@gmail.com>
parents:
13086
diff
changeset
|
47 if (length (varargin{i}) == 1) |
|
9d7233ec8cbc
add only color change possibility in spy.m
Fotios Kasolis <fotios.kasolis@gmail.com>
parents:
13086
diff
changeset
|
48 line_spec = [line_spec, varargin{i}]; |
|
9d7233ec8cbc
add only color change possibility in spy.m
Fotios Kasolis <fotios.kasolis@gmail.com>
parents:
13086
diff
changeset
|
49 else |
|
9d7233ec8cbc
add only color change possibility in spy.m
Fotios Kasolis <fotios.kasolis@gmail.com>
parents:
13086
diff
changeset
|
50 line_spec = varargin{i}; |
|
9d7233ec8cbc
add only color change possibility in spy.m
Fotios Kasolis <fotios.kasolis@gmail.com>
parents:
13086
diff
changeset
|
51 endif |
| 6607 | 52 elseif (isscalar (varargin{i})) |
| 53 markersize = varargin{i}; | |
| 54 else | |
| 55 error ("spy: expected markersize or linespec"); | |
| 56 endif | |
| 57 endfor | |
| 6446 | 58 |
| 8507 | 59 [i, j, s] = find (x); |
| 60 [m, n] = size (x); | |
| 5164 | 61 |
| 6607 | 62 if (isnan (markersize)) |
| 8507 | 63 plot (j, i, line_spec); |
| 6446 | 64 else |
| 8507 | 65 plot (j, i, line_spec, "markersize", markersize); |
| 6446 | 66 endif |
| 5164 | 67 |
| 6674 | 68 axis ([0, n+1, 0, m+1], "ij"); |
| 5164 | 69 |
| 70 endfunction | |
|
13086
7015842c6562
codesprint: Add demo block for spy.m
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
71 |
|
7015842c6562
codesprint: Add demo block for spy.m
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
72 |
|
7015842c6562
codesprint: Add demo block for spy.m
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
73 %!demo |
|
7015842c6562
codesprint: Add demo block for spy.m
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
74 %! clf; |
|
7015842c6562
codesprint: Add demo block for spy.m
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
75 %! spy (sprand (10,10, 0.2)); |
|
7015842c6562
codesprint: Add demo block for spy.m
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
76 |
|
19833
9fc020886ae9
maint: Clean up m-files to follow Octave coding conventions.
Rik <rik@octave.org>
parents:
19697
diff
changeset
|
77 ## Mark graphical function as tested by demo block |
|
14363
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
78 %!assert (1) |
|
f3d52523cde1
Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
79 |