Mercurial > octave
view libinterp/corefcn/ccolamd.cc @ 31605:e88a07dec498 stable
maint: Use macros to begin/end C++ namespaces.
* oct-conf-post-public.in.h: Define two macros (OCTAVE_BEGIN_NAMESPACE,
OCTAVE_END_NAMESPACE) that can be used to start/end a namespace.
* mk-opts.pl, build-env.h, build-env.in.cc, __betainc__.cc, __contourc__.cc,
__dsearchn__.cc, __eigs__.cc, __expint__.cc, __ftp__.cc, __gammainc__.cc,
__ichol__.cc, __ilu__.cc, __isprimelarge__.cc, __lin_interpn__.cc,
__magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, amd.cc, auto-shlib.cc,
auto-shlib.h, balance.cc, base-text-renderer.cc, base-text-renderer.h,
besselj.cc, bitfcns.cc, bsxfun.cc, c-file-ptr-stream.cc, c-file-ptr-stream.h,
call-stack.cc, call-stack.h, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc,
colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, data.h, debug.cc,
defaults.cc, defaults.h, defun-int.h, defun.cc, det.cc, dirfns.cc, display.cc,
display.h, dlmread.cc, dmperm.cc, dot.cc, dynamic-ld.cc, dynamic-ld.h, eig.cc,
ellipj.cc, environment.cc, environment.h, error.cc, error.h, errwarn.h,
event-manager.cc, event-manager.h, event-queue.cc, event-queue.h, fcn-info.cc,
fcn-info.h, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc,
ft-text-renderer.cc, ft-text-renderer.h, gcd.cc, getgrent.cc, getpwent.cc,
getrusage.cc, givens.cc, gl-render.cc, gl-render.h, gl2ps-print.cc,
gl2ps-print.h, graphics-toolkit.cc, graphics-toolkit.h, graphics.cc,
graphics.in.h, gsvd.cc, gtk-manager.cc, gtk-manager.h, hash.cc, help.cc,
help.h, hess.cc, hex2num.cc, hook-fcn.cc, hook-fcn.h, input.cc, input.h,
interpreter-private.cc, interpreter-private.h, interpreter.cc, interpreter.h,
inv.cc, jsondecode.cc, jsonencode.cc, kron.cc, latex-text-renderer.cc,
latex-text-renderer.h, load-path.cc, load-path.h, load-save.cc, load-save.h,
lookup.cc, ls-ascii-helper.cc, ls-ascii-helper.h, ls-oct-text.cc, ls-utils.cc,
ls-utils.h, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mex-private.h,
mex.cc, mgorth.cc, nproc.cc, oct-fstrm.cc, oct-fstrm.h, oct-hdf5-types.cc,
oct-hdf5-types.h, oct-hist.cc, oct-hist.h, oct-iostrm.cc, oct-iostrm.h,
oct-opengl.h, oct-prcstrm.cc, oct-prcstrm.h, oct-procbuf.cc, oct-procbuf.h,
oct-process.cc, oct-process.h, oct-stdstrm.h, oct-stream.cc, oct-stream.h,
oct-strstrm.cc, oct-strstrm.h, oct-tex-lexer.in.ll, oct-tex-parser.yy,
ordqz.cc, ordschur.cc, pager.cc, pager.h, pinv.cc, pow2.cc, pr-flt-fmt.cc,
pr-output.cc, procstream.cc, procstream.h, psi.cc, qr.cc, quad.cc, quadcc.cc,
qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, settings.cc, settings.h,
sighandlers.cc, sighandlers.h, sparse-xdiv.cc, sparse-xdiv.h, sparse-xpow.cc,
sparse-xpow.h, sparse.cc, spparms.cc, sqrtm.cc, stack-frame.cc, stack-frame.h,
stream-euler.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc,
symbfact.cc, syminfo.cc, syminfo.h, symrcm.cc, symrec.cc, symrec.h,
symscope.cc, symscope.h, symtab.cc, symtab.h, syscalls.cc, sysdep.cc, sysdep.h,
text-engine.cc, text-engine.h, text-renderer.cc, text-renderer.h, time.cc,
toplev.cc, tril.cc, tsearch.cc, typecast.cc, url-handle-manager.cc,
url-handle-manager.h, urlwrite.cc, utils.cc, utils.h, variables.cc,
variables.h, xdiv.cc, xdiv.h, xnorm.cc, xnorm.h, xpow.cc, xpow.h,
__delaunayn__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audiodevinfo.cc,
audioread.cc, convhulln.cc, fftw.cc, gzip.cc, mk-build-env-features.sh,
mk-builtins.pl, cdef-class.cc, cdef-class.h, cdef-fwd.h, cdef-manager.cc,
cdef-manager.h, cdef-method.cc, cdef-method.h, cdef-object.cc, cdef-object.h,
cdef-package.cc, cdef-package.h, cdef-property.cc, cdef-property.h,
cdef-utils.cc, cdef-utils.h, ov-base.cc, ov-base.h, ov-bool-mat.cc,
ov-builtin.h, ov-cell.cc, ov-class.cc, ov-class.h, ov-classdef.cc,
ov-classdef.h, ov-complex.cc, ov-fcn-handle.cc, ov-fcn-handle.h, ov-fcn.h,
ov-java.cc, ov-java.h, ov-mex-fcn.h, ov-null-mat.cc, ov-oncleanup.cc,
ov-struct.cc, ov-typeinfo.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov-usr-fcn.h,
ov.cc, ov.h, octave.cc, octave.h, mk-ops.sh, op-b-b.cc, op-b-bm.cc,
op-b-sbm.cc, op-bm-b.cc, op-bm-bm.cc, op-bm-sbm.cc, op-cdm-cdm.cc, op-cell.cc,
op-chm.cc, op-class.cc, op-cm-cm.cc, op-cm-cs.cc, op-cm-m.cc, op-cm-s.cc,
op-cm-scm.cc, op-cm-sm.cc, op-cs-cm.cc, op-cs-cs.cc, op-cs-m.cc, op-cs-s.cc,
op-cs-scm.cc, op-cs-sm.cc, op-dm-dm.cc, op-dm-scm.cc, op-dm-sm.cc,
op-dm-template.cc, op-dms-template.cc, op-fcdm-fcdm.cc, op-fcm-fcm.cc,
op-fcm-fcs.cc, op-fcm-fm.cc, op-fcm-fs.cc, op-fcn.cc, op-fcs-fcm.cc,
op-fcs-fcs.cc, op-fcs-fm.cc, op-fcs-fs.cc, op-fdm-fdm.cc, op-fm-fcm.cc,
op-fm-fcs.cc, op-fm-fm.cc, op-fm-fs.cc, op-fs-fcm.cc, op-fs-fcs.cc,
op-fs-fm.cc, op-fs-fs.cc, op-i16-i16.cc, op-i32-i32.cc, op-i64-i64.cc,
op-i8-i8.cc, op-int-concat.cc, op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc,
op-m-scm.cc, op-m-sm.cc, op-mi.cc, op-pm-pm.cc, op-pm-scm.cc, op-pm-sm.cc,
op-pm-template.cc, op-range.cc, op-s-cm.cc, op-s-cs.cc, op-s-m.cc, op-s-s.cc,
op-s-scm.cc, op-s-sm.cc, op-sbm-b.cc, op-sbm-bm.cc, op-sbm-sbm.cc,
op-scm-cm.cc, op-scm-cs.cc, op-scm-m.cc, op-scm-s.cc, op-scm-scm.cc,
op-scm-sm.cc, op-sm-cm.cc, op-sm-cs.cc, op-sm-m.cc, op-sm-s.cc, op-sm-scm.cc,
op-sm-sm.cc, op-str-m.cc, op-str-s.cc, op-str-str.cc, op-struct.cc,
op-ui16-ui16.cc, op-ui32-ui32.cc, op-ui64-ui64.cc, op-ui8-ui8.cc, ops.h,
anon-fcn-validator.cc, anon-fcn-validator.h, bp-table.cc, bp-table.h,
comment-list.cc, comment-list.h, filepos.h, lex.h, lex.ll, oct-lvalue.cc,
oct-lvalue.h, oct-parse.yy, parse.h, profiler.cc, profiler.h,
pt-anon-scopes.cc, pt-anon-scopes.h, pt-arg-list.cc, pt-arg-list.h,
pt-args-block.cc, pt-args-block.h, pt-array-list.cc, pt-array-list.h,
pt-assign.cc, pt-assign.h, pt-binop.cc, pt-binop.h, pt-bp.cc, pt-bp.h,
pt-cbinop.cc, pt-cbinop.h, pt-cell.cc, pt-cell.h, pt-check.cc, pt-check.h,
pt-classdef.cc, pt-classdef.h, pt-cmd.h, pt-colon.cc, pt-colon.h, pt-const.cc,
pt-const.h, pt-decl.cc, pt-decl.h, pt-eval.cc, pt-eval.h, pt-except.cc,
pt-except.h, pt-exp.cc, pt-exp.h, pt-fcn-handle.cc, pt-fcn-handle.h, pt-id.cc,
pt-id.h, pt-idx.cc, pt-idx.h, pt-jump.h, pt-loop.cc, pt-loop.h, pt-mat.cc,
pt-mat.h, pt-misc.cc, pt-misc.h, pt-pr-code.cc, pt-pr-code.h, pt-select.cc,
pt-select.h, pt-spmd.cc, pt-spmd.h, pt-stmt.cc, pt-stmt.h, pt-tm-const.cc,
pt-tm-const.h, pt-unop.cc, pt-unop.h, pt-vm-eval.cc, pt-walk.cc, pt-walk.h,
pt.cc, pt.h, token.cc, token.h, Range.cc, Range.h, idx-vector.cc, idx-vector.h,
range-fwd.h, CollocWt.cc, CollocWt.h, aepbalance.cc, aepbalance.h, chol.cc,
chol.h, gepbalance.cc, gepbalance.h, gsvd.cc, gsvd.h, hess.cc, hess.h,
lo-mappers.cc, lo-mappers.h, lo-specfun.cc, lo-specfun.h, lu.cc, lu.h,
oct-convn.cc, oct-convn.h, oct-fftw.cc, oct-fftw.h, oct-norm.cc, oct-norm.h,
oct-rand.cc, oct-rand.h, oct-spparms.cc, oct-spparms.h, qr.cc, qr.h, qrp.cc,
qrp.h, randgamma.cc, randgamma.h, randmtzig.cc, randmtzig.h, randpoisson.cc,
randpoisson.h, schur.cc, schur.h, sparse-chol.cc, sparse-chol.h, sparse-lu.cc,
sparse-lu.h, sparse-qr.cc, sparse-qr.h, svd.cc, svd.h, child-list.cc,
child-list.h, dir-ops.cc, dir-ops.h, file-ops.cc, file-ops.h, file-stat.cc,
file-stat.h, lo-sysdep.cc, lo-sysdep.h, lo-sysinfo.cc, lo-sysinfo.h,
mach-info.cc, mach-info.h, oct-env.cc, oct-env.h, oct-group.cc, oct-group.h,
oct-password.cc, oct-password.h, oct-syscalls.cc, oct-syscalls.h, oct-time.cc,
oct-time.h, oct-uname.cc, oct-uname.h, action-container.cc, action-container.h,
base-list.h, cmd-edit.cc, cmd-edit.h, cmd-hist.cc, cmd-hist.h, f77-fcn.h,
file-info.cc, file-info.h, lo-array-errwarn.cc, lo-array-errwarn.h, lo-hash.cc,
lo-hash.h, lo-ieee.h, lo-regexp.cc, lo-regexp.h, lo-utils.cc, lo-utils.h,
oct-base64.cc, oct-base64.h, oct-glob.cc, oct-glob.h, oct-inttypes.h,
oct-mutex.cc, oct-mutex.h, oct-refcount.h, oct-shlib.cc, oct-shlib.h,
oct-sparse.cc, oct-sparse.h, oct-string.h, octave-preserve-stream-state.h,
pathsearch.cc, pathsearch.h, quit.cc, quit.h, unwind-prot.cc, unwind-prot.h,
url-transfer.cc, url-transfer.h : Use new macros to begin/end C++ namespaces.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 01 Dec 2022 14:23:45 -0800 |
parents | 796f54d4ddbf |
children | aac27ad79be6 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 2005-2022 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // 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 // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// // This is the octave interface to ccolamd, which bore the copyright given // in the help of the functions. #if defined (HAVE_CONFIG_H) # include "config.h" #endif #include <cstdlib> #include "CSparse.h" #include "Sparse.h" #include "dNDArray.h" #include "oct-locbuf.h" #include "oct-sparse.h" #include "defun.h" #include "error.h" #include "errwarn.h" #include "ov.h" #include "pager.h" OCTAVE_BEGIN_NAMESPACE(octave) DEFUN (ccolamd, args, nargout, doc: /* -*- texinfo -*- @deftypefn {} {@var{p} =} ccolamd (@var{S}) @deftypefnx {} {@var{p} =} ccolamd (@var{S}, @var{knobs}) @deftypefnx {} {@var{p} =} ccolamd (@var{S}, @var{knobs}, @var{cmember}) @deftypefnx {} {[@var{p}, @var{stats}] =} ccolamd (@dots{}) Constrained column approximate minimum degree permutation. @code{@var{p} = ccolamd (@var{S})} returns the column approximate minimum degree permutation vector for the sparse matrix @var{S}. For a non-symmetric matrix @var{S}, @code{@var{S}(:, @var{p})} tends to have sparser LU@tie{}factors than @var{S}. @code{chol (@var{S}(:, @var{p})' * @var{S}(:, @var{p}))} also tends to be sparser than @code{chol (@var{S}' * @var{S})}. @code{@var{p} = ccolamd (@var{S}, 1)} optimizes the ordering for @code{lu (@var{S}(:, @var{p}))}. The ordering is followed by a column elimination tree post-ordering. @var{knobs} is an optional 1-element to 5-element input vector, with a default value of @code{[0 10 10 1 0]} if not present or empty. Entries not present are set to their defaults. @table @code @item @var{knobs}(1) if nonzero, the ordering is optimized for @code{lu (S(:, p))}. It will be a poor ordering for @code{chol (@var{S}(:, @var{p})' * @var{S}(:, @var{p}))}. This is the most important knob for ccolamd. @item @var{knobs}(2) if @var{S} is m-by-n, rows with more than @code{max (16, @var{knobs}(2) * sqrt (n))} entries are ignored. @item @var{knobs}(3) columns with more than @code{max (16, @var{knobs}(3) * sqrt (min (@var{m}, @var{n})))} entries are ignored and ordered last in the output permutation (subject to the cmember constraints). @item @var{knobs}(4) if nonzero, aggressive absorption is performed. @item @var{knobs}(5) if nonzero, statistics and knobs are printed. @end table @var{cmember} is an optional vector of length @math{n}. It defines the constraints on the column ordering. If @code{@var{cmember}(j) = @var{c}}, then column @var{j} is in constraint set @var{c} (@var{c} must be in the range 1 to n). In the output permutation @var{p}, all columns in set 1 appear first, followed by all columns in set 2, and so on. @code{@var{cmember} = ones (1,n)} if not present or empty. @code{ccolamd (@var{S}, [], 1 : n)} returns @code{1 : n} @code{@var{p} = ccolamd (@var{S})} is about the same as @code{@var{p} = colamd (@var{S})}. @var{knobs} and its default values differ. @code{colamd} always does aggressive absorption, and it finds an ordering suitable for both @code{lu (@var{S}(:, @var{p}))} and @code{chol (@var{S}(:, @var{p})' * @var{S}(:, @var{p}))}; it cannot optimize its ordering for @code{lu (@var{S}(:, @var{p}))} to the extent that @code{ccolamd (@var{S}, 1)} can. @var{stats} is an optional 20-element output vector that provides data about the ordering and the validity of the input matrix @var{S}. Ordering statistics are in @code{@var{stats}(1 : 3)}. @code{@var{stats}(1)} and @code{@var{stats}(2)} are the number of dense or empty rows and columns ignored by @sc{ccolamd} and @code{@var{stats}(3)} is the number of garbage collections performed on the internal data structure used by @sc{ccolamd} (roughly of size @code{2.2 * nnz (@var{S}) + 4 * @var{m} + 7 * @var{n}} integers). @code{@var{stats}(4 : 7)} provide information if CCOLAMD was able to continue. The matrix is OK if @code{@var{stats}(4)} is zero, or 1 if invalid. @code{@var{stats}(5)} is the rightmost column index that is unsorted or contains duplicate entries, or zero if no such column exists. @code{@var{stats}(6)} is the last seen duplicate or out-of-order row index in the column index given by @code{@var{stats}(5)}, or zero if no such row index exists. @code{@var{stats}(7)} is the number of duplicate or out-of-order row indices. @code{@var{stats}(8 : 20)} is always zero in the current version of @sc{ccolamd} (reserved for future use). The authors of the code itself are @nospell{S. Larimore, T. Davis} and @nospell{S. Rajamanickam} in collaboration with @nospell{J. Bilbert and E. Ng}. Supported by the National Science Foundation @nospell{(DMS-9504974, DMS-9803599, CCR-0203270)}, and a grant from @nospell{Sandia} National Lab. See @url{http://faculty.cse.tamu.edu/davis/suitesparse.html} for ccolamd, csymamd, amd, colamd, symamd, and other related orderings. @seealso{colamd, csymamd} @end deftypefn */) { #if defined (HAVE_CCOLAMD) int nargin = args.length (); if (nargin < 1 || nargin > 3) print_usage (); octave_value_list retval (nargout == 2 ? 2 : 1); int spumoni = 0; // Get knobs static_assert (CCOLAMD_KNOBS <= 40, "ccolamd: # of CCOLAMD_KNOBS exceeded. Please report this to bugs.octave.org"); double knob_storage[CCOLAMD_KNOBS]; double *knobs = &knob_storage[0]; CCOLAMD_NAME (_set_defaults) (knobs); // Check for user-passed knobs if (nargin > 1) { NDArray User_knobs = args(1).array_value (); int nel_User_knobs = User_knobs.numel (); if (nel_User_knobs > 0) knobs[CCOLAMD_LU] = (User_knobs(0) != 0); if (nel_User_knobs > 1) knobs[CCOLAMD_DENSE_ROW] = User_knobs(1); if (nel_User_knobs > 2) knobs[CCOLAMD_DENSE_COL] = User_knobs(2); if (nel_User_knobs > 3) knobs[CCOLAMD_AGGRESSIVE] = (User_knobs(3) != 0); if (nel_User_knobs > 4) spumoni = (User_knobs(4) != 0); // print knob settings if spumoni is set if (spumoni) { octave_stdout << "\nccolamd version " << CCOLAMD_MAIN_VERSION << '.' << CCOLAMD_SUB_VERSION << ", " << CCOLAMD_DATE << ":\nknobs(1): " << User_knobs(0) << ", order for "; if (knobs[CCOLAMD_LU] != 0) octave_stdout << "lu (A)\n"; else octave_stdout << "chol (A'*A)\n"; if (knobs[CCOLAMD_DENSE_ROW] >= 0) octave_stdout << "knobs(2): " << User_knobs(1) << ", rows with > max (16," << knobs[CCOLAMD_DENSE_ROW] << "*sqrt (columns(A)))" << " entries removed\n"; else octave_stdout << "knobs(2): " << User_knobs(1) << ", no dense rows removed\n"; if (knobs[CCOLAMD_DENSE_COL] >= 0) octave_stdout << "knobs(3): " << User_knobs(2) << ", cols with > max (16," << knobs[CCOLAMD_DENSE_COL] << "*sqrt (size(A)))" << " entries removed\n"; else octave_stdout << "knobs(3): " << User_knobs(2) << ", no dense columns removed\n"; if (knobs[CCOLAMD_AGGRESSIVE] != 0) octave_stdout << "knobs(4): " << User_knobs(3) << ", aggressive absorption: yes"; else octave_stdout << "knobs(4): " << User_knobs(3) << ", aggressive absorption: no"; octave_stdout << "knobs(5): " << User_knobs(4) << ", statistics and knobs printed\n"; } } octave_idx_type n_row, n_col, nnz; octave_idx_type *ridx, *cidx; SparseComplexMatrix scm; SparseMatrix sm; if (args(0).issparse ()) { if (args(0).iscomplex ()) { scm = args(0).sparse_complex_matrix_value (); n_row = scm.rows (); n_col = scm.cols (); nnz = scm.nnz (); ridx = scm.xridx (); cidx = scm.xcidx (); } else { sm = args(0).sparse_matrix_value (); n_row = sm.rows (); n_col = sm.cols (); nnz = sm.nnz (); ridx = sm.xridx (); cidx = sm.xcidx (); } } else { if (args(0).iscomplex ()) sm = SparseMatrix (real (args(0).complex_matrix_value ())); else sm = SparseMatrix (args(0).matrix_value ()); n_row = sm.rows (); n_col = sm.cols (); nnz = sm.nnz (); ridx = sm.xridx (); cidx = sm.xcidx (); } // Allocate workspace for ccolamd OCTAVE_LOCAL_BUFFER (suitesparse_integer, p, n_col+1); for (octave_idx_type i = 0; i < n_col+1; i++) p[i] = cidx[i]; octave_idx_type Alen = CCOLAMD_NAME (_recommended) (nnz, n_row, n_col); OCTAVE_LOCAL_BUFFER (suitesparse_integer, A, Alen); for (octave_idx_type i = 0; i < nnz; i++) A[i] = ridx[i]; static_assert (CCOLAMD_STATS <= 40, "ccolamd: # of CCOLAMD_STATS exceeded. Please report this to bugs.octave.org"); suitesparse_integer stats_storage[CCOLAMD_STATS]; suitesparse_integer *stats = &stats_storage[0]; if (nargin > 2) { NDArray in_cmember = args(2).array_value (); octave_idx_type cslen = in_cmember.numel (); OCTAVE_LOCAL_BUFFER (suitesparse_integer, cmember, cslen); for (octave_idx_type i = 0; i < cslen; i++) // convert cmember from 1-based to 0-based cmember[i] = static_cast<suitesparse_integer>(in_cmember(i) - 1); if (cslen != n_col) error ("ccolamd: CMEMBER must be of length equal to #cols of A"); // Order the columns (destroys A) if (! CCOLAMD_NAME () (n_row, n_col, Alen, A, p, knobs, stats, cmember)) { CCOLAMD_NAME (_report) (stats); error ("ccolamd: internal error!"); } } else { // Order the columns (destroys A) if (! CCOLAMD_NAME () (n_row, n_col, Alen, A, p, knobs, stats, nullptr)) { CCOLAMD_NAME (_report) (stats); error ("ccolamd: internal error!"); } } // return the permutation vector NDArray out_perm (dim_vector (1, n_col)); for (octave_idx_type i = 0; i < n_col; i++) out_perm(i) = p[i] + 1; retval(0) = out_perm; // print stats if spumoni > 0 if (spumoni > 0) CCOLAMD_NAME (_report) (stats); // Return the stats vector if (nargout == 2) { NDArray out_stats (dim_vector (1, CCOLAMD_STATS)); for (octave_idx_type i = 0 ; i < CCOLAMD_STATS ; i++) out_stats(i) = stats[i]; retval(1) = out_stats; // fix stats (5) and (6), for 1-based information on // jumbled matrix. note that this correction doesn't // occur if symamd returns FALSE out_stats(CCOLAMD_INFO1)++; out_stats(CCOLAMD_INFO2)++; } return retval; #else octave_unused_parameter (args); octave_unused_parameter (nargout); err_disabled_feature ("ccolamd", "CCOLAMD"); #endif } DEFUN (csymamd, args, nargout, doc: /* -*- texinfo -*- @deftypefn {} {@var{p} =} csymamd (@var{S}) @deftypefnx {} {@var{p} =} csymamd (@var{S}, @var{knobs}) @deftypefnx {} {@var{p} =} csymamd (@var{S}, @var{knobs}, @var{cmember}) @deftypefnx {} {[@var{p}, @var{stats}] =} csymamd (@dots{}) For a symmetric positive definite matrix @var{S}, return the permutation vector @var{p} such that @code{@var{S}(@var{p},@var{p})} tends to have a sparser Cholesky@tie{}factor than @var{S}. Sometimes @code{csymamd} works well for symmetric indefinite matrices too. The matrix @var{S} is assumed to be symmetric; only the strictly lower triangular part is referenced. @var{S} must be square. The ordering is followed by an elimination tree post-ordering. @var{knobs} is an optional 1-element to 3-element input vector, with a default value of @code{[10 1 0]}. Entries not present are set to their defaults. @table @code @item @var{knobs}(1) If @var{S} is n-by-n, then rows and columns with more than @code{max(16,@var{knobs}(1)*sqrt(n))} entries are ignored, and ordered last in the output permutation (subject to the cmember constraints). @item @var{knobs}(2) If nonzero, aggressive absorption is performed. @item @var{knobs}(3) If nonzero, statistics and knobs are printed. @end table @var{cmember} is an optional vector of length n. It defines the constraints on the ordering. If @code{@var{cmember}(j) = @var{S}}, then row/column j is in constraint set @var{c} (@var{c} must be in the range 1 to n). In the output permutation @var{p}, rows/columns in set 1 appear first, followed by all rows/columns in set 2, and so on. @code{@var{cmember} = ones (1,n)} if not present or empty. @code{csymamd (@var{S},[],1:n)} returns @code{1:n}. @code{@var{p} = csymamd (@var{S})} is about the same as @code{@var{p} = symamd (@var{S})}. @var{knobs} and its default values differ. @code{@var{stats}(4:7)} provide information if CCOLAMD was able to continue. The matrix is OK if @code{@var{stats}(4)} is zero, or 1 if invalid. @code{@var{stats}(5)} is the rightmost column index that is unsorted or contains duplicate entries, or zero if no such column exists. @code{@var{stats}(6)} is the last seen duplicate or out-of-order row index in the column index given by @code{@var{stats}(5)}, or zero if no such row index exists. @code{@var{stats}(7)} is the number of duplicate or out-of-order row indices. @code{@var{stats}(8:20)} is always zero in the current version of @sc{ccolamd} (reserved for future use). The authors of the code itself are @nospell{S. Larimore, T. Davis} and @nospell{S. Rajamanickam} in collaboration with @nospell{J. Bilbert and E. Ng}. Supported by the National Science Foundation @nospell{(DMS-9504974, DMS-9803599, CCR-0203270)}, and a grant from @nospell{Sandia} National Lab. See @url{http://faculty.cse.tamu.edu/davis/suitesparse.html} for ccolamd, colamd, csymamd, amd, colamd, symamd, and other related orderings. @seealso{symamd, ccolamd} @end deftypefn */) { #if defined (HAVE_CCOLAMD) int nargin = args.length (); if (nargin < 1 || nargin > 3) print_usage (); octave_value_list retval (nargout == 2 ? 2 : 1); int spumoni = 0; // Get knobs static_assert (CCOLAMD_KNOBS <= 40, "csymamd: # of CCOLAMD_KNOBS exceeded. Please report this to bugs.octave.org"); double knob_storage[CCOLAMD_KNOBS]; double *knobs = &knob_storage[0]; CCOLAMD_NAME (_set_defaults) (knobs); // Check for user-passed knobs if (nargin > 1) { NDArray User_knobs = args(1).array_value (); int nel_User_knobs = User_knobs.numel (); if (nel_User_knobs > 0) knobs[CCOLAMD_DENSE_ROW] = User_knobs(0); if (nel_User_knobs > 1) knobs[CCOLAMD_AGGRESSIVE] = User_knobs(1); if (nel_User_knobs > 2) spumoni = static_cast<int> (User_knobs(2)); // print knob settings if spumoni is set if (spumoni) { octave_stdout << "\ncsymamd version " << CCOLAMD_MAIN_VERSION << '.' << CCOLAMD_SUB_VERSION << ", " << CCOLAMD_DATE << "\n"; if (knobs[CCOLAMD_DENSE_ROW] >= 0) octave_stdout << "knobs(1): " << User_knobs(0) << ", rows/cols with > max (16," << knobs[CCOLAMD_DENSE_ROW] << "*sqrt (columns(A)))" << " entries removed\n"; else octave_stdout << "knobs(1): " << User_knobs(0) << ", no dense rows/cols removed\n"; if (knobs[CCOLAMD_AGGRESSIVE] != 0) octave_stdout << "knobs(2): " << User_knobs(1) << ", aggressive absorption: yes"; else octave_stdout << "knobs(2): " << User_knobs(1) << ", aggressive absorption: no"; octave_stdout << "knobs(3): " << User_knobs(2) << ", statistics and knobs printed\n"; } } octave_idx_type n_row, n_col; octave_idx_type *ridx, *cidx; SparseMatrix sm; SparseComplexMatrix scm; if (args(0).issparse ()) { if (args(0).iscomplex ()) { scm = args(0).sparse_complex_matrix_value (); n_row = scm.rows (); n_col = scm.cols (); ridx = scm.xridx (); cidx = scm.xcidx (); } else { sm = args(0).sparse_matrix_value (); n_row = sm.rows (); n_col = sm.cols (); ridx = sm.xridx (); cidx = sm.xcidx (); } } else { if (args(0).iscomplex ()) sm = SparseMatrix (real (args(0).complex_matrix_value ())); else sm = SparseMatrix (args(0).matrix_value ()); n_row = sm.rows (); n_col = sm.cols (); ridx = sm.xridx (); cidx = sm.xcidx (); } if (n_row != n_col) err_square_matrix_required ("csymamd", "S"); // Allocate workspace for symamd OCTAVE_LOCAL_BUFFER (suitesparse_integer, perm, n_col+1); static_assert (CCOLAMD_STATS <= 40, "csymamd: # of CCOLAMD_STATS exceeded. Please report this to bugs.octave.org"); suitesparse_integer stats_storage[CCOLAMD_STATS]; suitesparse_integer *stats = &stats_storage[0]; if (nargin > 2) { NDArray in_cmember = args(2).array_value (); octave_idx_type cslen = in_cmember.numel (); OCTAVE_LOCAL_BUFFER (suitesparse_integer, cmember, cslen); for (octave_idx_type i = 0; i < cslen; i++) // convert cmember from 1-based to 0-based cmember[i] = static_cast<octave_idx_type> (in_cmember(i) - 1); if (cslen != n_col) error ("csymamd: CMEMBER must be of length equal to #cols of A"); if (! CSYMAMD_NAME () (n_col, to_suitesparse_intptr (ridx), to_suitesparse_intptr (cidx), perm, knobs, stats, &calloc, &free, cmember, -1)) { CSYMAMD_NAME (_report)(stats); error ("csymamd: internal error!"); } } else { if (! CSYMAMD_NAME () (n_col, to_suitesparse_intptr (ridx), to_suitesparse_intptr (cidx), perm, knobs, stats, &calloc, &free, nullptr, -1)) { CSYMAMD_NAME (_report)(stats); error ("csymamd: internal error!"); } } // return the permutation vector NDArray out_perm (dim_vector (1, n_col)); for (octave_idx_type i = 0; i < n_col; i++) out_perm(i) = perm[i] + 1; retval(0) = out_perm; // print stats if spumoni > 0 if (spumoni > 0) CSYMAMD_NAME (_report)(stats); // Return the stats vector if (nargout == 2) { NDArray out_stats (dim_vector (1, CCOLAMD_STATS)); for (octave_idx_type i = 0 ; i < CCOLAMD_STATS ; i++) out_stats(i) = stats[i]; retval(1) = out_stats; // fix stats (5) and (6), for 1-based information on // jumbled matrix. note that this correction doesn't // occur if symamd returns FALSE out_stats(CCOLAMD_INFO1)++; out_stats(CCOLAMD_INFO2)++; } return retval; #else octave_unused_parameter (args); octave_unused_parameter (nargout); err_disabled_feature ("csymamd", "CCOLAMD"); #endif } OCTAVE_END_NAMESPACE(octave)