octave: libinterp/corefcn/ccolamd.cc annotate

annotate 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

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 30390 diff changeset	3 // Copyright (C) 2005-2022 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	25
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	26 // This is the octave interface to ccolamd, which bore the copyright given
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	27 // in the help of the functions.
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	28
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21691 diff changeset	29 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21229 diff changeset	30 # include "config.h"
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	31 #endif
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	32
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	33 #include <cstdlib>
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	34
23024 a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory. Rik <rik@octave.org> parents: 22755 diff changeset	35 #include "CSparse.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory. Rik <rik@octave.org> parents: 22755 diff changeset	36 #include "Sparse.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory. Rik <rik@octave.org> parents: 22755 diff changeset	37 #include "dNDArray.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory. Rik <rik@octave.org> parents: 22755 diff changeset	38 #include "oct-locbuf.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory. Rik <rik@octave.org> parents: 22755 diff changeset	39 #include "oct-sparse.h"
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	40
28024 c28b8ba841fb move sparse functions from dldfcn to corefcn directory (bug #57459) John W. Eaton <jwe@octave.org> parents: 27932 diff changeset	41 #include "defun.h"
23024 a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory. Rik <rik@octave.org> parents: 22755 diff changeset	42 #include "error.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory. Rik <rik@octave.org> parents: 22755 diff changeset	43 #include "errwarn.h"
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	44 #include "ov.h"
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	45 #include "pager.h"
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	46
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30564 diff changeset	47 OCTAVE_BEGIN_NAMESPACE(octave)
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	48
28024 c28b8ba841fb move sparse functions from dldfcn to corefcn directory (bug #57459) John W. Eaton <jwe@octave.org> parents: 27932 diff changeset	49 DEFUN (ccolamd, args, nargout,
c28b8ba841fb move sparse functions from dldfcn to corefcn directory (bug #57459) John W. Eaton <jwe@octave.org> parents: 27932 diff changeset	50 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	51 @deftypefn {} {@var{p} =} ccolamd (@var{S})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	52 @deftypefnx {} {@var{p} =} ccolamd (@var{S}, @var{knobs})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	53 @deftypefnx {} {@var{p} =} ccolamd (@var{S}, @var{knobs}, @var{cmember})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	54 @deftypefnx {} {[@var{p}, @var{stats}] =} ccolamd (@dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	55
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	56 Constrained column approximate minimum degree permutation.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	57
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	58 @code{@var{p} = ccolamd (@var{S})} returns the column approximate minimum
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	59 degree permutation vector for the sparse matrix @var{S}. For a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	60 non-symmetric matrix @var{S}, @code{@var{S}(:, @var{p})} tends to have
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	61 sparser LU@tie{}factors than @var{S}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	62 @code{chol (@var{S}(:, @var{p})' * @var{S}(:, @var{p}))} also tends to be
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	63 sparser than @code{chol (@var{S}' * @var{S})}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	64 @code{@var{p} = ccolamd (@var{S}, 1)} optimizes the ordering for
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	65 @code{lu (@var{S}(:, @var{p}))}. The ordering is followed by a column
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	66 elimination tree post-ordering.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	67
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	68 @var{knobs} is an optional 1-element to 5-element input vector, with a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	69 default value of @code{[0 10 10 1 0]} if not present or empty. Entries not
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	70 present are set to their defaults.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	71
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	72 @table @code
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	73 @item @var{knobs}(1)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	74 if nonzero, the ordering is optimized for @code{lu (S(:, p))}. It will be a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	75 poor ordering for @code{chol (@var{S}(:, @var{p})' * @var{S}(:, @var{p}))}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	76 This is the most important knob for ccolamd.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	77
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	78 @item @var{knobs}(2)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	79 if @var{S} is m-by-n, rows with more than
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	80 @code{max (16, @var{knobs}(2) * sqrt (n))} entries are ignored.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	81
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	82 @item @var{knobs}(3)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	83 columns with more than
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	84 @code{max (16, @var{knobs}(3) * sqrt (min (@var{m}, @var{n})))} entries are
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	85 ignored and ordered last in the output permutation
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	86 (subject to the cmember constraints).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	87
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	88 @item @var{knobs}(4)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	89 if nonzero, aggressive absorption is performed.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	90
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	91 @item @var{knobs}(5)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	92 if nonzero, statistics and knobs are printed.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	93
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	94 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	95
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	96 @var{cmember} is an optional vector of length @math{n}. It defines the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	97 constraints on the column ordering. If @code{@var{cmember}(j) = @var{c}},
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	98 then column @var{j} is in constraint set @var{c} (@var{c} must be in the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	99 range 1 to n). In the output permutation @var{p}, all columns in set 1
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	100 appear first, followed by all columns in set 2, and so on.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	101 @code{@var{cmember} = ones (1,n)} if not present or empty.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	102 @code{ccolamd (@var{S}, [], 1 : n)} returns @code{1 : n}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	103
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	104 @code{@var{p} = ccolamd (@var{S})} is about the same as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	105 @code{@var{p} = colamd (@var{S})}. @var{knobs} and its default values
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	106 differ. @code{colamd} always does aggressive absorption, and it finds an
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	107 ordering suitable for both @code{lu (@var{S}(:, @var{p}))} and @code{chol
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	108 (@var{S}(:, @var{p})' * @var{S}(:, @var{p}))}; it cannot optimize its
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	109 ordering for @code{lu (@var{S}(:, @var{p}))} to the extent that
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	110 @code{ccolamd (@var{S}, 1)} can.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	111
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	112 @var{stats} is an optional 20-element output vector that provides data
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	113 about the ordering and the validity of the input matrix @var{S}. Ordering
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	114 statistics are in @code{@var{stats}(1 : 3)}. @code{@var{stats}(1)} and
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	115 @code{@var{stats}(2)} are the number of dense or empty rows and columns
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	116 ignored by @sc{ccolamd} and @code{@var{stats}(3)} is the number of garbage
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	117 collections performed on the internal data structure used by @sc{ccolamd}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	118 (roughly of size @code{2.2 * nnz (@var{S}) + 4 * @var{m} + 7 * @var{n}}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	119 integers).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	120
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	121 @code{@var{stats}(4 : 7)} provide information if CCOLAMD was able to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	122 continue. The matrix is OK if @code{@var{stats}(4)} is zero, or 1 if
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	123 invalid. @code{@var{stats}(5)} is the rightmost column index that is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	124 unsorted or contains duplicate entries, or zero if no such column exists.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	125 @code{@var{stats}(6)} is the last seen duplicate or out-of-order row
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	126 index in the column index given by @code{@var{stats}(5)}, or zero if no
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	127 such row index exists. @code{@var{stats}(7)} is the number of duplicate
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	128 or out-of-order row indices. @code{@var{stats}(8 : 20)} is always zero in
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	129 the current version of @sc{ccolamd} (reserved for future use).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	130
25143 13fd0610480f doc: Use https whenever possible in @url entries. Rik <rik@octave.org> parents: 25054 diff changeset	131 The authors of the code itself are @nospell{S. Larimore, T. Davis} and
13fd0610480f doc: Use https whenever possible in @url entries. Rik <rik@octave.org> parents: 25054 diff changeset	132 @nospell{S. Rajamanickam} in collaboration with @nospell{J. Bilbert and E. Ng}.
13fd0610480f doc: Use https whenever possible in @url entries. Rik <rik@octave.org> parents: 25054 diff changeset	133 Supported by the National Science Foundation
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	134 @nospell{(DMS-9504974, DMS-9803599, CCR-0203270)}, and a grant from
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	135 @nospell{Sandia} National Lab.
25143 13fd0610480f doc: Use https whenever possible in @url entries. Rik <rik@octave.org> parents: 25054 diff changeset	136 See @url{http://faculty.cse.tamu.edu/davis/suitesparse.html} for ccolamd,
13fd0610480f doc: Use https whenever possible in @url entries. Rik <rik@octave.org> parents: 25054 diff changeset	137 csymamd, amd, colamd, symamd, and other related orderings.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	138 @seealso{colamd, csymamd}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	139 @end deftypefn */)
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	140 {
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21691 diff changeset	141 #if defined (HAVE_CCOLAMD)
5771 9c7be8e14b5b [project @ 2006-04-18 19:17:33 by jwe] jwe parents: 5760 diff changeset	142
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	143 int nargin = args.length ();
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	144
20909 03e4ddd49396 omit unnecessary nargout checks John W. Eaton <jwe@octave.org> parents: 20898 diff changeset	145 if (nargin < 1 \|\| nargin > 3)
03e4ddd49396 omit unnecessary nargout checks John W. Eaton <jwe@octave.org> parents: 20898 diff changeset	146 print_usage ();
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	147
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20864 diff changeset	148 octave_value_list retval (nargout == 2 ? 2 : 1);
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20864 diff changeset	149 int spumoni = 0;
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	150
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	151 // Get knobs
27932 b018f553fd85 maint: Use Octave coding conventions in libinterp/ Rik <rik@octave.org> parents: 27923 diff changeset	152 static_assert (CCOLAMD_KNOBS <= 40,
b018f553fd85 maint: Use Octave coding conventions in libinterp/ Rik <rik@octave.org> parents: 27923 diff changeset	153 "ccolamd: # of CCOLAMD_KNOBS exceeded. Please report this to bugs.octave.org");
23777 cda0614beaec Replace static instances of OCTAVE_LOCAL_BUFFER with local variables. Rik <rik@octave.org> parents: 23583 diff changeset	154 double knob_storage[CCOLAMD_KNOBS];
cda0614beaec Replace static instances of OCTAVE_LOCAL_BUFFER with local variables. Rik <rik@octave.org> parents: 23583 diff changeset	155 double *knobs = &knob_storage[0];
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	156 CCOLAMD_NAME (_set_defaults) (knobs);
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	157
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	158 // Check for user-passed knobs
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	159 if (nargin > 1)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	160 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	161 NDArray User_knobs = args(1).array_value ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	162 int nel_User_knobs = User_knobs.numel ();
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	163
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	164 if (nel_User_knobs > 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	165 knobs[CCOLAMD_LU] = (User_knobs(0) != 0);
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	166 if (nel_User_knobs > 1)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	167 knobs[CCOLAMD_DENSE_ROW] = User_knobs(1);
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	168 if (nel_User_knobs > 2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	169 knobs[CCOLAMD_DENSE_COL] = User_knobs(2);
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	170 if (nel_User_knobs > 3)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	171 knobs[CCOLAMD_AGGRESSIVE] = (User_knobs(3) != 0);
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	172 if (nel_User_knobs > 4)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	173 spumoni = (User_knobs(4) != 0);
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	174
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	175 // print knob settings if spumoni is set
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	176 if (spumoni)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	177 {
23807 336f89b6208b Use character literals 'c' rather than string literals "c" when possible. Rik <rik@octave.org> parents: 23795 diff changeset	178 octave_stdout << "\nccolamd version " << CCOLAMD_MAIN_VERSION << '.'
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	179 << CCOLAMD_SUB_VERSION << ", " << CCOLAMD_DATE
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	180 << ":\nknobs(1): " << User_knobs(0) << ", order for ";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	181 if (knobs[CCOLAMD_LU] != 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	182 octave_stdout << "lu (A)\n";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	183 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	184 octave_stdout << "chol (A'*A)\n";
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	185
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	186 if (knobs[CCOLAMD_DENSE_ROW] >= 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	187 octave_stdout << "knobs(2): " << User_knobs(1)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	188 << ", rows with > max (16,"
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	189 << knobs[CCOLAMD_DENSE_ROW]
30236 628f26e122d9 maint: use rows() or columns() instead of size(__, 1 \| 2) for clarity. Rik <rik@octave.org> parents: 29961 diff changeset	190 << "*sqrt (columns(A)))"
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	191 << " entries removed\n";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	192 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	193 octave_stdout << "knobs(2): " << User_knobs(1)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	194 << ", no dense rows removed\n";
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	195
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	196 if (knobs[CCOLAMD_DENSE_COL] >= 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	197 octave_stdout << "knobs(3): " << User_knobs(2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	198 << ", cols with > max (16,"
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	199 << knobs[CCOLAMD_DENSE_COL] << "*sqrt (size(A)))"
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	200 << " entries removed\n";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	201 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	202 octave_stdout << "knobs(3): " << User_knobs(2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	203 << ", no dense columns removed\n";
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	204
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	205 if (knobs[CCOLAMD_AGGRESSIVE] != 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	206 octave_stdout << "knobs(4): " << User_knobs(3)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	207 << ", aggressive absorption: yes";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	208 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	209 octave_stdout << "knobs(4): " << User_knobs(3)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	210 << ", aggressive absorption: no";
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	211
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	212 octave_stdout << "knobs(5): " << User_knobs(4)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	213 << ", statistics and knobs printed\n";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	214 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	215 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	216
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	217 octave_idx_type n_row, n_col, nnz;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	218 octave_idx_type ridx, cidx;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	219 SparseComplexMatrix scm;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	220 SparseMatrix sm;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	221
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23581 diff changeset	222 if (args(0).issparse ())
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	223 {
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23391 diff changeset	224 if (args(0).iscomplex ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	225 {
21751 b571fc85953f maint: Use two spaces after period to indicate sentence break. Rik <rik@octave.org> parents: 21724 diff changeset	226 scm = args(0).sparse_complex_matrix_value ();
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	227 n_row = scm.rows ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	228 n_col = scm.cols ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	229 nnz = scm.nnz ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	230 ridx = scm.xridx ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	231 cidx = scm.xcidx ();
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	232 }
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	233 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	234 {
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	235 sm = args(0).sparse_matrix_value ();
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	236
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	237 n_row = sm.rows ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	238 n_col = sm.cols ();
10527 b4d2080b6df7 Replace nzmax by nnz as needed David Bateman <dbateman@free.fr> parents: 10282 diff changeset	239 nnz = sm.nnz ();
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	240 ridx = sm.xridx ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	241 cidx = sm.xcidx ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	242 }
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	243 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	244 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	245 {
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23391 diff changeset	246 if (args(0).iscomplex ())
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	247 sm = SparseMatrix (real (args(0).complex_matrix_value ()));
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	248 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	249 sm = SparseMatrix (args(0).matrix_value ());
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	250
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	251 n_row = sm.rows ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	252 n_col = sm.cols ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	253 nnz = sm.nnz ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	254 ridx = sm.xridx ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	255 cidx = sm.xcidx ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	256 }
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	257
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	258 // Allocate workspace for ccolamd
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	259 OCTAVE_LOCAL_BUFFER (suitesparse_integer, p, n_col+1);
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	260 for (octave_idx_type i = 0; i < n_col+1; i++)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	261 p[i] = cidx[i];
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	262
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	263 octave_idx_type Alen = CCOLAMD_NAME (_recommended) (nnz, n_row, n_col);
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	264 OCTAVE_LOCAL_BUFFER (suitesparse_integer, A, Alen);
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	265 for (octave_idx_type i = 0; i < nnz; i++)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	266 A[i] = ridx[i];
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	267
27932 b018f553fd85 maint: Use Octave coding conventions in libinterp/ Rik <rik@octave.org> parents: 27923 diff changeset	268 static_assert (CCOLAMD_STATS <= 40,
b018f553fd85 maint: Use Octave coding conventions in libinterp/ Rik <rik@octave.org> parents: 27923 diff changeset	269 "ccolamd: # of CCOLAMD_STATS exceeded. Please report this to bugs.octave.org");
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	270 suitesparse_integer stats_storage[CCOLAMD_STATS];
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	271 suitesparse_integer *stats = &stats_storage[0];
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	272
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	273 if (nargin > 2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	274 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	275 NDArray in_cmember = args(2).array_value ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	276 octave_idx_type cslen = in_cmember.numel ();
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	277 OCTAVE_LOCAL_BUFFER (suitesparse_integer, cmember, cslen);
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	278 for (octave_idx_type i = 0; i < cslen; i++)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	279 // convert cmember from 1-based to 0-based
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	280 cmember[i] = static_cast<suitesparse_integer>(in_cmember(i) - 1);
20825 66cd994d1b79 eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20232 diff changeset	281
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	282 if (cslen != n_col)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	283 error ("ccolamd: CMEMBER must be of length equal to #cols of A");
20825 66cd994d1b79 eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20232 diff changeset	284
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20955 diff changeset	285 // Order the columns (destroys A)
30390 a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release. Rik <rik@octave.org> parents: 30236 diff changeset	286 if (! CCOLAMD_NAME () (n_row, n_col, Alen, A, p, knobs, stats, cmember))
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20955 diff changeset	287 {
21602 47c76e56a1de maint: Remove extra space between end of statement and semicolon. Rik <rik@octave.org> parents: 21547 diff changeset	288 CCOLAMD_NAME (_report) (stats);
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20955 diff changeset	289
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20955 diff changeset	290 error ("ccolamd: internal error!");
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20955 diff changeset	291 }
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	292 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	293 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	294 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	295 // Order the columns (destroys A)
23795 980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565). Rik <rik@octave.org> parents: 23777 diff changeset	296 if (! CCOLAMD_NAME () (n_row, n_col, Alen, A, p, knobs, stats, nullptr))
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	297 {
21602 47c76e56a1de maint: Remove extra space between end of statement and semicolon. Rik <rik@octave.org> parents: 21547 diff changeset	298 CCOLAMD_NAME (_report) (stats);
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	299
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	300 error ("ccolamd: internal error!");
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	301 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	302 }
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	303
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	304 // return the permutation vector
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	305 NDArray out_perm (dim_vector (1, n_col));
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	306 for (octave_idx_type i = 0; i < n_col; i++)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	307 out_perm(i) = p[i] + 1;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	308
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	309 retval(0) = out_perm;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	310
21604 d7a268e68e69 maint: Strip trailing whitespace from source files. John W. Eaton <jwe@octave.org> parents: 21602 diff changeset	311 // print stats if spumoni > 0
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	312 if (spumoni > 0)
21602 47c76e56a1de maint: Remove extra space between end of statement and semicolon. Rik <rik@octave.org> parents: 21547 diff changeset	313 CCOLAMD_NAME (_report) (stats);
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	314
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	315 // Return the stats vector
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	316 if (nargout == 2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	317 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	318 NDArray out_stats (dim_vector (1, CCOLAMD_STATS));
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	319 for (octave_idx_type i = 0 ; i < CCOLAMD_STATS ; i++)
21602 47c76e56a1de maint: Remove extra space between end of statement and semicolon. Rik <rik@octave.org> parents: 21547 diff changeset	320 out_stats(i) = stats[i];
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	321 retval(1) = out_stats;
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	322
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	323 // fix stats (5) and (6), for 1-based information on
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	324 // jumbled matrix. note that this correction doesn't
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	325 // occur if symamd returns FALSE
21602 47c76e56a1de maint: Remove extra space between end of statement and semicolon. Rik <rik@octave.org> parents: 21547 diff changeset	326 out_stats(CCOLAMD_INFO1)++;
47c76e56a1de maint: Remove extra space between end of statement and semicolon. Rik <rik@octave.org> parents: 21547 diff changeset	327 out_stats(CCOLAMD_INFO2)++;
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	328 }
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	329
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20864 diff changeset	330 return retval;
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20864 diff changeset	331
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	332 #else
21691 263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21604 diff changeset	333
263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21604 diff changeset	334 octave_unused_parameter (args);
263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21604 diff changeset	335 octave_unused_parameter (nargout);
263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21604 diff changeset	336
21109 bd1752782e56 Use err_disabled_feature, warn_disabled_feature throughout code base. Rik <rik@octave.org> parents: 21055 diff changeset	337 err_disabled_feature ("ccolamd", "CCOLAMD");
21691 263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21604 diff changeset	338
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	339 #endif
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	340 }
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	341
28024 c28b8ba841fb move sparse functions from dldfcn to corefcn directory (bug #57459) John W. Eaton <jwe@octave.org> parents: 27932 diff changeset	342 DEFUN (csymamd, args, nargout,
c28b8ba841fb move sparse functions from dldfcn to corefcn directory (bug #57459) John W. Eaton <jwe@octave.org> parents: 27932 diff changeset	343 doc: /* -- texinfo --
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	344 @deftypefn {} {@var{p} =} csymamd (@var{S})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	345 @deftypefnx {} {@var{p} =} csymamd (@var{S}, @var{knobs})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	346 @deftypefnx {} {@var{p} =} csymamd (@var{S}, @var{knobs}, @var{cmember})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	347 @deftypefnx {} {[@var{p}, @var{stats}] =} csymamd (@dots{})
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	348
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	349 For a symmetric positive definite matrix @var{S}, return the permutation
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	350 vector @var{p} such that @code{@var{S}(@var{p},@var{p})} tends to have a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	351 sparser Cholesky@tie{}factor than @var{S}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	352
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	353 Sometimes @code{csymamd} works well for symmetric indefinite matrices too.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	354 The matrix @var{S} is assumed to be symmetric; only the strictly lower
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	355 triangular part is referenced. @var{S} must be square. The ordering is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	356 followed by an elimination tree post-ordering.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	357
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	358 @var{knobs} is an optional 1-element to 3-element input vector, with a
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	359 default value of @code{[10 1 0]}. Entries not present are set to their
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	360 defaults.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	361
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	362 @table @code
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	363 @item @var{knobs}(1)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	364 If @var{S} is n-by-n, then rows and columns with more than
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	365 @code{max(16,@var{knobs}(1)*sqrt(n))} entries are ignored, and ordered
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	366 last in the output permutation (subject to the cmember constraints).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	367
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	368 @item @var{knobs}(2)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	369 If nonzero, aggressive absorption is performed.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	370
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	371 @item @var{knobs}(3)
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	372 If nonzero, statistics and knobs are printed.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	373
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	374 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	375
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	376 @var{cmember} is an optional vector of length n. It defines the constraints
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	377 on the ordering. If @code{@var{cmember}(j) = @var{S}}, then row/column j is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	378 in constraint set @var{c} (@var{c} must be in the range 1 to n). In the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	379 output permutation @var{p}, rows/columns in set 1 appear first, followed
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	380 by all rows/columns in set 2, and so on. @code{@var{cmember} = ones (1,n)}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	381 if not present or empty. @code{csymamd (@var{S},[],1:n)} returns
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	382 @code{1:n}.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	383
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	384 @code{@var{p} = csymamd (@var{S})} is about the same as
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	385 @code{@var{p} = symamd (@var{S})}. @var{knobs} and its default values
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	386 differ.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	387
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	388 @code{@var{stats}(4:7)} provide information if CCOLAMD was able to
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	389 continue. The matrix is OK if @code{@var{stats}(4)} is zero, or 1 if
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	390 invalid. @code{@var{stats}(5)} is the rightmost column index that is
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	391 unsorted or contains duplicate entries, or zero if no such column exists.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	392 @code{@var{stats}(6)} is the last seen duplicate or out-of-order row
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	393 index in the column index given by @code{@var{stats}(5)}, or zero if no
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	394 such row index exists. @code{@var{stats}(7)} is the number of duplicate
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	395 or out-of-order row indices. @code{@var{stats}(8:20)} is always zero in
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	396 the current version of @sc{ccolamd} (reserved for future use).
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	397
25143 13fd0610480f doc: Use https whenever possible in @url entries. Rik <rik@octave.org> parents: 25054 diff changeset	398 The authors of the code itself are @nospell{S. Larimore, T. Davis} and
13fd0610480f doc: Use https whenever possible in @url entries. Rik <rik@octave.org> parents: 25054 diff changeset	399 @nospell{S. Rajamanickam} in collaboration with @nospell{J. Bilbert and E. Ng}.
13fd0610480f doc: Use https whenever possible in @url entries. Rik <rik@octave.org> parents: 25054 diff changeset	400 Supported by the National Science Foundation
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	401 @nospell{(DMS-9504974, DMS-9803599, CCR-0203270)}, and a grant from
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	402 @nospell{Sandia} National Lab.
25143 13fd0610480f doc: Use https whenever possible in @url entries. Rik <rik@octave.org> parents: 25054 diff changeset	403 See @url{http://faculty.cse.tamu.edu/davis/suitesparse.html} for ccolamd,
13fd0610480f doc: Use https whenever possible in @url entries. Rik <rik@octave.org> parents: 25054 diff changeset	404 colamd, csymamd, amd, colamd, symamd, and other related orderings.
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	405 @seealso{symamd, ccolamd}
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21751 diff changeset	406 @end deftypefn */)
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	407 {
21211 2cf8bc5c7017 use "#if defined (HAVE_FOO)" instead of "#if HAVE_FOO" for feature tests John W. Eaton <jwe@octave.org> parents: 21200 diff changeset	408 #if defined (HAVE_CCOLAMD)
5771 9c7be8e14b5b [project @ 2006-04-18 19:17:33 by jwe] jwe parents: 5760 diff changeset	409
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	410 int nargin = args.length ();
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	411
20909 03e4ddd49396 omit unnecessary nargout checks John W. Eaton <jwe@octave.org> parents: 20898 diff changeset	412 if (nargin < 1 \|\| nargin > 3)
03e4ddd49396 omit unnecessary nargout checks John W. Eaton <jwe@octave.org> parents: 20898 diff changeset	413 print_usage ();
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	414
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20864 diff changeset	415 octave_value_list retval (nargout == 2 ? 2 : 1);
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20864 diff changeset	416 int spumoni = 0;
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	417
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	418 // Get knobs
27932 b018f553fd85 maint: Use Octave coding conventions in libinterp/ Rik <rik@octave.org> parents: 27923 diff changeset	419 static_assert (CCOLAMD_KNOBS <= 40,
b018f553fd85 maint: Use Octave coding conventions in libinterp/ Rik <rik@octave.org> parents: 27923 diff changeset	420 "csymamd: # of CCOLAMD_KNOBS exceeded. Please report this to bugs.octave.org");
23777 cda0614beaec Replace static instances of OCTAVE_LOCAL_BUFFER with local variables. Rik <rik@octave.org> parents: 23583 diff changeset	421 double knob_storage[CCOLAMD_KNOBS];
cda0614beaec Replace static instances of OCTAVE_LOCAL_BUFFER with local variables. Rik <rik@octave.org> parents: 23583 diff changeset	422 double *knobs = &knob_storage[0];
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	423 CCOLAMD_NAME (_set_defaults) (knobs);
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	424
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	425 // Check for user-passed knobs
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	426 if (nargin > 1)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	427 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	428 NDArray User_knobs = args(1).array_value ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	429 int nel_User_knobs = User_knobs.numel ();
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	430
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	431 if (nel_User_knobs > 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	432 knobs[CCOLAMD_DENSE_ROW] = User_knobs(0);
26388 a480ccada034 ccolamd.cc: Fix static analyzer detected issues (bug #55347). Rik <rik@octave.org> parents: 26376 diff changeset	433 if (nel_User_knobs > 1)
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	434 knobs[CCOLAMD_AGGRESSIVE] = User_knobs(1);
26388 a480ccada034 ccolamd.cc: Fix static analyzer detected issues (bug #55347). Rik <rik@octave.org> parents: 26376 diff changeset	435 if (nel_User_knobs > 2)
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	436 spumoni = static_cast<int> (User_knobs(2));
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	437
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	438 // print knob settings if spumoni is set
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	439 if (spumoni)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	440 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	441 octave_stdout << "\ncsymamd version " << CCOLAMD_MAIN_VERSION
23807 336f89b6208b Use character literals 'c' rather than string literals "c" when possible. Rik <rik@octave.org> parents: 23795 diff changeset	442 << '.' << CCOLAMD_SUB_VERSION
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	443 << ", " << CCOLAMD_DATE << "\n";
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	444
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	445 if (knobs[CCOLAMD_DENSE_ROW] >= 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	446 octave_stdout << "knobs(1): " << User_knobs(0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	447 << ", rows/cols with > max (16,"
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	448 << knobs[CCOLAMD_DENSE_ROW]
30236 628f26e122d9 maint: use rows() or columns() instead of size(__, 1 \| 2) for clarity. Rik <rik@octave.org> parents: 29961 diff changeset	449 << "*sqrt (columns(A)))"
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	450 << " entries removed\n";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	451 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	452 octave_stdout << "knobs(1): " << User_knobs(0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	453 << ", no dense rows/cols removed\n";
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	454
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	455 if (knobs[CCOLAMD_AGGRESSIVE] != 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	456 octave_stdout << "knobs(2): " << User_knobs(1)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	457 << ", aggressive absorption: yes";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	458 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	459 octave_stdout << "knobs(2): " << User_knobs(1)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	460 << ", aggressive absorption: no";
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	461
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	462 octave_stdout << "knobs(3): " << User_knobs(2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	463 << ", statistics and knobs printed\n";
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	464 }
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	465 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	466
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	467 octave_idx_type n_row, n_col;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	468 octave_idx_type ridx, cidx;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	469 SparseMatrix sm;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	470 SparseComplexMatrix scm;
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	471
23583 b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse. Rik <rik@octave.org> parents: 23581 diff changeset	472 if (args(0).issparse ())
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	473 {
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23391 diff changeset	474 if (args(0).iscomplex ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	475 {
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	476 scm = args(0).sparse_complex_matrix_value ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	477 n_row = scm.rows ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	478 n_col = scm.cols ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	479 ridx = scm.xridx ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	480 cidx = scm.xcidx ();
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	481 }
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	482 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	483 {
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	484 sm = args(0).sparse_matrix_value ();
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	485 n_row = sm.rows ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	486 n_col = sm.cols ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	487 ridx = sm.xridx ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	488 cidx = sm.xcidx ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	489 }
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	490 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	491 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	492 {
23581 c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex. Rik <rik@octave.org> parents: 23391 diff changeset	493 if (args(0).iscomplex ())
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	494 sm = SparseMatrix (real (args(0).complex_matrix_value ()));
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	495 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	496 sm = SparseMatrix (args(0).matrix_value ());
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	497
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	498 n_row = sm.rows ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	499 n_col = sm.cols ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	500 ridx = sm.xridx ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	501 cidx = sm.xcidx ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	502 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	503
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	504 if (n_row != n_col)
21110 3d0d84305600 Use err_square_matrix_required more widely. Rik <rik@octave.org> parents: 21109 diff changeset	505 err_square_matrix_required ("csymamd", "S");
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	506
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	507 // Allocate workspace for symamd
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	508 OCTAVE_LOCAL_BUFFER (suitesparse_integer, perm, n_col+1);
27932 b018f553fd85 maint: Use Octave coding conventions in libinterp/ Rik <rik@octave.org> parents: 27923 diff changeset	509 static_assert (CCOLAMD_STATS <= 40,
b018f553fd85 maint: Use Octave coding conventions in libinterp/ Rik <rik@octave.org> parents: 27923 diff changeset	510 "csymamd: # of CCOLAMD_STATS exceeded. Please report this to bugs.octave.org");
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	511 suitesparse_integer stats_storage[CCOLAMD_STATS];
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	512 suitesparse_integer *stats = &stats_storage[0];
20825 66cd994d1b79 eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20232 diff changeset	513
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	514 if (nargin > 2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	515 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	516 NDArray in_cmember = args(2).array_value ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	517 octave_idx_type cslen = in_cmember.numel ();
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	518 OCTAVE_LOCAL_BUFFER (suitesparse_integer, cmember, cslen);
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	519 for (octave_idx_type i = 0; i < cslen; i++)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	520 // convert cmember from 1-based to 0-based
25688 b2917b7858ba maint: Use Octave convention for spacing of C++ cast statements. Rik <rik@octave.org> parents: 25143 diff changeset	521 cmember[i] = static_cast<octave_idx_type> (in_cmember(i) - 1);
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	522
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	523 if (cslen != n_col)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	524 error ("csymamd: CMEMBER must be of length equal to #cols of A");
21055 5e00ed38a58b maint: Replace if/error/else paradigm with just if/error. Rik <rik@octave.org> parents: 20955 diff changeset	525
23391 209e749363a2 safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510) John W. Eaton <jwe@octave.org> parents: 23390 diff changeset	526 if (! CSYMAMD_NAME () (n_col,
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	527 to_suitesparse_intptr (ridx),
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	528 to_suitesparse_intptr (cidx),
23391 209e749363a2 safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510) John W. Eaton <jwe@octave.org> parents: 23390 diff changeset	529 perm, knobs, stats, &calloc, &free, cmember, -1))
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	530 {
21602 47c76e56a1de maint: Remove extra space between end of statement and semicolon. Rik <rik@octave.org> parents: 21547 diff changeset	531 CSYMAMD_NAME (_report)(stats);
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	532
21602 47c76e56a1de maint: Remove extra space between end of statement and semicolon. Rik <rik@octave.org> parents: 21547 diff changeset	533 error ("csymamd: internal error!");
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	534 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	535 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	536 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	537 {
23391 209e749363a2 safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510) John W. Eaton <jwe@octave.org> parents: 23390 diff changeset	538 if (! CSYMAMD_NAME () (n_col,
29961 7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	539 to_suitesparse_intptr (ridx),
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more John W. Eaton <jwe@octave.org> parents: 29958 diff changeset	540 to_suitesparse_intptr (cidx),
23795 980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565). Rik <rik@octave.org> parents: 23777 diff changeset	541 perm, knobs, stats, &calloc, &free, nullptr, -1))
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	542 {
21602 47c76e56a1de maint: Remove extra space between end of statement and semicolon. Rik <rik@octave.org> parents: 21547 diff changeset	543 CSYMAMD_NAME (_report)(stats);
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	544
21602 47c76e56a1de maint: Remove extra space between end of statement and semicolon. Rik <rik@octave.org> parents: 21547 diff changeset	545 error ("csymamd: internal error!");
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	546 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	547 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	548
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	549 // return the permutation vector
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	550 NDArray out_perm (dim_vector (1, n_col));
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	551 for (octave_idx_type i = 0; i < n_col; i++)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	552 out_perm(i) = perm[i] + 1;
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	553
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	554 retval(0) = out_perm;
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	555
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	556 // print stats if spumoni > 0
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	557 if (spumoni > 0)
21602 47c76e56a1de maint: Remove extra space between end of statement and semicolon. Rik <rik@octave.org> parents: 21547 diff changeset	558 CSYMAMD_NAME (_report)(stats);
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	559
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	560 // Return the stats vector
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	561 if (nargout == 2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	562 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	563 NDArray out_stats (dim_vector (1, CCOLAMD_STATS));
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	564 for (octave_idx_type i = 0 ; i < CCOLAMD_STATS ; i++)
21602 47c76e56a1de maint: Remove extra space between end of statement and semicolon. Rik <rik@octave.org> parents: 21547 diff changeset	565 out_stats(i) = stats[i];
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	566 retval(1) = out_stats;
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	567
20864 4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	568 // fix stats (5) and (6), for 1-based information on
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	569 // jumbled matrix. note that this correction doesn't
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	570 // occur if symamd returns FALSE
21602 47c76e56a1de maint: Remove extra space between end of statement and semicolon. Rik <rik@octave.org> parents: 21547 diff changeset	571 out_stats(CCOLAMD_INFO1)++;
47c76e56a1de maint: Remove extra space between end of statement and semicolon. Rik <rik@octave.org> parents: 21547 diff changeset	572 out_stats(CCOLAMD_INFO2)++;
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	573 }
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	574
20898 8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20864 diff changeset	575 return retval;
8da80da1ac37 maint: Use ovl() more places in the code. Rik <rik@octave.org> parents: 20864 diff changeset	576
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	577 #else
21691 263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21604 diff changeset	578
263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21604 diff changeset	579 octave_unused_parameter (args);
263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21604 diff changeset	580 octave_unused_parameter (nargout);
263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21604 diff changeset	581
21109 bd1752782e56 Use err_disabled_feature, warn_disabled_feature throughout code base. Rik <rik@octave.org> parents: 21055 diff changeset	582 err_disabled_feature ("csymamd", "CCOLAMD");
21691 263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21604 diff changeset	583
5451 ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	584 #endif
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe] jwe parents: diff changeset	585 }
29958 32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 29358 diff changeset	586
31605 e88a07dec498 maint: Use macros to begin/end C++ namespaces. Rik <rik@octave.org> parents: 30564 diff changeset	587 OCTAVE_END_NAMESPACE(octave)

Mercurial > octave

annotate libinterp/corefcn/ccolamd.cc @ 31605:e88a07dec498 stable