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

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
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
1 /*
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
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) 2008-2020 The Octave Project Developers
27918
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27859
diff changeset
4
b442ec6dda5c use centralized file for copyright info for individual contributors
John W. Eaton <jwe@octave.org>
parents: 27859
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: 27859
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: 27859
diff changeset
7
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
8
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 This file is part of Octave.
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
10
24534
194eb4bd202b maint: Update punctuation for GPL v3 license text.
Rik <rik@octave.org>
parents: 23583
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: 23583
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.
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
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.
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
20
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
21 You should have received a copy of the GNU General Public License
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
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: 23583
diff changeset
23 <https://www.gnu.org/licenses/>.
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
24
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
25 */
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
26
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
27 // This is the octave interface to amd, which bore the copyright given
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
28 // in the help of the functions.
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
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"
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
32 #endif
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
33
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 #include <cstdlib>
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
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 "dMatrix.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"
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
41
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
42 #include "defun-dld.h"
23024
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents: 22755
diff changeset
43 #include "error.h"
21110
3d0d84305600 Use err_square_matrix_required more widely.
Rik <rik@octave.org>
parents: 21109
diff changeset
44 #include "errwarn.h"
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
45 #include "oct-map.h"
23024
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents: 22755
diff changeset
46 #include "ov.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents: 22755
diff changeset
47 #include "ovl.h"
27859
1a75fca6ad5d Lock amd and symbfact to avoid segmentation fault with SuiteSparse (bug #57435).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27081
diff changeset
48 #include "parse.h"
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
49
27859
1a75fca6ad5d Lock amd and symbfact to avoid segmentation fault with SuiteSparse (bug #57435).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27081
diff changeset
50 DEFMETHOD_DLD (amd, interp, args, nargout,
1a75fca6ad5d Lock amd and symbfact to avoid segmentation fault with SuiteSparse (bug #57435).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27081
diff changeset
51 doc: /* -*- texinfo -*-
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
52 @deftypefn {} {@var{p} =} amd (@var{S})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
53 @deftypefnx {} {@var{p} =} amd (@var{S}, @var{opts})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
54
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
55 Return the approximate minimum degree permutation of a matrix.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
56
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
57 This is a permutation such that the Cholesky@tie{}factorization of
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
58 @code{@var{S} (@var{p}, @var{p})} tends to be sparser than the
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
59 Cholesky@tie{}factorization of @var{S} itself. @code{amd} is typically
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
60 faster than @code{symamd} but serves a similar purpose.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
61
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
62 The optional parameter @var{opts} is a structure that controls the behavior
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
63 of @code{amd}. The fields of the structure are
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
64
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
65 @table @asis
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
66 @item @var{opts}.dense
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
67 Determines what @code{amd} considers to be a dense row or column of the
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
68 input matrix. Rows or columns with more than @code{max (16, (dense *
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
69 sqrt (@var{n})))} entries, where @var{n} is the order of the matrix @var{S},
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
70 are ignored by @code{amd} during the calculation of the permutation.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
71 The value of dense must be a positive scalar and the default value is 10.0
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
72
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
73 @item @var{opts}.aggressive
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
74 If this value is a nonzero scalar, then @code{amd} performs aggressive
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
75 absorption. The default is not to perform aggressive absorption.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
76 @end table
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
77
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
78 The author of the code itself is Timothy A. Davis
25143
13fd0610480f doc: Use https whenever possible in @url entries.
Rik <rik@octave.org>
parents: 25054
diff changeset
79 (see @url{http://faculty.cse.tamu.edu/davis/suitesparse.html}).
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
80 @seealso{symamd, colamd}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21724
diff changeset
81 @end deftypefn */)
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
82 {
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21691
diff changeset
83 #if defined (HAVE_AMD)
21691
263d18409fdf Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents: 21602
diff changeset
84
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
85 int nargin = args.length ();
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
86
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
87 if (nargin < 1 || nargin > 2)
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
88 print_usage ();
20790
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
89
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
90 octave_idx_type 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
91 const octave::suitesparse_integer *ridx, *cidx;
20790
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
92 SparseMatrix sm;
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
93 SparseComplexMatrix scm;
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
94
23583
b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse.
Rik <rik@octave.org>
parents: 23581
diff changeset
95 if (args(0).issparse ())
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
96 {
23581
c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex.
Rik <rik@octave.org>
parents: 23391
diff changeset
97 if (args(0).iscomplex ())
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
98 {
20790
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
99 scm = args(0).sparse_complex_matrix_value ();
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
100 n_row = scm.rows ();
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
101 n_col = scm.cols ();
23391
209e749363a2 safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents: 23390
diff changeset
102 ridx = octave::to_suitesparse_intptr (scm.xridx ());
209e749363a2 safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents: 23390
diff changeset
103 cidx = octave::to_suitesparse_intptr (scm.xcidx ());
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
104 }
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
105 else
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
106 {
20790
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
107 sm = args(0).sparse_matrix_value ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
108 n_row = sm.rows ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
109 n_col = sm.cols ();
23391
209e749363a2 safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents: 23390
diff changeset
110 ridx = octave::to_suitesparse_intptr (sm.xridx ());
209e749363a2 safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents: 23390
diff changeset
111 cidx = octave::to_suitesparse_intptr (sm.xcidx ());
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9245
diff changeset
112 }
20790
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
113 }
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
114 else
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
115 {
23581
c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex.
Rik <rik@octave.org>
parents: 23391
diff changeset
116 if (args(0).iscomplex ())
20790
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
117 sm = SparseMatrix (real (args(0).complex_matrix_value ()));
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
118 else
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
119 sm = SparseMatrix (args(0).matrix_value ());
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
120
20790
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
121 n_row = sm.rows ();
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
122 n_col = sm.cols ();
23391
209e749363a2 safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents: 23390
diff changeset
123 ridx = octave::to_suitesparse_intptr (sm.xridx ());
209e749363a2 safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents: 23390
diff changeset
124 cidx = octave::to_suitesparse_intptr (sm.xcidx ());
20790
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
125 }
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
126
20790
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
127 if (n_row != n_col)
21110
3d0d84305600 Use err_square_matrix_required more widely.
Rik <rik@octave.org>
parents: 21109
diff changeset
128 err_square_matrix_required ("amd", "S");
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20163
diff changeset
129
20790
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
130 OCTAVE_LOCAL_BUFFER (double, Control, AMD_CONTROL);
21602
47c76e56a1de maint: Remove extra space between end of statement and semicolon.
Rik <rik@octave.org>
parents: 21580
diff changeset
131 AMD_NAME (_defaults) (Control);
20790
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
132 if (nargin > 1)
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
133 {
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
134 octave_scalar_map arg1 = args(1).xscalar_map_value ("amd: OPTS argument must be a scalar structure");
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
135
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
136 octave_value tmp;
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
137
20790
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
138 tmp = arg1.getfield ("dense");
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
139 if (tmp.is_defined ())
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
140 Control[AMD_DENSE] = tmp.double_value ();
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
141
20790
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
142 tmp = arg1.getfield ("aggressive");
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
143 if (tmp.is_defined ())
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
144 Control[AMD_AGGRESSIVE] = tmp.double_value ();
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
145 }
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
146
23391
209e749363a2 safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents: 23390
diff changeset
147 OCTAVE_LOCAL_BUFFER (octave::suitesparse_integer, P, n_col);
20790
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
148 Matrix xinfo (AMD_INFO, 1);
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
149 double *Info = xinfo.fortran_vec ();
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20163
diff changeset
150
27859
1a75fca6ad5d Lock amd and symbfact to avoid segmentation fault with SuiteSparse (bug #57435).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27081
diff changeset
151 // Lock the function to not loose the SuiteSparse_config structure
1a75fca6ad5d Lock amd and symbfact to avoid segmentation fault with SuiteSparse (bug #57435).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27081
diff changeset
152 interp.mlock ();
1a75fca6ad5d Lock amd and symbfact to avoid segmentation fault with SuiteSparse (bug #57435).
Markus Mützel <markus.muetzel@gmx.de>
parents: 27081
diff changeset
153
20790
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
154 // FIXME: how can we manage the memory allocation of amd
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
155 // in a cleaner manner?
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
156 SUITESPARSE_ASSIGN_FPTR (malloc_func, amd_malloc, malloc);
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
157 SUITESPARSE_ASSIGN_FPTR (free_func, amd_free, free);
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
158 SUITESPARSE_ASSIGN_FPTR (calloc_func, amd_calloc, calloc);
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
159 SUITESPARSE_ASSIGN_FPTR (realloc_func, amd_realloc, realloc);
c2d9556d51d0 eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20704
diff changeset
160 SUITESPARSE_ASSIGN_FPTR (printf_func, amd_printf, printf);
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
161
23391
209e749363a2 safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents: 23390
diff changeset
162 octave_idx_type result = AMD_NAME (_order) (n_col, cidx, ridx, P, Control,
209e749363a2 safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents: 23390
diff changeset
163 Info);
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20163
diff changeset
164
20898
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20853
diff changeset
165 if (result == AMD_OUT_OF_MEMORY)
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20853
diff changeset
166 error ("amd: out of memory");
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20853
diff changeset
167 else if (result == AMD_INVALID)
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20853
diff changeset
168 error ("amd: matrix S is corrupted");
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
169
20898
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20853
diff changeset
170 Matrix Pout (1, n_col);
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20853
diff changeset
171 for (octave_idx_type i = 0; i < n_col; i++)
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20853
diff changeset
172 Pout.xelem (i) = P[i] + 1;
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20163
diff changeset
173
20898
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20853
diff changeset
174 if (nargout > 1)
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20853
diff changeset
175 return ovl (Pout, xinfo);
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20853
diff changeset
176 else
8da80da1ac37 maint: Use ovl() more places in the code.
Rik <rik@octave.org>
parents: 20853
diff changeset
177 return ovl (Pout);
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20163
diff changeset
178
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
179 #else
21691
263d18409fdf Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents: 21602
diff changeset
180
263d18409fdf Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents: 21602
diff changeset
181 octave_unused_parameter (args);
263d18409fdf Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents: 21602
diff changeset
182 octave_unused_parameter (nargout);
263d18409fdf Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents: 21602
diff changeset
183
21109
bd1752782e56 Use err_disabled_feature, warn_disabled_feature throughout code base.
Rik <rik@octave.org>
parents: 20939
diff changeset
184 err_disabled_feature ("amd", "AMD");
21691
263d18409fdf Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents: 21602
diff changeset
185
7619
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
186 #endif
56012914972a Add the amd function
David Bateman <dbateman@free.fr>
parents:
diff changeset
187 }
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20898
diff changeset
188
19144
e99d7a2e7367 * amd.cc: Tests added.
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 19139
diff changeset
189 /*
e99d7a2e7367 * amd.cc: Tests added.
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 19139
diff changeset
190 %!shared A, A2, opts
e99d7a2e7367 * amd.cc: Tests added.
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 19139
diff changeset
191 %! A = ones (20, 30);
e99d7a2e7367 * amd.cc: Tests added.
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 19139
diff changeset
192 %! A2 = ones (30, 30);
27081
c0d8ce61c1c9 Always reserve at least 1 element of storage for sparse matrices (bug #56232).
Rik <rik@octave.org>
parents: 26376
diff changeset
193
19208
5f21e0bff135 Use %!testif HAVE_AMD for amd tests added in cset e99d7a2e7367
Mike Miller <mtmiller@ieee.org>
parents: 19144
diff changeset
194 %!testif HAVE_AMD
21580
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents: 21301
diff changeset
195 %! assert(amd (A2), [1:30]);
19144
e99d7a2e7367 * amd.cc: Tests added.
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 19139
diff changeset
196 %! opts.dense = 25;
21580
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents: 21301
diff changeset
197 %! assert(amd (A2, opts), [1:30]);
19144
e99d7a2e7367 * amd.cc: Tests added.
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 19139
diff changeset
198 %! opts.aggressive = 1;
21580
ecce63c99c3f maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents: 21301
diff changeset
199 %! assert(amd (A2, opts), [1:30]);
19208
5f21e0bff135 Use %!testif HAVE_AMD for amd tests added in cset e99d7a2e7367
Mike Miller <mtmiller@ieee.org>
parents: 19144
diff changeset
200
27081
c0d8ce61c1c9 Always reserve at least 1 element of storage for sparse matrices (bug #56232).
Rik <rik@octave.org>
parents: 26376
diff changeset
201 %!testif HAVE_AMD
c0d8ce61c1c9 Always reserve at least 1 element of storage for sparse matrices (bug #56232).
Rik <rik@octave.org>
parents: 26376
diff changeset
202 %! assert (amd ([]), zeros (1,0))
c0d8ce61c1c9 Always reserve at least 1 element of storage for sparse matrices (bug #56232).
Rik <rik@octave.org>
parents: 26376
diff changeset
203
21110
3d0d84305600 Use err_square_matrix_required more widely.
Rik <rik@octave.org>
parents: 21109
diff changeset
204 %!error <S must be a square matrix|was unavailable or disabled> amd (A)
19208
5f21e0bff135 Use %!testif HAVE_AMD for amd tests added in cset e99d7a2e7367
Mike Miller <mtmiller@ieee.org>
parents: 19144
diff changeset
205 %!error amd (A2, 2)
19144
e99d7a2e7367 * amd.cc: Tests added.
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 19139
diff changeset
206 */