symbfact.cc File Reference

#include "SparseCmplxCHOL.h"
#include "SparsedbleCHOL.h"
#include "oct-spparms.h"
#include "sparse-util.h"
#include "oct-locbuf.h"
#include "ov-re-sparse.h"
#include "ov-cx-sparse.h"
#include "defun-dld.h"
#include "error.h"
#include "gripes.h"
#include "oct-obj.h"
#include "utils.h"

Include dependency graph for symbfact.cc:

Go to the source code of this file.

Functions

DEFUN_DLD (symbfact, args, nargout,"-*- texinfo -*-\n\ @deftypefn {Loadable Function} {[@var{count}, @var{h}, @var{parent}, @var{post}, @var{r}] =} symbfact (@var{S})\n\ @deftypefnx {Loadable Function} {[@dots{}] =} symbfact (@var{S}, @var{typ})\n\ @deftypefnx {Loadable Function} {[@dots{}] =} symbfact (@var{S}, @var{typ}, @var{mode})\n\ \n\ Perform a symbolic factorization analysis on the sparse matrix @var{S}.\n\ Where\n\ \n\ @table @var\n\ @item S\n\ @var{S} is a complex or real sparse matrix.\n\ \n\ @item typ\n\ Is the type of the factorization and can be one of\n\ \n\ @table @samp\n\ @item sym\n\ Factorize @var{S}. This is the default.\n\ \n\ @item col\n\ Factorize @code{@var{S}' * @var{S}}.\n\ \n\ @item row\n\ Factorize @tcode{@var{S} * @var{S}'}.\n\ \n\ @item lo\n\ Factorize @tcode{@var{S}'}\n\ @end table\n\ \n\ @item mode\n\ The default is to return the Cholesky@tie{}factorization for @var{r}, and if\n\ @var{mode} is @qcode{'L'}, the conjugate transpose of the\n\ Cholesky@tie{}factorization is returned. The conjugate transpose version is\n\ faster and uses less memory, but returns the same values for @var{count},\n\ @var{h}, @var{parent} and @var{post} outputs.\n\ @end table\n\ \n\ The output variables are\n\ \n\ @table @var\n\ @item count\n\ The row counts of the Cholesky@tie{}factorization as determined by @var{typ}.\n\ \n\ @item h\n\ The height of the elimination tree.\n\ \n\ @item parent\n\ The elimination tree itself.\n\ \n\ @item post\n\ A sparse boolean matrix whose structure is that of the Cholesky\n\ factorization as determined by @var{typ}.\n\ @end table\n\ @end deftypefn")

Function Documentation

DEFUN_DLD	(	symbfact	,
		args	,
		nargout
	)

Definition at line 42 of file symbfact.cc.

References A, Sparse< T >::cidx(), coletree(), Sparse< T >::cols(), Sparse< T >::data(), error(), error_state, F(), octave_sparse_params::get_key(), gripe_wrong_type_arg(), octave_value_list::length(), Sparse< T >::nnz(), OCTAVE_LOCAL_BUFFER, print_usage(), Sparse< T >::ridx(), Sparse< T >::rows(), SparseCholError(), SparseCholPrint(), SparseBoolMatrix::transpose(), transpose(), Sparse< T >::xcidx(), Sparse< T >::xdata(), and Sparse< T >::xridx().