Mercurial > octave

annotate libinterp/dldfcn/ccolamd.cc @ 27919:1891570abac8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.
author John W. Eaton <jwe@octave.org>
date Mon, 06 Jan 2020 22:29:51 -0500
parents b442ec6dda5c
children bd51beb6205e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
1 /*
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
2
27919
1891570abac8 update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 27918
diff changeset
3 Copyright (C) 2005-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26388
diff changeset
4
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26388
diff changeset
5 See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26388
diff changeset
6 or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 26388
diff changeset
7
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
8
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5771
diff changeset
9 This file is part of Octave.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5771
diff changeset
10
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23807
diff changeset
11 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
12 under the terms of the GNU General Public License as published by
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23807
diff changeset
13 the Free Software Foundation, either version 3 of the License, or
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
14 (at your option) any later version.
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
15
22755
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
16 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
17 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting.
Rik <rik@octave.org>
parents: 22407
diff changeset
19 GNU General Public License for more details.
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
20
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
21 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5771
diff changeset
22 along with Octave; see the file COPYING. If not, see
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23807
diff changeset
23 <https://www.gnu.org/licenses/>.
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
24
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
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
27 // 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
28 // in the help of the functions.
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
29
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21691
diff changeset
30 #if defined (HAVE_CONFIG_H)
21301
40de9f8f23a6 Use '#include "config.h"' rather than <config.h>.
Rik <rik@octave.org>
parents: 21229
diff changeset
31 # include "config.h"
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
32 #endif
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
33
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
34 #include <cstdlib>
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
35
23024
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents: 22755
diff changeset
36 #include "CSparse.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents: 22755
diff changeset
37 #include "Sparse.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents: 22755
diff changeset
38 #include "dNDArray.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents: 22755
diff changeset
39 #include "oct-locbuf.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents: 22755
diff changeset
40 #include "oct-sparse.h"
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
41
23024
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents: 22755
diff changeset
42 #include "defun-dld.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents: 22755
diff changeset
43 #include "error.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents: 22755
diff changeset
44 #include "errwarn.h"
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
45 #include "ov.h"
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
46 #include "pager.h"
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
47
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
48 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
49 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
50 @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
51 @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
52 @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
53 @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
54
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
55 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
56
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{@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
58 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
59 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
60 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
61 @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
62 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
63 @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
64 @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
65 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
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 @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
68 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
69 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
70
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
71 @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
72 @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
73 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
74 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
75 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
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}(2)
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
78 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
79 @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
80
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
81 @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
82 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
83 @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
84 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
85 (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
86
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
87 @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
88 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
89
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
90 @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
91 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
92
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
93 @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
94
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
95 @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
96 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
97 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
98 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
99 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
100 @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
101 @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
102
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
103 @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
104 @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
105 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
106 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
107 (@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
108 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
109 @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
110
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
111 @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
112 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
113 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
114 @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
115 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
116 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
117 (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
118 integers).
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
119
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}(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
121 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
122 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
123 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
124 @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
125 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
126 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
127 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
128 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
129
25143
13fd0610480f doc: Use https whenever possible in @url entries.
Rik <rik@octave.org>
parents: 25054
diff changeset
130 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
131 @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
132 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
133 @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
134 @nospell{Sandia} National Lab.
25143
13fd0610480f doc: Use https whenever possible in @url entries.
Rik <rik@octave.org>
parents: 25054
diff changeset
135 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
136 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
137 @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
138 @end deftypefn */)
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
139 {
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21691
diff changeset
140 #if defined (HAVE_CCOLAMD)
5771
9c7be8e14b5b [project @ 2006-04-18 19:17:33 by jwe]
jwe
parents: 5760
diff changeset
141
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
142 int nargin = args.length ();
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
143
20909
03e4ddd49396 omit unnecessary nargout checks
John W. Eaton <jwe@octave.org>
parents: 20898
diff changeset
144 if (nargin < 1 || nargin > 3)
03e4ddd49396 omit unnecessary nargout checks
John W. Eaton <jwe@octave.org>
parents: 20898
diff changeset
145 print_usage ();
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
146
20898
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20864
diff changeset
147 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
148 int spumoni = 0;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
149
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
150 // Get knobs
23777
cda0614beaec Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents: 23583
diff changeset
151 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
152 double knob_storage[CCOLAMD_KNOBS];
cda0614beaec Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents: 23583
diff changeset
153 double *knobs = &knob_storage[0];
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
154 CCOLAMD_NAME (_set_defaults) (knobs);
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
155
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
156 // Check for user-passed knobs
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
157 if (nargin > 1)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
158 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
159 NDArray User_knobs = args(1).array_value ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
160 int nel_User_knobs = User_knobs.numel ();
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
161
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
162 if (nel_User_knobs > 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
163 knobs[CCOLAMD_LU] = (User_knobs(0) != 0);
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
164 if (nel_User_knobs > 1)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
165 knobs[CCOLAMD_DENSE_ROW] = User_knobs(1);
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
166 if (nel_User_knobs > 2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
167 knobs[CCOLAMD_DENSE_COL] = User_knobs(2);
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
168 if (nel_User_knobs > 3)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
169 knobs[CCOLAMD_AGGRESSIVE] = (User_knobs(3) != 0);
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
170 if (nel_User_knobs > 4)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
171 spumoni = (User_knobs(4) != 0);
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
172
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
173 // print knob settings if spumoni is set
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
174 if (spumoni)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
175 {
23807
336f89b6208b Use character literals 'c' rather than string literals "c" when possible.
Rik <rik@octave.org>
parents: 23795
diff changeset
176 octave_stdout << "\nccolamd version " << CCOLAMD_MAIN_VERSION << '.'
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
177 << CCOLAMD_SUB_VERSION << ", " << CCOLAMD_DATE
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
178 << ":\nknobs(1): " << User_knobs(0) << ", order for ";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
179 if (knobs[CCOLAMD_LU] != 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
180 octave_stdout << "lu (A)\n";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
181 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
182 octave_stdout << "chol (A'*A)\n";
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
183
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
184 if (knobs[CCOLAMD_DENSE_ROW] >= 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
185 octave_stdout << "knobs(2): " << User_knobs(1)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
186 << ", rows with > max (16,"
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
187 << knobs[CCOLAMD_DENSE_ROW]
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
188 << "*sqrt (size(A,2)))"
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
189 << " entries removed\n";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
190 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
191 octave_stdout << "knobs(2): " << User_knobs(1)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
192 << ", no dense rows removed\n";
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
193
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
194 if (knobs[CCOLAMD_DENSE_COL] >= 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
195 octave_stdout << "knobs(3): " << User_knobs(2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
196 << ", cols with > max (16,"
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
197 << knobs[CCOLAMD_DENSE_COL] << "*sqrt (size(A)))"
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
198 << " entries removed\n";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
199 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
200 octave_stdout << "knobs(3): " << User_knobs(2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
201 << ", no dense columns removed\n";
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
202
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
203 if (knobs[CCOLAMD_AGGRESSIVE] != 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
204 octave_stdout << "knobs(4): " << User_knobs(3)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
205 << ", aggressive absorption: yes";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
206 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
207 octave_stdout << "knobs(4): " << User_knobs(3)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
208 << ", aggressive absorption: no";
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
209
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
210 octave_stdout << "knobs(5): " << User_knobs(4)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
211 << ", statistics and knobs printed\n";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
212 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
213 }
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 octave_idx_type n_row, n_col, nnz;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
216 octave_idx_type *ridx, *cidx;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
217 SparseComplexMatrix scm;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
218 SparseMatrix sm;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
219
23583
b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse.
Rik <rik@octave.org>
parents: 23581
diff changeset
220 if (args(0).issparse ())
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
221 {
23581
c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex.
Rik <rik@octave.org>
parents: 23391
diff changeset
222 if (args(0).iscomplex ())
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
223 {
21751
b571fc85953f maint: Use two spaces after period to indicate sentence break.
Rik <rik@octave.org>
parents: 21724
diff changeset
224 scm = args(0).sparse_complex_matrix_value ();
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
225 n_row = scm.rows ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
226 n_col = scm.cols ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
227 nnz = scm.nnz ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
228 ridx = scm.xridx ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
229 cidx = scm.xcidx ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
230 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
231 else
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
232 {
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
233 sm = args(0).sparse_matrix_value ();
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
234
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
235 n_row = sm.rows ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
236 n_col = sm.cols ();
10527
b4d2080b6df7 Replace nzmax by nnz as needed
David Bateman <dbateman@free.fr>
parents: 10282
diff changeset
237 nnz = sm.nnz ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
238 ridx = sm.xridx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
239 cidx = sm.xcidx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
240 }
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
241 }
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 {
23581
c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex.
Rik <rik@octave.org>
parents: 23391
diff changeset
244 if (args(0).iscomplex ())
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
245 sm = SparseMatrix (real (args(0).complex_matrix_value ()));
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
246 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
247 sm = SparseMatrix (args(0).matrix_value ());
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
248
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
249 n_row = sm.rows ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
250 n_col = sm.cols ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
251 nnz = sm.nnz ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
252 ridx = sm.xridx ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
253 cidx = sm.xcidx ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
254 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
255
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
256 // 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
257 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
258 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
259 p[i] = cidx[i];
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
260
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
261 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
262 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
263 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
264 A[i] = ridx[i];
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
265
23777
cda0614beaec Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents: 23583
diff changeset
266 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
267 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
268 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
269
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
270 if (nargin > 2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
271 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
272 NDArray in_cmember = args(2).array_value ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
273 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
274 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
275 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
276 // 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
277 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
278
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
279 if (cslen != n_col)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
280 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
281
21055
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 20955
diff changeset
282 // 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
283 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
284 {
21602
47c76e56a1de maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents: 21547
diff changeset
285 CCOLAMD_NAME (_report) (stats);
21055
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 20955
diff changeset
286
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 20955
diff changeset
287 error ("ccolamd: internal error!");
5e00ed38a58b maint: Replace if/error/else paradigm with just if/error.
Rik <rik@octave.org>
parents: 20955
diff changeset
288 }
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
289 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
290 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
291 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
292 // 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
293 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
294 {
21602
47c76e56a1de maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents: 21547
diff changeset
295 CCOLAMD_NAME (_report) (stats);
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
296
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
297 error ("ccolamd: internal error!");
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
298 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
299 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
300
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
301 // return the permutation vector
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
302 NDArray out_perm (dim_vector (1, n_col));
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
303 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
304 out_perm(i) = p[i] + 1;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
305
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
306 retval(0) = out_perm;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
307
21604
d7a268e68e69 maint: Strip trailing whitespace from source files.
John W. Eaton <jwe@octave.org>
parents: 21602
diff changeset
308 // print stats if spumoni > 0
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
309 if (spumoni > 0)
21602
47c76e56a1de maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents: 21547
diff changeset
310 CCOLAMD_NAME (_report) (stats);
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
311
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
312 // Return the stats vector
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
313 if (nargout == 2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
314 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
315 NDArray out_stats (dim_vector (1, CCOLAMD_STATS));
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
316 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
317 out_stats(i) = stats[i];
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
318 retval(1) = out_stats;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
319
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
320 // 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
321 // jumbled matrix. note that this correction doesn't
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
322 // 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
323 out_stats(CCOLAMD_INFO1)++;
47c76e56a1de maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents: 21547
diff changeset
324 out_stats(CCOLAMD_INFO2)++;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
325 }
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
326
20898
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20864
diff changeset
327 return retval;
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20864
diff changeset
328
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
329 #else
21691
263d18409fdf Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents: 21604
diff changeset
330
263d18409fdf Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents: 21604
diff changeset
331 octave_unused_parameter (args);
263d18409fdf Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents: 21604
diff changeset
332 octave_unused_parameter (nargout);
263d18409fdf Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents: 21604
diff changeset
333
21109
bd1752782e56 Use err_disabled_feature, warn_disabled_feature throughout code base.
Rik <rik@octave.org>
parents: 21055
diff changeset
334 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
335
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
336 #endif
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
337 }
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
338
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
339 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
340 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
341 @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
342 @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
343 @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
344 @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
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 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
347 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
348 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
349
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
350 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
351 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
352 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
353 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
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 @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
356 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
357 defaults.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
358
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
359 @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
360 @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
361 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
362 @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
363 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
364
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
365 @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
366 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
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}(3)
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, 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
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 @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
372
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
373 @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
374 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
375 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
376 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
377 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
378 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
379 @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
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{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
382 @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
383 differ.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21751
diff changeset
384
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}(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
386 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
387 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
388 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
389 @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
390 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
391 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
392 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
393 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
394
25143
13fd0610480f doc: Use https whenever possible in @url entries.
Rik <rik@octave.org>
parents: 25054
diff changeset
395 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
396 @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
397 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
398 @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
399 @nospell{Sandia} National Lab.
25143
13fd0610480f doc: Use https whenever possible in @url entries.
Rik <rik@octave.org>
parents: 25054
diff changeset
400 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
401 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
402 @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
403 @end deftypefn */)
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
404 {
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
405 #if defined (HAVE_CCOLAMD)
5771
9c7be8e14b5b [project @ 2006-04-18 19:17:33 by jwe]
jwe
parents: 5760
diff changeset
406
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
407 int nargin = args.length ();
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
408
20909
03e4ddd49396 omit unnecessary nargout checks
John W. Eaton <jwe@octave.org>
parents: 20898
diff changeset
409 if (nargin < 1 || nargin > 3)
03e4ddd49396 omit unnecessary nargout checks
John W. Eaton <jwe@octave.org>
parents: 20898
diff changeset
410 print_usage ();
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
411
20898
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20864
diff changeset
412 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
413 int spumoni = 0;
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
414
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
415 // Get knobs
23777
cda0614beaec Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents: 23583
diff changeset
416 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
417 double knob_storage[CCOLAMD_KNOBS];
cda0614beaec Replace static instances of OCTAVE_LOCAL_BUFFER with local variables.
Rik <rik@octave.org>
parents: 23583
diff changeset
418 double *knobs = &knob_storage[0];
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
419 CCOLAMD_NAME (_set_defaults) (knobs);
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
420
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
421 // Check for user-passed knobs
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
422 if (nargin > 1)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
423 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
424 NDArray User_knobs = args(1).array_value ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
425 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
426
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
427 if (nel_User_knobs > 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
428 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
429 if (nel_User_knobs > 1)
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
430 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
431 if (nel_User_knobs > 2)
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
432 spumoni = static_cast<int> (User_knobs(2));
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
433
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
434 // print knob settings if spumoni is set
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
435 if (spumoni)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
436 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
437 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
438 << '.' << CCOLAMD_SUB_VERSION
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
439 << ", " << CCOLAMD_DATE << "\n";
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
440
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
441 if (knobs[CCOLAMD_DENSE_ROW] >= 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
442 octave_stdout << "knobs(1): " << User_knobs(0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
443 << ", rows/cols with > max (16,"
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
444 << knobs[CCOLAMD_DENSE_ROW]
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
445 << "*sqrt (size(A,2)))"
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
446 << " entries removed\n";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
447 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
448 octave_stdout << "knobs(1): " << User_knobs(0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
449 << ", no dense rows/cols removed\n";
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
450
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
451 if (knobs[CCOLAMD_AGGRESSIVE] != 0)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
452 octave_stdout << "knobs(2): " << User_knobs(1)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
453 << ", aggressive absorption: yes";
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
454 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
455 octave_stdout << "knobs(2): " << User_knobs(1)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
456 << ", aggressive absorption: no";
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
457
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
458 octave_stdout << "knobs(3): " << User_knobs(2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
459 << ", statistics and knobs printed\n";
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
460 }
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
461 }
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
462
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
463 octave_idx_type n_row, n_col;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
464 octave_idx_type *ridx, *cidx;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
465 SparseMatrix sm;
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
466 SparseComplexMatrix scm;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
467
23583
b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse.
Rik <rik@octave.org>
parents: 23581
diff changeset
468 if (args(0).issparse ())
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
469 {
23581
c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex.
Rik <rik@octave.org>
parents: 23391
diff changeset
470 if (args(0).iscomplex ())
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
471 {
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
472 scm = args(0).sparse_complex_matrix_value ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
473 n_row = scm.rows ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
474 n_col = scm.cols ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
475 ridx = scm.xridx ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
476 cidx = scm.xcidx ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
477 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
478 else
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
479 {
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
480 sm = args(0).sparse_matrix_value ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
481 n_row = sm.rows ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
482 n_col = sm.cols ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
483 ridx = sm.xridx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
484 cidx = sm.xcidx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
485 }
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
486 }
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 {
23581
c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex.
Rik <rik@octave.org>
parents: 23391
diff changeset
489 if (args(0).iscomplex ())
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
490 sm = SparseMatrix (real (args(0).complex_matrix_value ()));
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 sm = SparseMatrix (args(0).matrix_value ());
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
493
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
494 n_row = sm.rows ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
495 n_col = sm.cols ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
496 ridx = sm.xridx ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
497 cidx = sm.xcidx ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
498 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
499
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
500 if (n_row != n_col)
21110
3d0d84305600 Use err_square_matrix_required more widely.
Rik <rik@octave.org>
parents: 21109
diff changeset
501 err_square_matrix_required ("csymamd", "S");
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
502
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
503 // 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
504 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
505 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
506 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
507 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
508
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
509 if (nargin > 2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
510 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
511 NDArray in_cmember = args(2).array_value ();
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
512 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
513 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
514 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
515 // 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
516 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
517
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
518 if (cslen != n_col)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
519 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
520
23391
209e749363a2 safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents: 23390
diff changeset
521 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
522 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
523 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
524 perm, knobs, stats, &calloc, &free, cmember, -1))
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
525 {
21602
47c76e56a1de maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents: 21547
diff changeset
526 CSYMAMD_NAME (_report)(stats);
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
527
21602
47c76e56a1de maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents: 21547
diff changeset
528 error ("csymamd: internal error!");
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
529 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
530 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
531 else
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
532 {
23391
209e749363a2 safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents: 23390
diff changeset
533 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
534 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
535 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
536 perm, knobs, stats, &calloc, &free, nullptr, -1))
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
537 {
21602
47c76e56a1de maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents: 21547
diff changeset
538 CSYMAMD_NAME (_report)(stats);
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
539
21602
47c76e56a1de maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents: 21547
diff changeset
540 error ("csymamd: internal error!");
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
541 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
542 }
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
543
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
544 // return the permutation vector
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
545 NDArray out_perm (dim_vector (1, n_col));
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
546 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
547 out_perm(i) = perm[i] + 1;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
548
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
549 retval(0) = out_perm;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
550
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
551 // print stats if spumoni > 0
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
552 if (spumoni > 0)
21602
47c76e56a1de maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents: 21547
diff changeset
553 CSYMAMD_NAME (_report)(stats);
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
554
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
555 // Return the stats vector
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
556 if (nargout == 2)
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
557 {
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
558 NDArray out_stats (dim_vector (1, CCOLAMD_STATS));
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
559 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
560 out_stats(i) = stats[i];
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
561 retval(1) = out_stats;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
562
20864
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
563 // 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
564 // jumbled matrix. note that this correction doesn't
4c9df9f444db 2015 Code Sprint: ccolamd.cc: use ovl().
Rik <rik@octave.org>
parents: 20853
diff changeset
565 // 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
566 out_stats(CCOLAMD_INFO1)++;
47c76e56a1de maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents: 21547
diff changeset
567 out_stats(CCOLAMD_INFO2)++;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
568 }
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
569
20898
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20864
diff changeset
570 return retval;
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20864
diff changeset
571
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
572 #else
21691
263d18409fdf Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents: 21604
diff changeset
573
263d18409fdf Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents: 21604
diff changeset
574 octave_unused_parameter (args);
263d18409fdf Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents: 21604
diff changeset
575 octave_unused_parameter (nargout);
263d18409fdf Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents: 21604
diff changeset
576
21109
bd1752782e56 Use err_disabled_feature, warn_disabled_feature throughout code base.
Rik <rik@octave.org>
parents: 21055
diff changeset
577 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
578
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
579 #endif
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
580 }