amd.cc File Reference

#include <cstdlib>
#include <string>
#include <vector>
#include "ov.h"
#include "defun-dld.h"
#include "pager.h"
#include "ov-re-mat.h"
#include "ov-re-sparse.h"
#include "ov-cx-sparse.h"
#include "oct-map.h"
#include "oct-sparse.h"
#include "oct-locbuf.h"

Include dependency graph for amd.cc:

Go to the source code of this file.

Macros
#define	AMD_NAME(name)   amd ## name

Functions

DEFUN_DLD (amd, args, nargout,"-*- texinfo -*-\n\ @deftypefn {Loadable Function} {@var{p} =} amd (@var{S})\n\ @deftypefnx {Loadable Function} {@var{p} =} amd (@var{S}, @var{opts})\n\ \n\ Return the approximate minimum degree permutation of a matrix. This\n\ permutation such that the Cholesky@tie{}factorization of @code{@var{S}\n\ (@var{p}, @var{p})} tends to be sparser than the Cholesky@tie{}factorization\n\ of @var{S} itself. @code{amd} is typically faster than @code{symamd} but\n\ serves a similar purpose.\n\ \n\ The optional parameter @var{opts} is a structure that controls the\n\ behavior of @code{amd}. The fields of the structure are\n\ \n\ @table @asis\n\ @item @var{opts}.dense\n\ Determines what @code{amd} considers to be a dense row or column of the\n\ input matrix. Rows or columns with more than @code{max(16, (dense *\n\ sqrt (@var{n})} entries, where @var{n} is the order of the matrix @var{S},\n\ are ignored by @code{amd} during the calculation of the permutation\n\ The value of dense must be a positive scalar and its default value is 10.0\n\ \n\ @item @var{opts}.aggressive\n\ If this value is a non zero scalar, then @code{amd} performs aggressive\n\ absorption. The default is not to perform aggressive absorption.\n\ @end table\n\ \n\ The author of the code itself is Timothy A. Davis\n\ @email{davis@@cise.ufl.edu}, University of Florida (see\n\ @url{http://www.cise.ufl.edu/research/sparse/amd}).\n\ @seealso{symamd, colamd}\n\ @end deftypefn")

Macro Definition Documentation

#define AMD_NAME

(

name

)

amd ## name

Definition at line 50 of file amd.cc.

Referenced by DEFUN_DLD().

Function Documentation

DEFUN_DLD	(	amd	,
		args	,
		nargout
	)

Definition at line 53 of file amd.cc.

References AMD_NAME, Sparse< T >::cols(), octave_value::double_value(), error(), error_state, Array< T >::fortran_vec(), octave_scalar_map::getfield(), octave_value::is_defined(), octave_value_list::length(), OCTAVE_LOCAL_BUFFER, print_usage(), real, Sparse< T >::rows(), Sparse< T >::xcidx(), Array< T >::xelem(), and Sparse< T >::xridx().