Mercurial > hg > octave-nkf
annotate scripts/sparse/etreeplot.m @ 17268:1c21f264d26f
doc: Rename @xcode macro to @tcode (transpose code) for clarity.
* doc/interpreter/macros.texi: Rename macro @xcode to @tcode.
* libinterp/corefcn/data.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/schur.cc, libinterp/dldfcn/symbfact.cc,
scripts/linear-algebra/krylov.m, scripts/sparse/etreeplot.m:
Rename @xcode macro instances to @tcode.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 17 Aug 2013 11:45:20 -0700 |
parents | 72c96de7a403 |
children | 1c89599167a6 |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
13780
diff
changeset
|
1 ## Copyright (C) 2005-2012 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 -*- | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
20 ## @deftypefn {Function File} {} etreeplot (@var{A}) |
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
21 ## @deftypefnx {Function File} {} etreeplot (@var{A}, @var{node_style}, @var{edge_style}) |
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
22 ## Plot the elimination tree of the matrix @var{A} or |
17268
1c21f264d26f
doc: Rename @xcode macro to @tcode (transpose code) for clarity.
Rik <rik@octave.org>
parents:
14138
diff
changeset
|
23 ## @tcode{@var{A}+@var{A}'} if @var{A} in not symmetric. The optional |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
24 ## parameters @var{node_style} and @var{edge_style} define the output |
5577 | 25 ## style. |
5642 | 26 ## @seealso{treeplot, gplot} |
5576 | 27 ## @end deftypefn |
28 | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
29 function etreeplot (A, varargin) |
7125 | 30 |
31 if (nargin < 1) | |
32 print_usage (); | |
33 endif | |
34 | |
11469
c776f063fefe
Overhaul m-script files to use common variable name between code and documentation.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
35 treeplot (etree (A+A'), varargin{:}); |
5576 | 36 endfunction |