Mercurial > octave
annotate libinterp/dldfcn/ccolamd.cc @ 23795:980f39c3ab90
Use C++11 nullptr rather than 0 in code (bug #51565).
* Backend.cc, BaseControl.h, ButtonGroup.cc, CheckBoxControl.cc,
Container.cc, ContextMenu.cc, ContextMenu.h, EditControl.cc, Figure.cc,
FigureWindow.cc, ListBoxControl.cc, Menu.cc, Menu.h, MouseModeActionGroup.cc,
Object.cc, ObjectProxy.cc, Panel.cc, PopupMenuControl.cc, PushButtonControl.cc,
PushTool.cc, RadioButtonControl.cc, SliderControl.cc, TextControl.cc,
ToggleButtonControl.cc, ToggleTool.cc, ToolBar.cc, ToolBar.h, ToolBarButton.cc,
ToolBarButton.h, QTerminal.h, BlockArray.cpp, Emulation.cpp, Filter.cpp,
Filter.h, History.cpp, KeyboardTranslator.cpp, QUnixTerminalImpl.h, Screen.cpp,
ScreenWindow.cpp, ScreenWindow.h, SelfListener.h, TerminalCharacterDecoder.cpp,
TerminalModel.cpp, TerminalView.cpp, TerminalView.h, kpty.cpp, dialog.cc,
dialog.h, files-dock-widget.cc, find-files-model.h, file-editor-tab.cc,
file-editor.cc, main-window.cc, octave-dock-widget.cc, octave-gui.cc,
parser.cc, resource-manager.cc, resource-manager.h, shortcut-manager.cc,
shortcut-manager.h, workspace-model.cc, workspace-view.cc, __magick_read__.cc,
c-file-ptr-stream.cc, c-file-ptr-stream.h, call-stack.cc, call-stack.h,
daspk.cc, dasrt.cc, dassl.cc, det.cc, display.h, error.cc, ft-text-renderer.cc,
gl-render.cc, gl2ps-print.cc, graphics.in.h, help.cc, input.cc, interpreter.cc,
load-path.cc, load-save.cc, ls-hdf5.cc, ls-hdf5.h, ls-mat5.cc, lsode.cc,
mex.cc, mxarray.in.h, oct-errno.h, oct-hist.cc, oct-iostrm.h, oct-procbuf.cc,
oct-procbuf.h, oct-stdstrm.h, oct-stream.cc, oct-stream.h, oct-strstrm.h,
oct-tex-parser.in.yy, octave-link.h, pager.cc, pager.h, pr-output.cc,
procstream.h, qz.cc, sighandlers.cc, svd.cc, symtab.cc, symtab.h,
text-renderer.cc, txt-eng.h, utils.cc, variables.cc, zfstream.cc, zfstream.h,
__glpk__.cc, __init_fltk__.cc, __ode15__.cc, audiodevinfo.cc, ccolamd.cc,
colamd.cc, dmperm.cc, gzip.cc, symbfact.cc, ov-base-int.cc, ov-base-int.h,
ov-base-mat.h, ov-base.cc, ov-base.h, ov-bool-mat.cc, ov-bool-sparse.cc,
ov-bool.cc, ov-builtin.h, ov-cell.cc, ov-class.cc, ov-complex.cc, ov-cx-mat.cc,
ov-cx-sparse.cc, ov-fcn-handle.cc, ov-fcn-inline.cc, ov-fcn.cc, ov-fcn.h,
ov-float.cc, ov-flt-complex.cc, ov-flt-cx-mat.cc, ov-flt-re-mat.cc, ov-java.cc,
ov-java.h, ov-mex-fcn.cc, ov-oncleanup.cc, ov-range.cc, ov-range.h,
ov-re-mat.cc, ov-re-sparse.cc, ov-scalar.cc, ov-str-mat.cc, ov-typeinfo.cc,
ov-typeinfo.h, ov-usr-fcn.cc, ov-usr-fcn.h, ov.cc, octave.cc, bp-table.cc,
bp-table.h, jit-ir.h, jit-typeinfo.cc, lex.h, profiler.cc, pt-arg-list.cc,
pt-array-list.cc, pt-assign.cc, pt-assign.h, pt-binop.cc, pt-binop.h,
pt-cell.cc, pt-classdef.cc, pt-classdef.h, pt-colon.cc, pt-colon.h, pt-decl.cc,
pt-decl.h, pt-eval.cc, pt-eval.h, pt-except.h, pt-fcn-handle.cc,
pt-fcn-handle.h, pt-idx.cc, pt-jit.cc, pt-loop.h, pt-mat.cc, pt-select.h,
pt-stmt.h, pt-tm-const.h, pt-unop.cc, pt-unop.h, pt.cc, Array-C.cc, Array-d.cc,
Array-f.cc, Array-fC.cc, Array-util.cc, Array.cc, Array.h, CMatrix.cc,
CSparse.cc, DiagArray2.h, MArray.h, MDiagArray2.h, MatrixType.cc, Sparse.cc,
Sparse.h, dMatrix.cc, dSparse.cc, fMatrix.cc, idx-vector.cc, idx-vector.h,
DAEFunc.h, DAERTFunc.h, ODEFunc.h, ODESFunc.h, eigs-base.cc, oct-fftw.cc,
oct-fftw.h, oct-rand.h, oct-spparms.h, schur.cc, sparse-chol.cc,
sparse-dmsolve.cc, sparse-lu.cc, sparse-qr.cc, child-list.h, dir-ops.cc,
dir-ops.h, file-ops.cc, lo-sysdep.cc, oct-env.h, oct-time.cc, cmd-edit.cc,
cmd-edit.h, cmd-hist.h, lo-regexp.cc, lo-regexp.h, lo-utils.cc, oct-shlib.cc,
oct-shlib.h, oct-sort.cc, oct-sort.h, quit.cc, singleton-cleanup.h, str-vec.cc:
Use C++11 nullptr rather than 0 in code (bug #51565).
author | Rik <rik@octave.org> |
---|---|
date | Tue, 25 Jul 2017 14:54:10 -0700 |
parents | cda0614beaec |
children | 336f89b6208b |
rev | line source |
---|---|
5451 | 1 /* |
2 | |
23219
3ac9f9ecfae5
maint: Update copyright dates.
John W. Eaton <jwe@octave.org>
parents:
23083
diff
changeset
|
3 Copyright (C) 2005-2017 David Bateman |
5451 | 4 |
7016 | 5 This file is part of Octave. |
6 | |
5451 | 7 Octave is free software; you can redistribute it and/or modify it |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
8 under the terms of the GNU General Public License as published by |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
9 the Free Software Foundation; either version 3 of the License, or |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
10 (at your option) any later version. |
5451 | 11 |
22755
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
12 Octave is distributed in the hope that it will be useful, but |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
13 WITHOUT ANY WARRANTY; without even the implied warranty of |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
3a2b891d0b33
maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents:
22407
diff
changeset
|
15 GNU General Public License for more details. |
5451 | 16 |
17 You should have received a copy of the GNU General Public License | |
7016 | 18 along with Octave; see the file COPYING. If not, see |
19 <http://www.gnu.org/licenses/>. | |
5451 | 20 |
21 */ | |
22 | |
23 // This is the octave interface to ccolamd, which bore the copyright given | |
24 // in the help of the functions. | |
25 | |
21724
aba2e6293dd8
use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents:
21691
diff
changeset
|
26 #if defined (HAVE_CONFIG_H) |
21301
40de9f8f23a6
Use '#include "config.h"' rather than <config.h>.
Rik <rik@octave.org>
parents:
21229
diff
changeset
|
27 # include "config.h" |
5451 | 28 #endif |
29 | |
30 #include <cstdlib> | |
31 | |
23024
a6a7b054e4ba
Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents:
22755
diff
changeset
|
32 #include "CSparse.h" |
a6a7b054e4ba
Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents:
22755
diff
changeset
|
33 #include "Sparse.h" |
a6a7b054e4ba
Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents:
22755
diff
changeset
|
34 #include "dNDArray.h" |
a6a7b054e4ba
Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents:
22755
diff
changeset
|
35 #include "oct-locbuf.h" |
a6a7b054e4ba
Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents:
22755
diff
changeset
|
36 #include "oct-sparse.h" |
5451 | 37 |
23024
a6a7b054e4ba
Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents:
22755
diff
changeset
|
38 #include "defun-dld.h" |
a6a7b054e4ba
Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents:
22755
diff
changeset
|
39 #include "error.h" |
a6a7b054e4ba
Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents:
22755
diff
changeset
|
40 #include "errwarn.h" |
5451 | 41 #include "ov.h" |
42 #include "pager.h" | |
43 | |
44 DEFUN_DLD (ccolamd, args, nargout, | |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
45 doc: /* -*- texinfo -*- |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
46 @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
|
47 @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
|
48 @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
|
49 @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
|
50 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
51 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
|
52 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
53 @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
|
54 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
|
55 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
|
56 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
|
57 @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
|
58 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
|
59 @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
|
60 @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
|
61 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
|
62 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
63 @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
|
64 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
|
65 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
|
66 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
67 @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
|
68 @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
|
69 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
|
70 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
|
71 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
|
72 |
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}(2) |
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 @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
|
75 @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
|
76 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
77 @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
|
78 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
|
79 @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
|
80 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
|
81 (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
|
82 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
83 @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
|
84 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
|
85 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
86 @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
|
87 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
|
88 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
89 @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
|
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 @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
|
92 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
|
93 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
|
94 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
|
95 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
|
96 @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
|
97 @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
|
98 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
99 @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
|
100 @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
|
101 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
|
102 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
|
103 (@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
|
104 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
|
105 @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
|
106 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
107 @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
|
108 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
|
109 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
|
110 @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
|
111 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
|
112 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
|
113 (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
|
114 integers). |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
115 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
116 @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
|
117 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
|
118 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
|
119 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
|
120 @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
|
121 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
|
122 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
|
123 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
|
124 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
|
125 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
126 The authors of the code itself are @nospell{S. Larimore, T. Davis} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
127 (Univ. of Florida) and @nospell{S. Rajamanickam} in collaboration with |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
128 @nospell{J. Bilbert and E. Ng}. Supported by the National Science Foundation |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
129 @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
|
130 @nospell{Sandia} National Lab. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
131 See @url{http://www.cise.ufl.edu/research/sparse} for |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
132 ccolamd, csymamd, amd, colamd, symamd, and other related orderings. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
133 @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
|
134 @end deftypefn */) |
5451 | 135 { |
21724
aba2e6293dd8
use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents:
21691
diff
changeset
|
136 #if defined (HAVE_CCOLAMD) |
5771 | 137 |
5451 | 138 int nargin = args.length (); |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
139 |
20909
03e4ddd49396
omit unnecessary nargout checks
John W. Eaton <jwe@octave.org>
parents:
20898
diff
changeset
|
140 if (nargin < 1 || nargin > 3) |
03e4ddd49396
omit unnecessary nargout checks
John W. Eaton <jwe@octave.org>
parents:
20898
diff
changeset
|
141 print_usage (); |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
142 |
20898
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20864
diff
changeset
|
143 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
|
144 int spumoni = 0; |
5451 | 145 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
146 // Get knobs |
23777
cda0614beaec
Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents:
23583
diff
changeset
|
147 static_assert (CCOLAMD_KNOBS <= 40, "ccolamd: # of CCOLAMD_KNOBS exceeded. Please report this to bugs.octave.org"); |
cda0614beaec
Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents:
23583
diff
changeset
|
148 double knob_storage[CCOLAMD_KNOBS]; |
cda0614beaec
Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents:
23583
diff
changeset
|
149 double *knobs = &knob_storage[0]; |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
150 CCOLAMD_NAME (_set_defaults) (knobs); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
151 |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
152 // Check for user-passed knobs |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
153 if (nargin > 1) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
154 { |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
155 NDArray User_knobs = args(1).array_value (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
156 int nel_User_knobs = User_knobs.numel (); |
5451 | 157 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
158 if (nel_User_knobs > 0) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
159 knobs[CCOLAMD_LU] = (User_knobs(0) != 0); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
160 if (nel_User_knobs > 1) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
161 knobs[CCOLAMD_DENSE_ROW] = User_knobs(1); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
162 if (nel_User_knobs > 2) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
163 knobs[CCOLAMD_DENSE_COL] = User_knobs(2); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
164 if (nel_User_knobs > 3) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
165 knobs[CCOLAMD_AGGRESSIVE] = (User_knobs(3) != 0); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
166 if (nel_User_knobs > 4) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
167 spumoni = (User_knobs(4) != 0); |
5451 | 168 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
169 // print knob settings if spumoni is set |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
170 if (spumoni) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
171 { |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
172 octave_stdout << "\nccolamd version " << CCOLAMD_MAIN_VERSION << "." |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
173 << CCOLAMD_SUB_VERSION << ", " << CCOLAMD_DATE |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
174 << ":\nknobs(1): " << User_knobs(0) << ", order for "; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
175 if (knobs[CCOLAMD_LU] != 0) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
176 octave_stdout << "lu (A)\n"; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
177 else |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
178 octave_stdout << "chol (A'*A)\n"; |
5451 | 179 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
180 if (knobs[CCOLAMD_DENSE_ROW] >= 0) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
181 octave_stdout << "knobs(2): " << User_knobs(1) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
182 << ", rows with > max (16," |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
183 << knobs[CCOLAMD_DENSE_ROW] |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
184 << "*sqrt (size(A,2)))" |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
185 << " entries removed\n"; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
186 else |
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 << ", no dense rows removed\n"; |
5451 | 189 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
190 if (knobs[CCOLAMD_DENSE_COL] >= 0) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
191 octave_stdout << "knobs(3): " << User_knobs(2) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
192 << ", cols with > max (16," |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
193 << knobs[CCOLAMD_DENSE_COL] << "*sqrt (size(A)))" |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
194 << " entries removed\n"; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
195 else |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
196 octave_stdout << "knobs(3): " << User_knobs(2) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
197 << ", no dense columns removed\n"; |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
198 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
199 if (knobs[CCOLAMD_AGGRESSIVE] != 0) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
200 octave_stdout << "knobs(4): " << User_knobs(3) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
201 << ", aggressive absorption: yes"; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
202 else |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
203 octave_stdout << "knobs(4): " << User_knobs(3) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
204 << ", aggressive absorption: no"; |
5451 | 205 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
206 octave_stdout << "knobs(5): " << User_knobs(4) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
207 << ", statistics and knobs printed\n"; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
208 } |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
209 } |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
210 |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
211 octave_idx_type n_row, n_col, nnz; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
212 octave_idx_type *ridx, *cidx; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
213 SparseComplexMatrix scm; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
214 SparseMatrix sm; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
215 |
23583
b7747a2c88b2
maint: Deprecate is_sparse_type and replace with issparse.
Rik <rik@octave.org>
parents:
23581
diff
changeset
|
216 if (args(0).issparse ()) |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
217 { |
23581
c3075ae020e1
maint: Deprecate is_complex_type and replace with iscomplex.
Rik <rik@octave.org>
parents:
23391
diff
changeset
|
218 if (args(0).iscomplex ()) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
219 { |
21751
b571fc85953f
maint: Use two spaces after period to indicate sentence break.
Rik <rik@octave.org>
parents:
21724
diff
changeset
|
220 scm = args(0).sparse_complex_matrix_value (); |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
221 n_row = scm.rows (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
222 n_col = scm.cols (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
223 nnz = scm.nnz (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
224 ridx = scm.xridx (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
225 cidx = scm.xcidx (); |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
226 } |
5451 | 227 else |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
228 { |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
229 sm = args(0).sparse_matrix_value (); |
5451 | 230 |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
231 n_row = sm.rows (); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
232 n_col = sm.cols (); |
10527
b4d2080b6df7
Replace nzmax by nnz as needed
David Bateman <dbateman@free.fr>
parents:
10282
diff
changeset
|
233 nnz = sm.nnz (); |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
234 ridx = sm.xridx (); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
235 cidx = sm.xcidx (); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
236 } |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
237 } |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
238 else |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
239 { |
23581
c3075ae020e1
maint: Deprecate is_complex_type and replace with iscomplex.
Rik <rik@octave.org>
parents:
23391
diff
changeset
|
240 if (args(0).iscomplex ()) |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
241 sm = SparseMatrix (real (args(0).complex_matrix_value ())); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
242 else |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
243 sm = SparseMatrix (args(0).matrix_value ()); |
5451 | 244 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
245 n_row = sm.rows (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
246 n_col = sm.cols (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
247 nnz = sm.nnz (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
248 ridx = sm.xridx (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
249 cidx = sm.xcidx (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
250 } |
5451 | 251 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
252 // Allocate workspace for ccolamd |
23391
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23390
diff
changeset
|
253 OCTAVE_LOCAL_BUFFER (octave::suitesparse_integer, p, n_col+1); |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
254 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
|
255 p[i] = cidx[i]; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
256 |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
257 octave_idx_type Alen = CCOLAMD_NAME (_recommended) (nnz, n_row, n_col); |
23391
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23390
diff
changeset
|
258 OCTAVE_LOCAL_BUFFER (octave::suitesparse_integer, A, Alen); |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
259 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
|
260 A[i] = ridx[i]; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
261 |
23777
cda0614beaec
Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents:
23583
diff
changeset
|
262 static_assert (CCOLAMD_STATS <= 40, "ccolamd: # of CCOLAMD_STATS exceeded. Please report this to bugs.octave.org"); |
cda0614beaec
Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents:
23583
diff
changeset
|
263 octave::suitesparse_integer stats_storage[CCOLAMD_STATS]; |
cda0614beaec
Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents:
23583
diff
changeset
|
264 octave::suitesparse_integer *stats = &stats_storage[0]; |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
265 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
266 if (nargin > 2) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
267 { |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
268 NDArray in_cmember = args(2).array_value (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
269 octave_idx_type cslen = in_cmember.numel (); |
23391
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23390
diff
changeset
|
270 OCTAVE_LOCAL_BUFFER (octave::suitesparse_integer, cmember, cslen); |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
271 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
|
272 // convert cmember from 1-based to 0-based |
23391
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23390
diff
changeset
|
273 cmember[i] = static_cast<octave::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
|
274 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
275 if (cslen != n_col) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
276 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
|
277 |
21055
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20955
diff
changeset
|
278 // Order the columns (destroys A) |
23391
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23390
diff
changeset
|
279 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
|
280 { |
21602
47c76e56a1de
maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
281 CCOLAMD_NAME (_report) (stats); |
21055
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20955
diff
changeset
|
282 |
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20955
diff
changeset
|
283 error ("ccolamd: internal error!"); |
5e00ed38a58b
maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents:
20955
diff
changeset
|
284 } |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
285 } |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
286 else |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
287 { |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
288 // 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
|
289 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
|
290 { |
21602
47c76e56a1de
maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
291 CCOLAMD_NAME (_report) (stats); |
5451 | 292 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
293 error ("ccolamd: internal error!"); |
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 } |
5451 | 296 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
297 // return the permutation vector |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
298 NDArray out_perm (dim_vector (1, n_col)); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
299 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
|
300 out_perm(i) = p[i] + 1; |
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 retval(0) = out_perm; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
303 |
21604
d7a268e68e69
maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents:
21602
diff
changeset
|
304 // print stats if spumoni > 0 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
305 if (spumoni > 0) |
21602
47c76e56a1de
maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
306 CCOLAMD_NAME (_report) (stats); |
5451 | 307 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
308 // Return the stats vector |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
309 if (nargout == 2) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
310 { |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
311 NDArray out_stats (dim_vector (1, CCOLAMD_STATS)); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
312 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
|
313 out_stats(i) = stats[i]; |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
314 retval(1) = out_stats; |
5451 | 315 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
316 // 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
|
317 // jumbled matrix. note that this correction doesn't |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
318 // 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
|
319 out_stats(CCOLAMD_INFO1)++; |
47c76e56a1de
maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
320 out_stats(CCOLAMD_INFO2)++; |
5451 | 321 } |
322 | |
20898
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20864
diff
changeset
|
323 return retval; |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20864
diff
changeset
|
324 |
5451 | 325 #else |
21691
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21604
diff
changeset
|
326 |
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21604
diff
changeset
|
327 octave_unused_parameter (args); |
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21604
diff
changeset
|
328 octave_unused_parameter (nargout); |
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21604
diff
changeset
|
329 |
21109
bd1752782e56
Use err_disabled_feature, warn_disabled_feature throughout code base.
Rik <rik@octave.org>
parents:
21055
diff
changeset
|
330 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
|
331 |
5451 | 332 #endif |
333 } | |
334 | |
335 DEFUN_DLD (csymamd, args, nargout, | |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
336 doc: /* -*- texinfo -*- |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
337 @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
|
338 @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
|
339 @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
|
340 @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
|
341 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
342 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
|
343 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
|
344 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
|
345 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
346 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
|
347 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
|
348 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
|
349 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
|
350 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
351 @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
|
352 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
|
353 defaults. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
354 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
355 @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
|
356 @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
|
357 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
|
358 @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
|
359 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
|
360 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
361 @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
|
362 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
|
363 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
364 @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
|
365 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
|
366 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
367 @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
|
368 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
369 @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
|
370 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
|
371 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
|
372 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
|
373 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
|
374 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
|
375 @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
|
376 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
377 @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
|
378 @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
|
379 differ. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
380 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
381 @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
|
382 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
|
383 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
|
384 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
|
385 @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
|
386 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
|
387 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
|
388 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
|
389 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
|
390 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
391 The authors of the code itself are @nospell{S. Larimore, T. Davis} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
392 (Univ. of Florida) and @nospell{S. Rajamanickam} in collaboration with |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
393 @nospell{J. Bilbert and E. Ng}. Supported by the National Science Foundation |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
394 @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
|
395 @nospell{Sandia} National Lab. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
396 See @url{http://www.cise.ufl.edu/research/sparse} for |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
397 ccolamd, csymamd, amd, colamd, symamd, and other related orderings. |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21751
diff
changeset
|
398 @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
|
399 @end deftypefn */) |
5451 | 400 { |
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
|
401 #if defined (HAVE_CCOLAMD) |
5771 | 402 |
5451 | 403 int nargin = args.length (); |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
404 |
20909
03e4ddd49396
omit unnecessary nargout checks
John W. Eaton <jwe@octave.org>
parents:
20898
diff
changeset
|
405 if (nargin < 1 || nargin > 3) |
03e4ddd49396
omit unnecessary nargout checks
John W. Eaton <jwe@octave.org>
parents:
20898
diff
changeset
|
406 print_usage (); |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
407 |
20898
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20864
diff
changeset
|
408 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
|
409 int spumoni = 0; |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
410 |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
411 // Get knobs |
23777
cda0614beaec
Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents:
23583
diff
changeset
|
412 static_assert (CCOLAMD_KNOBS <= 40, "csymamd: # of CCOLAMD_KNOBS exceeded. Please report this to bugs.octave.org"); |
cda0614beaec
Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents:
23583
diff
changeset
|
413 double knob_storage[CCOLAMD_KNOBS]; |
cda0614beaec
Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents:
23583
diff
changeset
|
414 double *knobs = &knob_storage[0]; |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
415 CCOLAMD_NAME (_set_defaults) (knobs); |
5451 | 416 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
417 // Check for user-passed knobs |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
418 if (nargin > 1) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
419 { |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
420 NDArray User_knobs = args(1).array_value (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
421 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
|
422 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
423 if (nel_User_knobs > 0) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
424 knobs[CCOLAMD_DENSE_ROW] = User_knobs(0); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
425 if (nel_User_knobs > 0) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
426 knobs[CCOLAMD_AGGRESSIVE] = User_knobs(1); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
427 if (nel_User_knobs > 1) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
428 spumoni = static_cast<int> (User_knobs(2)); |
5451 | 429 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
430 // print knob settings if spumoni is set |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
431 if (spumoni) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
432 { |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
433 octave_stdout << "\ncsymamd version " << CCOLAMD_MAIN_VERSION |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
434 << "." << CCOLAMD_SUB_VERSION |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
435 << ", " << CCOLAMD_DATE << "\n"; |
5451 | 436 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
437 if (knobs[CCOLAMD_DENSE_ROW] >= 0) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
438 octave_stdout << "knobs(1): " << User_knobs(0) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
439 << ", rows/cols with > max (16," |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
440 << knobs[CCOLAMD_DENSE_ROW] |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
441 << "*sqrt (size(A,2)))" |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
442 << " entries removed\n"; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
443 else |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
444 octave_stdout << "knobs(1): " << User_knobs(0) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
445 << ", no dense rows/cols removed\n"; |
5451 | 446 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
447 if (knobs[CCOLAMD_AGGRESSIVE] != 0) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
448 octave_stdout << "knobs(2): " << User_knobs(1) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
449 << ", aggressive absorption: yes"; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
450 else |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
451 octave_stdout << "knobs(2): " << User_knobs(1) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
452 << ", aggressive absorption: no"; |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
453 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
454 octave_stdout << "knobs(3): " << User_knobs(2) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
455 << ", statistics and knobs printed\n"; |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
456 } |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
457 } |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
458 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
459 octave_idx_type n_row, n_col; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
460 octave_idx_type *ridx, *cidx; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
461 SparseMatrix sm; |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
462 SparseComplexMatrix scm; |
5451 | 463 |
23583
b7747a2c88b2
maint: Deprecate is_sparse_type and replace with issparse.
Rik <rik@octave.org>
parents:
23581
diff
changeset
|
464 if (args(0).issparse ()) |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
465 { |
23581
c3075ae020e1
maint: Deprecate is_complex_type and replace with iscomplex.
Rik <rik@octave.org>
parents:
23391
diff
changeset
|
466 if (args(0).iscomplex ()) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
467 { |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
468 scm = args(0).sparse_complex_matrix_value (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
469 n_row = scm.rows (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
470 n_col = scm.cols (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
471 ridx = scm.xridx (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
472 cidx = scm.xcidx (); |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
473 } |
5451 | 474 else |
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 sm = args(0).sparse_matrix_value (); |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
477 n_row = sm.rows (); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
478 n_col = sm.cols (); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
479 ridx = sm.xridx (); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
480 cidx = sm.xcidx (); |
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
481 } |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
482 } |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
483 else |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
484 { |
23581
c3075ae020e1
maint: Deprecate is_complex_type and replace with iscomplex.
Rik <rik@octave.org>
parents:
23391
diff
changeset
|
485 if (args(0).iscomplex ()) |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
486 sm = SparseMatrix (real (args(0).complex_matrix_value ())); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
487 else |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
488 sm = SparseMatrix (args(0).matrix_value ()); |
5451 | 489 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
490 n_row = sm.rows (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
491 n_col = sm.cols (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
492 ridx = sm.xridx (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
493 cidx = sm.xcidx (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
494 } |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
495 |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
496 if (n_row != n_col) |
21110
3d0d84305600
Use err_square_matrix_required more widely.
Rik <rik@octave.org>
parents:
21109
diff
changeset
|
497 err_square_matrix_required ("csymamd", "S"); |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
498 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
499 // Allocate workspace for symamd |
23391
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23390
diff
changeset
|
500 OCTAVE_LOCAL_BUFFER (octave::suitesparse_integer, perm, n_col+1); |
23777
cda0614beaec
Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents:
23583
diff
changeset
|
501 static_assert (CCOLAMD_STATS <= 40, "csymamd: # of CCOLAMD_STATS exceeded. Please report this to bugs.octave.org"); |
cda0614beaec
Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents:
23583
diff
changeset
|
502 octave::suitesparse_integer stats_storage[CCOLAMD_STATS]; |
cda0614beaec
Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents:
23583
diff
changeset
|
503 octave::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
|
504 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
505 if (nargin > 2) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
506 { |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
507 NDArray in_cmember = args(2).array_value (); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
508 octave_idx_type cslen = in_cmember.numel (); |
23391
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23390
diff
changeset
|
509 OCTAVE_LOCAL_BUFFER (octave::suitesparse_integer, cmember, cslen); |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
510 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
|
511 // convert cmember from 1-based to 0-based |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
512 cmember[i] = static_cast<octave_idx_type>(in_cmember(i) - 1); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
513 |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
514 if (cslen != n_col) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
515 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
|
516 |
23391
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23390
diff
changeset
|
517 if (! CSYMAMD_NAME () (n_col, |
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23390
diff
changeset
|
518 octave::to_suitesparse_intptr (ridx), |
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23390
diff
changeset
|
519 octave::to_suitesparse_intptr (cidx), |
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23390
diff
changeset
|
520 perm, knobs, stats, &calloc, &free, cmember, -1)) |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
521 { |
21602
47c76e56a1de
maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
522 CSYMAMD_NAME (_report)(stats); |
5451 | 523 |
21602
47c76e56a1de
maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
524 error ("csymamd: internal error!"); |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
525 } |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
526 } |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
527 else |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
528 { |
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 if (! CSYMAMD_NAME () (n_col, |
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23390
diff
changeset
|
530 octave::to_suitesparse_intptr (ridx), |
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23390
diff
changeset
|
531 octave::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
|
532 perm, knobs, stats, &calloc, &free, nullptr, -1)) |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
533 { |
21602
47c76e56a1de
maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
534 CSYMAMD_NAME (_report)(stats); |
5451 | 535 |
21602
47c76e56a1de
maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
536 error ("csymamd: internal error!"); |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
537 } |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
538 } |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
539 |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
540 // return the permutation vector |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
541 NDArray out_perm (dim_vector (1, n_col)); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
542 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
|
543 out_perm(i) = perm[i] + 1; |
5451 | 544 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
545 retval(0) = out_perm; |
5451 | 546 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
547 // print stats if spumoni > 0 |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
548 if (spumoni > 0) |
21602
47c76e56a1de
maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
549 CSYMAMD_NAME (_report)(stats); |
5451 | 550 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
551 // Return the stats vector |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
552 if (nargout == 2) |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
553 { |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
554 NDArray out_stats (dim_vector (1, CCOLAMD_STATS)); |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
555 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
|
556 out_stats(i) = stats[i]; |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
557 retval(1) = out_stats; |
5451 | 558 |
20864
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
559 // 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
|
560 // jumbled matrix. note that this correction doesn't |
4c9df9f444db
2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
561 // 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
|
562 out_stats(CCOLAMD_INFO1)++; |
47c76e56a1de
maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents:
21547
diff
changeset
|
563 out_stats(CCOLAMD_INFO2)++; |
5451 | 564 } |
565 | |
20898
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20864
diff
changeset
|
566 return retval; |
8da80da1ac37
maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents:
20864
diff
changeset
|
567 |
5451 | 568 #else |
21691
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21604
diff
changeset
|
569 |
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21604
diff
changeset
|
570 octave_unused_parameter (args); |
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21604
diff
changeset
|
571 octave_unused_parameter (nargout); |
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21604
diff
changeset
|
572 |
21109
bd1752782e56
Use err_disabled_feature, warn_disabled_feature throughout code base.
Rik <rik@octave.org>
parents:
21055
diff
changeset
|
573 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
|
574 |
5451 | 575 #endif |
576 } |