Mercurial > hg > octave-lyh
annotate scripts/sparse/etreeplot.m @ 10793:be55736a0783
Grammarcheck the documentation from m-files.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sun, 18 Jul 2010 20:35:16 -0700 |
parents | f084ba47812b |
children | c776f063fefe |
rev | line source |
---|---|
7017 | 1 ## Copyright (C) 2005, 2006, 2007 Ivana Varekova |
5576 | 2 ## |
7016 | 3 ## This file is part of Octave. |
5576 | 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. | |
9 ## | |
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. | |
5576 | 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/>. | |
5576 | 18 |
19 ## -*- texinfo -*- | |
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
7125
diff
changeset
|
20 ## @deftypefn {Function File} {} etreeplot (@var{tree}) |
5577 | 21 ## @deftypefnx {Function File} {} etreeplot (@var{tree}, @var{node_style}, @var{edge_style}) |
22 ## Plot the elimination tree of the matrix @var{s} or | |
23 ## @code{@var{s}+@var{s}'} if @var{s} in non-symmetric. The optional | |
24 ## parameters @var{line_style} and @var{edge_style} define the output | |
25 ## style. | |
5642 | 26 ## @seealso{treeplot, gplot} |
5576 | 27 ## @end deftypefn |
28 | |
29 function etreeplot (s, varargin) | |
7125 | 30 |
31 if (nargin < 1) | |
32 print_usage (); | |
33 endif | |
34 | |
5577 | 35 treeplot (etree (s+s'), varargin{:}); |
5576 | 36 endfunction |