Mercurial > octave-antonio

annotate libinterp/dldfcn/ccolamd.cc @ 20163:075a5e2e1ba5 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed build-aux, libinterp/dldfcn, libinterp/octave-value, libinterp/parse-tree directories. * build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc, libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc, libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc: doc: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Sun, 03 May 2015 21:52:42 -0700
parents 4197fc428c7d
children
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
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19040
diff changeset
3 Copyright (C) 2005-2015 David Bateman
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
4
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5771
diff changeset
5 This file is part of Octave.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5771
diff changeset
6
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5771
diff changeset
9 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5771
diff changeset
10 option) any later version.
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
11
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
15 for more details.
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
16
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
17 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
18 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 5771
diff changeset
19 <http://www.gnu.org/licenses/>.
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 */
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
22
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
23 // 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
24 // in the help of the functions.
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 #ifdef HAVE_CONFIG_H
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
27 #include <config.h>
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
28 #endif
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
29
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
30 #include <cstdlib>
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
31
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
32 #include <string>
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
33 #include <vector>
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
34
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
35 #include "ov.h"
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
36 #include "defun-dld.h"
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
37 #include "pager.h"
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
38 #include "ov-re-mat.h"
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
39
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
40 #include "ov-re-sparse.h"
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
41 #include "ov-cx-sparse.h"
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
42
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
43 #include "oct-sparse.h"
8377
25bc2d31e1bf improve OCTAVE_LOCAL_BUFFER
Jaroslav Hajek <highegg@gmail.com>
parents: 7520
diff changeset
44 #include "oct-locbuf.h"
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
45
16313
6aafe87a3144 use int64_t for idx type if --enable-64
John W. Eaton <jwe@octave.org>
parents: 15195
diff changeset
46 #ifdef USE_64_BIT_IDX_T
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
47 #define CCOLAMD_NAME(name) ccolamd_l ## name
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
48 #define CSYMAMD_NAME(name) csymamd_l ## name
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
49 #else
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
50 #define CCOLAMD_NAME(name) ccolamd ## name
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
51 #define CSYMAMD_NAME(name) csymamd ## name
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
52 #endif
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
53
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
54 DEFUN_DLD (ccolamd, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
55 "-*- texinfo -*-\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
56 @deftypefn {Loadable Function} {@var{p} =} ccolamd (@var{S})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
57 @deftypefnx {Loadable Function} {@var{p} =} ccolamd (@var{S}, @var{knobs})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
58 @deftypefnx {Loadable Function} {@var{p} =} ccolamd (@var{S}, @var{knobs}, @var{cmember})\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
59 @deftypefnx {Loadable Function} {[@var{p}, @var{stats}] =} ccolamd (@dots{})\n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
60 \n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
61 Constrained column approximate minimum degree permutation.\n\
20163
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
62 \n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
63 @code{@var{p} = ccolamd (@var{S})} returns the column approximate minimum\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
64 degree permutation vector for the sparse matrix @var{S}. For a non-symmetric\n\
20163
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
65 matrix @var{S}, @code{@var{S}(:, @var{p})} tends to have sparser\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
66 LU@tie{}factors than @var{S}.\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
67 @code{chol (@var{S}(:, @var{p})' * @var{S}(:, @var{p}))} also tends to be\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
68 sparser than @code{chol (@var{S}' * @var{S})}.\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
69 @code{@var{p} = ccolamd (@var{S}, 1)} optimizes the ordering for\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
70 @code{lu (@var{S}(:, @var{p}))}. The ordering is followed by a column\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
71 elimination tree post-ordering.\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
72 \n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
73 @var{knobs} is an optional 1-element to 5-element input vector, with a\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
74 default value of @code{[0 10 10 1 0]} if not present or empty. Entries not\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
75 present are set to their defaults.\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
76 \n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
77 @table @code\n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
78 @item @var{knobs}(1)\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
79 if nonzero, the ordering is optimized for @code{lu (S(:, p))}. It will be a\n\
20163
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
80 poor ordering for @code{chol (@var{S}(:, @var{p})' * @var{S}(:, @var{p}))}.\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
81 This is the most important knob for ccolamd.\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
82 \n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
83 @item @var{knobs}(2)\n\
20163
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
84 if @var{S} is m-by-n, rows with more than\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
85 @code{max (16, @var{knobs}(2) * sqrt (n))} entries are ignored.\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
86 \n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
87 @item @var{knobs}(3)\n\
20163
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
88 columns with more than\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
89 @code{max (16, @var{knobs}(3) * sqrt (min (@var{m}, @var{n})))} entries are\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
90 ignored and ordered last in the output permutation\n\
7107
22397f0fb0b2 [project @ 2007-11-06 20:31:33 by dbateman]
dbateman
parents: 7017
diff changeset
91 (subject to the cmember constraints).\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
92 \n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
93 @item @var{knobs}(4)\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
94 if nonzero, aggressive absorption is performed.\n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
95 \n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
96 @item @var{knobs}(5)\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
97 if nonzero, statistics and knobs are printed.\n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
98 \n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
99 @end table\n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
100 \n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
101 @var{cmember} is an optional vector of length @math{n}. It defines the\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
102 constraints on the column ordering. If @code{@var{cmember}(j) = @var{c}},\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
103 then column @var{j} is in constraint set @var{c} (@var{c} must be in the\n\
18679
a142f35f3cb6 doc: Fix unbalanced parentheses in documentation.
Rik <rik@octave.org>
parents: 17787
diff changeset
104 range 1 to n). In the output permutation @var{p}, all columns in set 1\n\
a142f35f3cb6 doc: Fix unbalanced parentheses in documentation.
Rik <rik@octave.org>
parents: 17787
diff changeset
105 appear first, followed by all columns in set 2, and so on.\n\
a142f35f3cb6 doc: Fix unbalanced parentheses in documentation.
Rik <rik@octave.org>
parents: 17787
diff changeset
106 @code{@var{cmember} = ones (1,n)} if not present or empty.\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
107 @code{ccolamd (@var{S}, [], 1 : n)} returns @code{1 : n}\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
108 \n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
109 @code{@var{p} = ccolamd (@var{S})} is about the same as\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
110 @code{@var{p} = colamd (@var{S})}. @var{knobs} and its default values\n\
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
111 differ. @code{colamd} always does aggressive absorption, and it finds an\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
112 ordering suitable for both @code{lu (@var{S}(:, @var{p}))} and @code{chol\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
113 (@var{S}(:, @var{p})' * @var{S}(:, @var{p}))}; it cannot optimize its\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
114 ordering for @code{lu (@var{S}(:, @var{p}))} to the extent that\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
115 @code{ccolamd (@var{S}, 1)} can.\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
116 \n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
117 @var{stats} is an optional 20-element output vector that provides data\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
118 about the ordering and the validity of the input matrix @var{S}. Ordering\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
119 statistics are in @code{@var{stats}(1 : 3)}. @code{@var{stats}(1)} and\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
120 @code{@var{stats}(2)} are the number of dense or empty rows and columns\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
121 ignored by @sc{ccolamd} and @code{@var{stats}(3)} is the number of garbage\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
122 collections performed on the internal data structure used by @sc{ccolamd}\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
123 (roughly of size @code{2.2 * nnz (@var{S}) + 4 * @var{m} + 7 * @var{n}}\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
124 integers).\n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
125 \n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
126 @code{@var{stats}(4 : 7)} provide information if CCOLAMD was able to\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
127 continue. The matrix is OK if @code{@var{stats}(4)} is zero, or 1 if\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
128 invalid. @code{@var{stats}(5)} is the rightmost column index that is\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
129 unsorted or contains duplicate entries, or zero if no such column exists.\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
130 @code{@var{stats}(6)} is the last seen duplicate or out-of-order row\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
131 index in the column index given by @code{@var{stats}(5)}, or zero if no\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
132 such row index exists. @code{@var{stats}(7)} is the number of duplicate\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
133 or out-of-order row indices. @code{@var{stats}(8 : 20)} is always zero in\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
134 the current version of @sc{ccolamd} (reserved for future use).\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
135 \n\
19040
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
136 The authors of the code itself are @nospell{S. Larimore, T. Davis}\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
137 (Univ. of Florida) and @nospell{S. Rajamanickam} in collaboration with\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
138 @nospell{J. Bilbert and E. Ng}. Supported by the National Science Foundation\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
139 @nospell{(DMS-9504974, DMS-9803599, CCR-0203270)}, and a grant from\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
140 @nospell{Sandia} National Lab.\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
141 See @url{http://www.cise.ufl.edu/research/sparse} for\n\
16826
a4969508008e doc: Periodic spellcheck of the documentation.
Rik <rik@octave.org>
parents: 16313
diff changeset
142 ccolamd, csymamd, amd, colamd, symamd, and other related orderings.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5631
diff changeset
143 @seealso{colamd, csymamd}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5631
diff changeset
144 @end deftypefn")
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
145 {
5771
9c7be8e14b5b [project @ 2006-04-18 19:17:33 by jwe]
jwe
parents: 5760
diff changeset
146 octave_value_list retval;
9c7be8e14b5b [project @ 2006-04-18 19:17:33 by jwe]
jwe
parents: 5760
diff changeset
147
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
148 #ifdef HAVE_CCOLAMD
5771
9c7be8e14b5b [project @ 2006-04-18 19:17:33 by jwe]
jwe
parents: 5760
diff changeset
149
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
150 int nargin = args.length ();
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
151 int spumoni = 0;
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
152
10282
c9780d8e228c fix invalid checks in amd functions
Jaroslav Hajek <highegg@gmail.com>
parents: 10155
diff changeset
153 if (nargout > 2 || nargin < 1 || nargin > 3)
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
154 usage ("ccolamd: incorrect number of input and/or output arguments");
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
155 else
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
156 {
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
157 // Get knobs
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
158 OCTAVE_LOCAL_BUFFER (double, knobs, CCOLAMD_KNOBS);
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
159 CCOLAMD_NAME (_set_defaults) (knobs);
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
160
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
161 // Check for user-passed knobs
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
162 if (nargin > 1)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
163 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
164 NDArray User_knobs = args(1).array_value ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
165 int nel_User_knobs = User_knobs.length ();
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
166
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
167 if (nel_User_knobs > 0)
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
168 knobs[CCOLAMD_LU] = (User_knobs(0) != 0);
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
169 if (nel_User_knobs > 1)
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
170 knobs[CCOLAMD_DENSE_ROW] = User_knobs(1);
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
171 if (nel_User_knobs > 2)
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
172 knobs[CCOLAMD_DENSE_COL] = User_knobs(2);
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
173 if (nel_User_knobs > 3)
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
174 knobs[CCOLAMD_AGGRESSIVE] = (User_knobs(3) != 0);
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
175 if (nel_User_knobs > 4)
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
176 spumoni = (User_knobs(4) != 0);
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
177
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
178 // print knob settings if spumoni is set
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
179 if (spumoni)
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
180 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
181 octave_stdout << "\nccolamd version " << CCOLAMD_MAIN_VERSION << "."
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
182 << CCOLAMD_SUB_VERSION << ", " << CCOLAMD_DATE
15021
0fd364b9bf63 maint: Cuddle parenthesis for indexing expressions in ccolamd.cc.
Rik <rik@octave.org>
parents: 15020
diff changeset
183 << ":\nknobs(1): " << User_knobs(0) << ", order for ";
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
184 if (knobs[CCOLAMD_LU] != 0)
14854
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
185 octave_stdout << "lu (A)\n";
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
186 else
14854
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
187 octave_stdout << "chol (A'*A)\n";
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
188
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
189 if (knobs[CCOLAMD_DENSE_ROW] >= 0)
15021
0fd364b9bf63 maint: Cuddle parenthesis for indexing expressions in ccolamd.cc.
Rik <rik@octave.org>
parents: 15020
diff changeset
190 octave_stdout << "knobs(2): " << User_knobs(1)
14854
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
191 << ", rows with > max (16,"
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
192 << knobs[CCOLAMD_DENSE_ROW]
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
193 << "*sqrt (size(A,2)))"
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
194 << " entries removed\n";
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
195 else
15021
0fd364b9bf63 maint: Cuddle parenthesis for indexing expressions in ccolamd.cc.
Rik <rik@octave.org>
parents: 15020
diff changeset
196 octave_stdout << "knobs(2): " << User_knobs(1)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
197 << ", no dense rows removed\n";
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
198
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
199 if (knobs[CCOLAMD_DENSE_COL] >= 0)
15021
0fd364b9bf63 maint: Cuddle parenthesis for indexing expressions in ccolamd.cc.
Rik <rik@octave.org>
parents: 15020
diff changeset
200 octave_stdout << "knobs(3): " << User_knobs(2)
14854
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
201 << ", cols with > max (16,"
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
202 << knobs[CCOLAMD_DENSE_COL] << "*sqrt (size(A)))"
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
203 << " entries removed\n";
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
204 else
15021
0fd364b9bf63 maint: Cuddle parenthesis for indexing expressions in ccolamd.cc.
Rik <rik@octave.org>
parents: 15020
diff changeset
205 octave_stdout << "knobs(3): " << User_knobs(2)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
206 << ", no dense columns removed\n";
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
207
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
208 if (knobs[CCOLAMD_AGGRESSIVE] != 0)
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
209 octave_stdout << "knobs(4): " << User_knobs(3)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
210 << ", aggressive absorption: yes";
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
211 else
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
212 octave_stdout << "knobs(4): " << User_knobs(3)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
213 << ", aggressive absorption: no";
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
214
15021
0fd364b9bf63 maint: Cuddle parenthesis for indexing expressions in ccolamd.cc.
Rik <rik@octave.org>
parents: 15020
diff changeset
215 octave_stdout << "knobs(5): " << User_knobs(4)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
216 << ", statistics and knobs printed\n";
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
217 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
218 }
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
219
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
220 octave_idx_type n_row, n_col, nnz;
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
221 octave_idx_type *ridx, *cidx;
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
222 SparseComplexMatrix scm;
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
223 SparseMatrix sm;
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
224
5631
7171d19706df [project @ 2006-02-22 20:15:06 by dbateman]
dbateman
parents: 5604
diff changeset
225 if (args(0).is_sparse_type ())
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
226 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
227 if (args(0).is_complex_type ())
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
228 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
229 scm = args(0). sparse_complex_matrix_value ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
230 n_row = scm.rows ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
231 n_col = scm.cols ();
10527
b4d2080b6df7 Replace nzmax by nnz as needed
David Bateman <dbateman@free.fr>
parents: 10282
diff changeset
232 nnz = scm.nnz ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
233 ridx = scm.xridx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
234 cidx = scm.xcidx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
235 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
236 else
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
237 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
238 sm = args(0).sparse_matrix_value ();
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
239
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
240 n_row = sm.rows ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
241 n_col = sm.cols ();
10527
b4d2080b6df7 Replace nzmax by nnz as needed
David Bateman <dbateman@free.fr>
parents: 10282
diff changeset
242 nnz = sm.nnz ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
243 ridx = sm.xridx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
244 cidx = sm.xcidx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
245 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
246 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
247 else
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
248 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
249 if (args(0).is_complex_type ())
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
250 sm = SparseMatrix (real (args(0).complex_matrix_value ()));
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
251 else
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
252 sm = SparseMatrix (args(0).matrix_value ());
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
253
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
254 n_row = sm.rows ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
255 n_col = sm.cols ();
10527
b4d2080b6df7 Replace nzmax by nnz as needed
David Bateman <dbateman@free.fr>
parents: 10282
diff changeset
256 nnz = sm.nnz ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
257 ridx = sm.xridx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
258 cidx = sm.xcidx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
259 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
260
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
261 // Allocate workspace for ccolamd
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
262 OCTAVE_LOCAL_BUFFER (octave_idx_type, p, n_col+1);
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
263 for (octave_idx_type i = 0; i < n_col+1; i++)
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
264 p[i] = cidx[i];
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
265
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
266 octave_idx_type Alen = CCOLAMD_NAME (_recommended) (nnz, n_row, n_col);
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
267 OCTAVE_LOCAL_BUFFER (octave_idx_type, A, Alen);
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
268 for (octave_idx_type i = 0; i < nnz; i++)
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
269 A[i] = ridx[i];
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
270
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
271 OCTAVE_LOCAL_BUFFER (octave_idx_type, stats, CCOLAMD_STATS);
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
272
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
273 if (nargin > 2)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
274 {
14846
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14844
diff changeset
275 NDArray in_cmember = args(2).array_value ();
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14844
diff changeset
276 octave_idx_type cslen = in_cmember.length ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
277 OCTAVE_LOCAL_BUFFER (octave_idx_type, cmember, cslen);
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
278 for (octave_idx_type i = 0; i < cslen; i++)
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
279 // convert cmember from 1-based to 0-based
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
280 cmember[i] = static_cast<octave_idx_type>(in_cmember(i) - 1);
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
281
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
282 if (cslen != n_col)
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
283 error ("ccolamd: CMEMBER must be of length equal to #cols of A");
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
284 else
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
285 // Order the columns (destroys A)
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
286 if (! CCOLAMD_NAME () (n_row, n_col, Alen, A, p,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
287 knobs, stats, cmember))
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
288 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
289 CCOLAMD_NAME (_report) (stats) ;
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
290 error ("ccolamd: internal error!");
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
291 return retval;
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
292 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
293 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
294 else
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
295 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
296 // Order the columns (destroys A)
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
297 if (! CCOLAMD_NAME () (n_row, n_col, Alen, A, p, knobs, stats, 0))
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
298 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
299 CCOLAMD_NAME (_report) (stats) ;
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
300 error ("ccolamd: internal error!");
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
301 return retval;
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
302 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
303 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
304
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
305 // return the permutation vector
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
306 NDArray out_perm (dim_vector (1, n_col));
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
307 for (octave_idx_type i = 0; i < n_col; i++)
14854
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
308 out_perm(i) = p[i] + 1;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
309
14844
5bc9b9cb4362 maint: Use Octave coding conventions for cuddled parenthesis in retval assignments.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
310 retval(0) = out_perm;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
311
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
312 // print stats if spumoni > 0
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
313 if (spumoni > 0)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
314 CCOLAMD_NAME (_report) (stats) ;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
315
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
316 // Return the stats vector
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
317 if (nargout == 2)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
318 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
319 NDArray out_stats (dim_vector (1, CCOLAMD_STATS));
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
320 for (octave_idx_type i = 0 ; i < CCOLAMD_STATS ; i++)
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
321 out_stats(i) = stats[i] ;
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
322 retval(1) = out_stats;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
323
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
324 // fix stats (5) and (6), for 1-based information on
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
325 // jumbled matrix. note that this correction doesn't
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
326 // occur if symamd returns FALSE
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
327 out_stats (CCOLAMD_INFO1) ++ ;
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
328 out_stats (CCOLAMD_INFO2) ++ ;
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
329 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
330 }
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
331
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
332 #else
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
333
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
334 error ("ccolamd: not available in this version of Octave");
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
335
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
336 #endif
5771
9c7be8e14b5b [project @ 2006-04-18 19:17:33 by jwe]
jwe
parents: 5760
diff changeset
337
9c7be8e14b5b [project @ 2006-04-18 19:17:33 by jwe]
jwe
parents: 5760
diff changeset
338 return retval;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
339 }
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
340
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
341 DEFUN_DLD (csymamd, args, nargout,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
342 "-*- texinfo -*-\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
343 @deftypefn {Loadable Function} {@var{p} =} csymamd (@var{S})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
344 @deftypefnx {Loadable Function} {@var{p} =} csymamd (@var{S}, @var{knobs})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
345 @deftypefnx {Loadable Function} {@var{p} =} csymamd (@var{S}, @var{knobs}, @var{cmember})\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
346 @deftypefnx {Loadable Function} {[@var{p}, @var{stats}] =} csymamd (@dots{})\n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
347 \n\
20163
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
348 For a symmetric positive definite matrix @var{S}, return the permutation\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
349 vector @var{p} such that @code{@var{S}(@var{p},@var{p})} tends to have a\n\
20163
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
350 sparser Cholesky@tie{}factor than @var{S}.\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
351 \n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
352 Sometimes @code{csymamd} works well for symmetric indefinite matrices too. \n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
353 The matrix @var{S} is assumed to be symmetric; only the strictly lower\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
354 triangular part is referenced. @var{S} must be square. The ordering is\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
355 followed by an elimination tree post-ordering.\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
356 \n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
357 @var{knobs} is an optional 1-element to 3-element input vector, with a\n\
20163
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
358 default value of @code{[10 1 0]}. Entries not present are set to their\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
359 defaults.\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
360 \n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
361 @table @code\n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
362 @item @var{knobs}(1)\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
363 If @var{S} is n-by-n, then rows and columns with more than\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
364 @code{max(16,@var{knobs}(1)*sqrt(n))} entries are ignored, and ordered\n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
365 last in the output permutation (subject to the cmember constraints).\n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
366 \n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
367 @item @var{knobs}(2)\n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
368 If nonzero, aggressive absorption is performed.\n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
369 \n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
370 @item @var{knobs}(3)\n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
371 If nonzero, statistics and knobs are printed.\n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
372 \n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
373 @end table\n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
374 \n\
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
375 @var{cmember} is an optional vector of length n. It defines the constraints\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
376 on the ordering. If @code{@var{cmember}(j) = @var{S}}, then row/column j is\n\
9064
7c02ec148a3c Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
377 in constraint set @var{c} (@var{c} must be in the range 1 to n). In the\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
378 output permutation @var{p}, rows/columns in set 1 appear first, followed\n\
14854
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
379 by all rows/columns in set 2, and so on. @code{@var{cmember} = ones (1,n)}\n\
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
380 if not present or empty. @code{csymamd (@var{S},[],1:n)} returns @code{1:n}.\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
381 \n\
20163
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
382 @code{@var{p} = csymamd (@var{S})} is about the same as\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
383 @code{@var{p} = symamd (@var{S})}. @var{knobs} and its default values\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
384 differ.\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
385 \n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
386 @code{@var{stats}(4:7)} provide information if CCOLAMD was able to\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
387 continue. The matrix is OK if @code{@var{stats}(4)} is zero, or 1 if\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
388 invalid. @code{@var{stats}(5)} is the rightmost column index that is\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
389 unsorted or contains duplicate entries, or zero if no such column exists.\n\
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
390 @code{@var{stats}(6)} is the last seen duplicate or out-of-order row\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
391 index in the column index given by @code{@var{stats}(5)}, or zero if no\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
392 such row index exists. @code{@var{stats}(7)} is the number of duplicate\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
393 or out-of-order row indices. @code{@var{stats}(8:20)} is always zero in\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
394 the current version of @sc{ccolamd} (reserved for future use).\n\
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
395 \n\
19040
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
396 The authors of the code itself are @nospell{S. Larimore, T. Davis}\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
397 (Univ. of Florida) and @nospell{S. Rajamanickam} in collaboration with\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
398 @nospell{J. Bilbert and E. Ng}. Supported by the National Science Foundation\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
399 @nospell{(DMS-9504974, DMS-9803599, CCR-0203270)}, and a grant from\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
400 @nospell{Sandia} National Lab.\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
401 See @url{http://www.cise.ufl.edu/research/sparse} for\n\
16826
a4969508008e doc: Periodic spellcheck of the documentation.
Rik <rik@octave.org>
parents: 16313
diff changeset
402 ccolamd, csymamd, amd, colamd, symamd, and other related orderings.\n\
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5631
diff changeset
403 @seealso{symamd, ccolamd}\n\
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5631
diff changeset
404 @end deftypefn")
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
405 {
5771
9c7be8e14b5b [project @ 2006-04-18 19:17:33 by jwe]
jwe
parents: 5760
diff changeset
406 octave_value_list retval;
9c7be8e14b5b [project @ 2006-04-18 19:17:33 by jwe]
jwe
parents: 5760
diff changeset
407
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
408 #if HAVE_CCOLAMD
5771
9c7be8e14b5b [project @ 2006-04-18 19:17:33 by jwe]
jwe
parents: 5760
diff changeset
409
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
410 int nargin = args.length ();
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
411 int spumoni = 0;
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
412
10282
c9780d8e228c fix invalid checks in amd functions
Jaroslav Hajek <highegg@gmail.com>
parents: 10155
diff changeset
413 if (nargout > 2 || nargin < 1 || nargin > 3)
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
414 usage ("ccolamd: incorrect number of input and/or output arguments");
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
415 else
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
416 {
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
417 // Get knobs
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
418 OCTAVE_LOCAL_BUFFER (double, knobs, CCOLAMD_KNOBS);
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
419 CCOLAMD_NAME (_set_defaults) (knobs);
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
420
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
421 // Check for user-passed knobs
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
422 if (nargin > 1)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
423 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
424 NDArray User_knobs = args(1).array_value ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
425 int nel_User_knobs = User_knobs.length ();
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
426
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
427 if (nel_User_knobs > 0)
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
428 knobs[CCOLAMD_DENSE_ROW] = User_knobs(0);
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
429 if (nel_User_knobs > 0)
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
430 knobs[CCOLAMD_AGGRESSIVE] = User_knobs(1);
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
431 if (nel_User_knobs > 1)
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
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
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
434 // print knob settings if spumoni is set
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
435 if (spumoni)
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
436 {
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
437 octave_stdout << "\ncsymamd version " << CCOLAMD_MAIN_VERSION
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
438 << "." << CCOLAMD_SUB_VERSION
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
439 << ", " << CCOLAMD_DATE << "\n";
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
440
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
441 if (knobs[CCOLAMD_DENSE_ROW] >= 0)
15021
0fd364b9bf63 maint: Cuddle parenthesis for indexing expressions in ccolamd.cc.
Rik <rik@octave.org>
parents: 15020
diff changeset
442 octave_stdout << "knobs(1): " << User_knobs(0)
14854
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
443 << ", rows/cols with > max (16,"
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
444 << knobs[CCOLAMD_DENSE_ROW]
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
445 << "*sqrt (size(A,2)))"
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
446 << " entries removed\n";
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
447 else
15021
0fd364b9bf63 maint: Cuddle parenthesis for indexing expressions in ccolamd.cc.
Rik <rik@octave.org>
parents: 15020
diff changeset
448 octave_stdout << "knobs(1): " << User_knobs(0)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
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
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
451 if (knobs[CCOLAMD_AGGRESSIVE] != 0)
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
452 octave_stdout << "knobs(2): " << User_knobs(1)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
453 << ", aggressive absorption: yes";
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
454 else
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
455 octave_stdout << "knobs(2): " << User_knobs(1)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
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
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
458
15021
0fd364b9bf63 maint: Cuddle parenthesis for indexing expressions in ccolamd.cc.
Rik <rik@octave.org>
parents: 15020
diff changeset
459 octave_stdout << "knobs(3): " << User_knobs(2)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
460 << ", statistics and knobs printed\n";
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
461 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
462 }
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
463
13219
cf5ebc0e47e4 fix warnings for unused but set variables and shadowed variables
John W. Eaton <jwe@octave.org>
parents: 11586
diff changeset
464 octave_idx_type n_row, n_col;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
465 octave_idx_type *ridx, *cidx;
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
466 SparseMatrix sm;
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
467 SparseComplexMatrix scm;
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
468
5631
7171d19706df [project @ 2006-02-22 20:15:06 by dbateman]
dbateman
parents: 5604
diff changeset
469 if (args(0).is_sparse_type ())
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
470 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
471 if (args(0).is_complex_type ())
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
472 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
473 scm = args(0).sparse_complex_matrix_value ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
474 n_row = scm.rows ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
475 n_col = scm.cols ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
476 ridx = scm.xridx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
477 cidx = scm.xcidx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
478 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
479 else
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
480 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
481 sm = args(0).sparse_matrix_value ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
482 n_row = sm.rows ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
483 n_col = sm.cols ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
484 ridx = sm.xridx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
485 cidx = sm.xcidx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
486 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
487 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
488 else
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
489 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
490 if (args(0).is_complex_type ())
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
491 sm = SparseMatrix (real (args(0).complex_matrix_value ()));
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
492 else
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
493 sm = SparseMatrix (args(0).matrix_value ());
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
494
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
495 n_row = sm.rows ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
496 n_col = sm.cols ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
497 ridx = sm.xridx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
498 cidx = sm.xcidx ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
499 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
500
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
501 if (n_row != n_col)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
502 {
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
503 error ("csymamd: matrix S must be square");
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
504 return retval;
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
505 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
506
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
507 // Allocate workspace for symamd
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
508 OCTAVE_LOCAL_BUFFER (octave_idx_type, perm, n_col+1);
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
509 OCTAVE_LOCAL_BUFFER (octave_idx_type, stats, CCOLAMD_STATS);
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
510
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
511 if (nargin > 2)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
512 {
14846
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14844
diff changeset
513 NDArray in_cmember = args(2).array_value ();
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14844
diff changeset
514 octave_idx_type cslen = in_cmember.length ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
515 OCTAVE_LOCAL_BUFFER (octave_idx_type, cmember, cslen);
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
516 for (octave_idx_type i = 0; i < cslen; i++)
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
517 // convert cmember from 1-based to 0-based
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
518 cmember[i] = static_cast<octave_idx_type>(in_cmember(i) - 1);
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
519
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
520 if (cslen != n_col)
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
521 error ("csymamd: CMEMBER must be of length equal to #cols of A");
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
522 else if (!CSYMAMD_NAME () (n_col, ridx, cidx, perm, knobs, stats,
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
523 &calloc, &free, cmember, -1))
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
524 {
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
525 CSYMAMD_NAME (_report) (stats) ;
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
526 error ("csymamd: internal error!") ;
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
527 return retval;
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
528 }
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
529 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
530 else
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
531 {
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
532 if (!CSYMAMD_NAME () (n_col, ridx, cidx, perm, knobs, stats,
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
533 &calloc, &free, 0, -1))
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
534 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
535 CSYMAMD_NAME (_report) (stats) ;
11553
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
536 error ("csymamd: internal error!") ;
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
537 return retval;
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
538 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
539 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
540
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
541 // return the permutation vector
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
542 NDArray out_perm (dim_vector (1, n_col));
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
543 for (octave_idx_type i = 0; i < n_col; i++)
14854
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14846
diff changeset
544 out_perm(i) = perm[i] + 1;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
545
14844
5bc9b9cb4362 maint: Use Octave coding conventions for cuddled parenthesis in retval assignments.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
546 retval(0) = out_perm;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
547
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
548 // Return the stats vector
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
549 if (nargout == 2)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
550 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
551 NDArray out_stats (dim_vector (1, CCOLAMD_STATS));
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
552 for (octave_idx_type i = 0 ; i < CCOLAMD_STATS ; i++)
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
553 out_stats(i) = stats[i] ;
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
554 retval(1) = out_stats;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
555
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
556 // fix stats (5) and (6), for 1-based information on
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
557 // jumbled matrix. note that this correction doesn't
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
558 // occur if symamd returns FALSE
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
559 out_stats (CCOLAMD_INFO1) ++ ;
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
560 out_stats (CCOLAMD_INFO2) ++ ;
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
561 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
562
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
563 // print stats if spumoni > 0
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
564 if (spumoni > 0)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
565 CSYMAMD_NAME (_report) (stats) ;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
566
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
567 // Return the stats vector
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
568 if (nargout == 2)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
569 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
570 NDArray out_stats (dim_vector (1, CCOLAMD_STATS));
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
571 for (octave_idx_type i = 0 ; i < CCOLAMD_STATS ; i++)
15020
560317fd5977 maint: Cuddle open bracket used for indexing C++ arrays in source code.
Rik <rik@octave.org>
parents: 14854
diff changeset
572 out_stats(i) = stats[i] ;
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
573 retval(1) = out_stats;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
574
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
575 // fix stats (5) and (6), for 1-based information on
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
576 // jumbled matrix. note that this correction doesn't
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
577 // occur if symamd returns FALSE
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
578 out_stats (CCOLAMD_INFO1) ++ ;
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
579 out_stats (CCOLAMD_INFO2) ++ ;
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 9064
diff changeset
580 }
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
581 }
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
582
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
583 #else
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
584
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
585 error ("csymamd: not available in this version of Octave");
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
586
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
587 #endif
5771
9c7be8e14b5b [project @ 2006-04-18 19:17:33 by jwe]
jwe
parents: 5760
diff changeset
588
9c7be8e14b5b [project @ 2006-04-18 19:17:33 by jwe]
jwe
parents: 5760
diff changeset
589 return retval;
5451
ed08548b9054 [project @ 2005-09-15 19:52:50 by jwe]
jwe
parents:
diff changeset
590 }