Mercurial > hg > octave-nkf
view scripts/sparse/spy.m @ 10687:a8ce6bdecce5
Improve documentation strings.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Tue, 08 Jun 2010 20:22:38 -0700 |
parents | 1bf0ce0930be |
children | 600bdfb08540 |
line wrap: on
line source
## Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, ## 2007, 2008, 2009 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} {} spy (@var{x}) ## @deftypefnx {Function File} {} spy (@dots{}, @var{markersize}) ## @deftypefnx {Function File} {} spy (@dots{}, @var{line_spec}) ## Plot the sparsity pattern of the sparse matrix @var{x}. If the argument ## @var{markersize} is given as an scalar value, it is used to determine the ## point size in the plot. If the string @var{line_spec} is given it is ## passed to @code{plot} and determines the appearance of the plot. ## @seealso{plot} ## @end deftypefn function spy (x, varargin) if (nargin < 1) print_usage (); endif markersize = NaN; if (numel (i) < 1000) line_spec = "*"; else line_spec = "."; endif for i = 1:length (varargin) if (ischar (varargin{i})) line_spec = varargin{i}; elseif (isscalar (varargin{i})) markersize = varargin{i}; else error ("spy: expected markersize or linespec"); endif endfor [i, j, s] = find (x); [m, n] = size (x); if (isnan (markersize)) plot (j, i, line_spec); else plot (j, i, line_spec, "markersize", markersize); endif axis ([0, n+1, 0, m+1], "ij"); endfunction