view 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
line wrap: on
line source

## Copyright (C) 2005, 2006, 2007 Ivana Varekova
##
## 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} {} etreeplot (@var{tree})
## @deftypefnx {Function File} {} etreeplot (@var{tree}, @var{node_style}, @var{edge_style})
## Plot the elimination tree of the matrix @var{s} or
## @code{@var{s}+@var{s}'}  if @var{s} in non-symmetric.  The optional
## parameters @var{line_style} and @var{edge_style} define the output
## style.
## @seealso{treeplot, gplot}
## @end deftypefn

function etreeplot (s, varargin)

  if (nargin < 1)
    print_usage ();
  endif

  treeplot (etree (s+s'), varargin{:});
endfunction