Mercurial > octave
annotate libinterp/corefcn/dmperm.cc @ 29958:32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
* mk-opts.pl: Surround emitted function definitions with
OCTAVE_NAMESPACE_BEGIN and OCTAVE_NAMESPACE_END tags.
* mk-builtins.pl: Surround emitted function declarations with
OCTAVE_NAMESPACE_BEGIN and OCTAVE_NAMESPACE_END tags. Emit deprecated
global inline functions.
* __betainc__.cc, __contourc__.cc, __dsearchn__.cc, __eigs__.cc,
__expint__.cc, __ftp__.cc, __gammainc__.cc, __ichol__.cc, __ilu__.cc,
__lin_interpn__.cc, __magick_read__.cc, __pchip_deriv__.cc, __qp__.cc,
amd.cc, balance.cc, besselj.cc, bitfcns.cc, bsxfun.cc, call-stack.cc,
ccolamd.cc, cellfun.cc, chol.cc, colamd.cc, colloc.cc, conv2.cc,
daspk.cc, dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc,
defun.cc, det.cc, dirfns.cc, display.cc, dlmread.cc, dmperm.cc,
dot.cc, eig.cc, ellipj.cc, environment.cc, error.cc, event-manager.cc,
fcn-info.cc, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc,
gcd.cc, getgrent.cc, getpwent.cc, getrusage.cc, givens.cc,
graphics.cc, gsvd.cc, hash.cc, help.cc, hess.cc, hex2num.cc, input.cc,
interpreter.cc, inv.cc, jsondecode.cc, jsonencode.cc, kron.cc,
load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc,
lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc,
oct-hist.cc, ordqz.cc, ordschur.cc, pager.cc, pinv.cc, pr-flt-fmt.cc,
pr-output.cc, psi.cc, qr.cc, quad.cc, quadcc.cc, qz.cc, rand.cc,
rcond.cc, regexp.cc, schur.cc, settings.cc, sighandlers.cc, sparse.cc,
spparms.cc, sqrtm.cc, stream-euler.cc, strfind.cc, strfns.cc,
sub2ind.cc, svd.cc, sylvester.cc, symbfact.cc, symrcm.cc, symtab.cc,
syscalls.cc, sysdep.cc, time.cc, toplev.cc, tril.cc, tsearch.cc,
typecast.cc, urlwrite.cc, utils.cc, variables.cc, __delaunayn__.cc,
__fltk_uigetfile__.cc, __glpk__.cc, __init_gnuplot__.cc, __ode15__.cc,
__voronoi__.cc, audiodevinfo.cc, audioread.cc, convhulln.cc, fftw.cc,
gzip.cc, ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc,
ov-classdef.cc, ov-fcn-handle.cc, ov-java.cc, ov-null-mat.cc,
ov-oncleanup.cc, ov-struct.cc, ov-typeinfo.cc, ov-usr-fcn.cc, ov.cc,
octave.cc, lex.ll, oct-parse.yy, profiler.cc, pt-eval.cc: Surround
DEFUN and DEFMETHOD function defnitions with OCTAVE_NAMESPACE_BEGIN
and OCTAVE_NAMESPACE_END tags.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Fri, 13 Aug 2021 21:53:51 -0400 |
parents | 7854d5752dd2 |
children | 7d6709900da7 |
rev | line source |
---|---|
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
1 //////////////////////////////////////////////////////////////////////// |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
2 // |
29358
0a5b15007766
update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
3 // Copyright (C) 1998-2021 The Octave Project Developers |
27923
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
4 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
5 // See the file COPYRIGHT.md in the top-level directory of this |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
6 // distribution or <https://octave.org/copyright/>. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
7 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
8 // This file is part of Octave. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
9 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
10 // Octave is free software: you can redistribute it and/or modify it |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
11 // under the terms of the GNU General Public License as published by |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
12 // the Free Software Foundation, either version 3 of the License, or |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
13 // (at your option) any later version. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
14 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
15 // Octave is distributed in the hope that it will be useful, but |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
16 // WITHOUT ANY WARRANTY; without even the implied warranty of |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
18 // GNU General Public License for more details. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
19 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
20 // You should have received a copy of the GNU General Public License |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
21 // along with Octave; see the file COPYING. If not, see |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
22 // <https://www.gnu.org/licenses/>. |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
23 // |
bd51beb6205e
update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents:
27919
diff
changeset
|
24 //////////////////////////////////////////////////////////////////////// |
5610 | 25 |
21724
aba2e6293dd8
use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents:
21691
diff
changeset
|
26 #if defined (HAVE_CONFIG_H) |
21301
40de9f8f23a6
Use '#include "config.h"' rather than <config.h>.
Rik <rik@octave.org>
parents:
21229
diff
changeset
|
27 # include "config.h" |
5610 | 28 #endif |
29 | |
23024
a6a7b054e4ba
Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents:
22755
diff
changeset
|
30 #include "CSparse.h" |
a6a7b054e4ba
Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents:
22755
diff
changeset
|
31 #include "dRowVector.h" |
a6a7b054e4ba
Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents:
22755
diff
changeset
|
32 #include "dSparse.h" |
a6a7b054e4ba
Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents:
22755
diff
changeset
|
33 #include "oct-sparse.h" |
a6a7b054e4ba
Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents:
22755
diff
changeset
|
34 |
28024
c28b8ba841fb
move sparse functions from dldfcn to corefcn directory (bug #57459)
John W. Eaton <jwe@octave.org>
parents:
27923
diff
changeset
|
35 #include "defun.h" |
21100
e39e05d90788
Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
Rik <rik@octave.org>
parents:
20940
diff
changeset
|
36 #include "errwarn.h" |
23024
a6a7b054e4ba
Rationalize #includes in libinterp/dldfcn directory.
Rik <rik@octave.org>
parents:
22755
diff
changeset
|
37 #include "ov.h" |
20940
48b2ad5ee801
maint: Rename oct-obj.[cc|h] to ovl.[cc|h] for clarity.
Rik <rik@octave.org>
parents:
20939
diff
changeset
|
38 #include "ovl.h" |
5610 | 39 #include "utils.h" |
40 | |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29359
diff
changeset
|
41 OCTAVE_NAMESPACE_BEGIN |
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29359
diff
changeset
|
42 |
21229
a83e7a384ee0
create and install a subset of config.h in octave-config.h
John W. Eaton <jwe@octave.org>
parents:
21211
diff
changeset
|
43 #if defined (OCTAVE_ENABLE_64) |
21200
fcac5dbbf9ed
maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents:
21176
diff
changeset
|
44 # define CXSPARSE_NAME(name) cs_dl ## name |
5610 | 45 #else |
21200
fcac5dbbf9ed
maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents:
21176
diff
changeset
|
46 # define CXSPARSE_NAME(name) cs_di ## name |
5610 | 47 #endif |
48 | |
21691
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21580
diff
changeset
|
49 #if defined (HAVE_CXSPARSE) |
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21580
diff
changeset
|
50 |
5610 | 51 static RowVector |
23391
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
52 put_int (octave::suitesparse_integer *p, octave_idx_type n) |
5610 | 53 { |
54 RowVector ret (n); | |
55 for (octave_idx_type i = 0; i < n; i++) | |
14854
5ae9f0f77635
maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents:
14846
diff
changeset
|
56 ret.xelem (i) = p[i] + 1; |
5610 | 57 return ret; |
58 } | |
59 | |
6066 | 60 static octave_value_list |
61 dmperm_internal (bool rank, const octave_value arg, int nargout) | |
5610 | 62 { |
63 octave_value_list retval; | |
64 octave_idx_type nr = arg.rows (); | |
65 octave_idx_type nc = arg.columns (); | |
66 SparseMatrix m; | |
67 SparseComplexMatrix cm; | |
5648 | 68 CXSPARSE_NAME () csm; |
5610 | 69 csm.m = nr; |
70 csm.n = nc; | |
23795
980f39c3ab90
Use C++11 nullptr rather than 0 in code (bug #51565).
Rik <rik@octave.org>
parents:
23582
diff
changeset
|
71 csm.x = nullptr; |
5610 | 72 csm.nz = -1; |
73 | |
23582
0cc2011d800e
maint: Deprecate is_real_type and replace with isreal.
Rik <rik@octave.org>
parents:
23391
diff
changeset
|
74 if (arg.isreal ()) |
5610 | 75 { |
76 m = arg.sparse_matrix_value (); | |
14846
460a3c6d8bf1
maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents:
14501
diff
changeset
|
77 csm.nzmax = m.nnz (); |
23391
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
78 csm.p = octave::to_suitesparse_intptr (m.xcidx ()); |
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
79 csm.i = octave::to_suitesparse_intptr (m.xridx ()); |
5610 | 80 } |
81 else | |
82 { | |
83 cm = arg.sparse_complex_matrix_value (); | |
14846
460a3c6d8bf1
maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents:
14501
diff
changeset
|
84 csm.nzmax = cm.nnz (); |
23391
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
85 csm.p = octave::to_suitesparse_intptr (cm.xcidx ()); |
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
86 csm.i = octave::to_suitesparse_intptr (cm.xridx ()); |
5610 | 87 } |
88 | |
20555
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20163
diff
changeset
|
89 if (nargout <= 1 || rank) |
5610 | 90 { |
23391
209e749363a2
safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510)
John W. Eaton <jwe@octave.org>
parents:
23220
diff
changeset
|
91 octave::suitesparse_integer *jmatch = CXSPARSE_NAME (_maxtrans) (&csm, 0); |
20555
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20163
diff
changeset
|
92 if (rank) |
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20163
diff
changeset
|
93 { |
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20163
diff
changeset
|
94 octave_idx_type r = 0; |
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20163
diff
changeset
|
95 for (octave_idx_type i = 0; i < nc; i++) |
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20163
diff
changeset
|
96 if (jmatch[nr+i] >= 0) |
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20163
diff
changeset
|
97 r++; |
25688
b2917b7858ba
maint: Use Octave convention for spacing of C++ cast statements.
Rik <rik@octave.org>
parents:
25054
diff
changeset
|
98 retval(0) = static_cast<double> (r); |
10154
40dfc0c99116
DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents:
9064
diff
changeset
|
99 } |
5610 | 100 else |
20555
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20163
diff
changeset
|
101 retval(0) = put_int (jmatch + nr, nc); |
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20163
diff
changeset
|
102 CXSPARSE_NAME (_free) (jmatch); |
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20163
diff
changeset
|
103 } |
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20163
diff
changeset
|
104 else |
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20163
diff
changeset
|
105 { |
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20163
diff
changeset
|
106 CXSPARSE_NAME (d) *dm = CXSPARSE_NAME(_dmperm) (&csm, 0); |
6066 | 107 |
20860
61892a245653
2015 Code Sprint: dmperm.cc: use ovl().
Rik <rik@octave.org>
parents:
20853
diff
changeset
|
108 retval = ovl (put_int (dm->p, nr), put_int (dm->q, nc), |
28410
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
109 put_int (dm->r, dm->nb+1), put_int (dm->s, dm->nb+1), |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
110 put_int (dm->cc, 5), put_int (dm->rr, 5)); |
21152
8ad3907b8fad
require CXSparse 2.2 or later
John W. Eaton <jwe@octave.org>
parents:
21140
diff
changeset
|
111 |
20555
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20163
diff
changeset
|
112 CXSPARSE_NAME (_dfree) (dm); |
5610 | 113 } |
20555
f90c8372b7ba
eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents:
20163
diff
changeset
|
114 |
6066 | 115 return retval; |
116 } | |
21691
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21580
diff
changeset
|
117 |
6066 | 118 #endif |
119 | |
28410
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
120 // NOTE: the docstring for dmperm is adapted from the text found in the |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
121 // file cs_dmperm.m that is distributed with the CSparse portion of the |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
122 // SuiteSparse library, version 5.6.0. CSparse is distributed under the |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
123 // terms of the LGPL v2.1 or any later version. |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
124 |
28024
c28b8ba841fb
move sparse functions from dldfcn to corefcn directory (bug #57459)
John W. Eaton <jwe@octave.org>
parents:
27923
diff
changeset
|
125 DEFUN (dmperm, args, nargout, |
c28b8ba841fb
move sparse functions from dldfcn to corefcn directory (bug #57459)
John W. Eaton <jwe@octave.org>
parents:
27923
diff
changeset
|
126 doc: /* -*- texinfo -*- |
28410
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
127 @deftypefn {} {@var{p} =} dmperm (@var{A}) |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
128 @deftypefnx {} {[@var{p}, @var{q}, @var{r}, @var{s}, @var{cc}, @var{rr}] =} dmperm (@var{A}) |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
129 |
25003
2365c2661b3c
doc: Spellcheck documentation ahead of 4.4 release.
Rik <rik@octave.org>
parents:
24534
diff
changeset
|
130 @cindex @nospell{Dulmage-Mendelsohn} decomposition |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
131 Perform a @nospell{Dulmage-Mendelsohn} permutation of the sparse matrix |
28410
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
132 @var{A}. |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
133 |
28754 | 134 With a single output argument @code{dmperm}, return a maximum matching @var{p} |
135 such that @code{p(j) = i} if column @var{j} is matched to row @var{i}, or 0 if | |
136 column @var{j} is unmatched. If @var{A} is square and full structural rank, | |
137 @var{p} is a row permutation and @code{A(p,:)} has a zero-free diagonal. The | |
138 structural rank of @var{A} is @code{sprank(A) = sum(p>0)}. | |
28410
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
139 |
28754 | 140 Called with two or more output arguments, return the |
141 @nospell{Dulmage-Mendelsohn} decomposition of @var{A}. @var{p} and @var{q} are | |
142 permutation vectors. @var{cc} and @var{rr} are vectors of length 5. | |
143 @code{c = A(p,q)} is split into a 4-by-4 set of coarse blocks: | |
28410
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
144 |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
145 @example |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
146 @group |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
147 A11 A12 A13 A14 |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
148 0 0 A23 A24 |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
149 0 0 0 A34 |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
150 0 0 0 A44 |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
151 @end group |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
152 @end example |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
153 |
28410
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
154 @noindent |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
155 where @code{A12}, @code{A23}, and @code{A34} are square with zero-free |
28754 | 156 diagonals. The columns of @code{A11} are the unmatched columns, and the rows |
157 of @code{A44} are the unmatched rows. Any of these blocks can be empty. In | |
158 the "coarse" decomposition, the (i,j)-th block is | |
28410
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
159 @code{C(rr(i):rr(i+1)-1,cc(j):cc(j+1)-1)}. In terms of a linear system, |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
160 @code{[A11 A12]} is the underdetermined part of the system (it is always |
28754 | 161 rectangular and with more columns and rows, or 0-by-0), @code{A23} is the |
162 well-determined part of the system (it is always square), and | |
163 @code{[A34 ; A44]} is the over-determined part of the system (it is always | |
164 rectangular with more rows than columns, or 0-by-0). | |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
165 |
28754 | 166 The structural rank of @var{A} is @code{sprank (A) = rr(4)-1}, which is an |
167 upper bound on the numerical rank of @var{A}. | |
28410
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
168 @code{sprank(A) = rank(full(sprand(A)))} with probability 1 in exact |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
169 arithmetic. |
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
170 |
28754 | 171 The @code{A23} submatrix is further subdivided into block upper triangular form |
172 via the "fine" decomposition (the strongly-connected components of @code{A23}). | |
173 If @var{A} is square and structurally non-singular, @code{A23} is the entire | |
174 matrix. | |
28410
4bb892170ebb
also return 5th and 6th outputs from dmperm
John W. Eaton <jwe@octave.org>
parents:
28024
diff
changeset
|
175 |
28754 | 176 @code{C(r(i):r(i+1)-1,s(j):s(j+1)-1)} is the (i,j)-th block of the fine |
177 decomposition. The (1,1) block is the rectangular block @code{[A11 A12]}, | |
178 unless this block is 0-by-0. The (b,b) block is the rectangular block | |
179 @code{[A34 ; A44]}, unless this block is 0-by-0, where @code{b = length(r)-1}. | |
180 All other blocks of the form @code{C(r(i):r(i+1)-1,s(i):s(i+1)-1)} are diagonal | |
181 blocks of @code{A23}, and are square with a zero-free diagonal. | |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
182 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
183 The method used is described in: @nospell{A. Pothen & C.-J. Fan.} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
184 @cite{Computing the Block Triangular Form of a Sparse Matrix}. |
27795
afbaad39d25c
doc: grammarcheck C++ files in libinterp/ directory.
Rik <rik@octave.org>
parents:
27585
diff
changeset
|
185 @nospell{ACM} Trans.@: Math.@: Software, 16(4):303--324, 1990. |
21966
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
186 @seealso{colamd, ccolamd} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
187 @end deftypefn */) |
6066 | 188 { |
21211
2cf8bc5c7017
use "#if defined (HAVE_FOO)" instead of "#if HAVE_FOO" for feature tests
John W. Eaton <jwe@octave.org>
parents:
21200
diff
changeset
|
189 #if defined (HAVE_CXSPARSE) |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
190 |
20818
cef0448a6ed2
eliminate unnecessary uses of nargin
John W. Eaton <jwe@octave.org>
parents:
20812
diff
changeset
|
191 if (args.length () != 1) |
20790
c2d9556d51d0
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20555
diff
changeset
|
192 print_usage (); |
6066 | 193 |
23924
0519eaf0cca6
fix remaining spurious octave_value_list conversions (bug #51767)
Mike Miller <mtmiller@octave.org>
parents:
23795
diff
changeset
|
194 return dmperm_internal (false, args(0), nargout); |
20939
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20860
diff
changeset
|
195 |
5610 | 196 #else |
21691
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21580
diff
changeset
|
197 |
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21580
diff
changeset
|
198 octave_unused_parameter (args); |
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21580
diff
changeset
|
199 octave_unused_parameter (nargout); |
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21580
diff
changeset
|
200 |
21109
bd1752782e56
Use err_disabled_feature, warn_disabled_feature throughout code base.
Rik <rik@octave.org>
parents:
21100
diff
changeset
|
201 err_disabled_feature ("dmperm", "CXSparse"); |
21691
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21580
diff
changeset
|
202 |
5610 | 203 #endif |
204 } | |
205 | |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
206 /* |
7243 | 207 %!testif HAVE_CXSPARSE |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
208 %! n = 20; |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
209 %! a = speye (n,n); |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
210 %! a = a(randperm (n),:); |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
211 %! assert (a(dmperm (a),:), speye (n)); |
5610 | 212 |
7243 | 213 %!testif HAVE_CXSPARSE |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
214 %! n = 20; |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
215 %! d = 0.2; |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
216 %! a = tril (sprandn (n,n,d), -1) + speye (n,n); |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
217 %! a = a(randperm (n), randperm (n)); |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
218 %! [p,q,r,s] = dmperm (a); |
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
219 %! assert (tril (a(p,q), -1), sparse (n, n)); |
5610 | 220 */ |
221 | |
28024
c28b8ba841fb
move sparse functions from dldfcn to corefcn directory (bug #57459)
John W. Eaton <jwe@octave.org>
parents:
27923
diff
changeset
|
222 DEFUN (sprank, args, nargout, |
c28b8ba841fb
move sparse functions from dldfcn to corefcn directory (bug #57459)
John W. Eaton <jwe@octave.org>
parents:
27923
diff
changeset
|
223 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
|
224 @deftypefn {} {@var{p} =} sprank (@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
|
225 @cindex structural rank |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
226 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
227 Calculate the structural rank of the sparse 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
|
228 |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
229 Note that only the structure of the matrix is used in this calculation based |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
230 on a @nospell{Dulmage-Mendelsohn} permutation to block triangular form. As |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
231 such the numerical rank of the matrix @var{S} is bounded by |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
232 @code{sprank (@var{S}) >= rank (@var{S})}. Ignoring floating point errors |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
233 @code{sprank (@var{S}) == rank (@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
|
234 @seealso{dmperm} |
112b20240c87
move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents:
21724
diff
changeset
|
235 @end deftypefn */) |
6066 | 236 { |
21211
2cf8bc5c7017
use "#if defined (HAVE_FOO)" instead of "#if HAVE_FOO" for feature tests
John W. Eaton <jwe@octave.org>
parents:
21200
diff
changeset
|
237 #if defined (HAVE_CXSPARSE) |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
238 |
20818
cef0448a6ed2
eliminate unnecessary uses of nargin
John W. Eaton <jwe@octave.org>
parents:
20812
diff
changeset
|
239 if (args.length () != 1) |
20790
c2d9556d51d0
eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents:
20555
diff
changeset
|
240 print_usage (); |
6066 | 241 |
23924
0519eaf0cca6
fix remaining spurious octave_value_list conversions (bug #51767)
Mike Miller <mtmiller@octave.org>
parents:
23795
diff
changeset
|
242 return dmperm_internal (true, args(0), nargout); |
20939
b17fda023ca6
maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents:
20860
diff
changeset
|
243 |
6066 | 244 #else |
21691
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21580
diff
changeset
|
245 |
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21580
diff
changeset
|
246 octave_unused_parameter (args); |
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21580
diff
changeset
|
247 octave_unused_parameter (nargout); |
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21580
diff
changeset
|
248 |
21109
bd1752782e56
Use err_disabled_feature, warn_disabled_feature throughout code base.
Rik <rik@octave.org>
parents:
21100
diff
changeset
|
249 err_disabled_feature ("sprank", "CXSparse"); |
21691
263d18409fdf
Eliminate unused variable warnings for conditionally compiled code.
John W. Eaton <jwe@octave.org>
parents:
21580
diff
changeset
|
250 |
6066 | 251 #endif |
252 } | |
253 | |
11586
12df7854fa7c
strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
11553
diff
changeset
|
254 /* |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
255 %!testif HAVE_CXSPARSE |
21580
ecce63c99c3f
maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents:
21301
diff
changeset
|
256 %! assert (sprank (speye (20)), 20); |
7243 | 257 %!testif HAVE_CXSPARSE |
21580
ecce63c99c3f
maint: Add semicolons to terminate code in %! blocks.
Rik <rik@octave.org>
parents:
21301
diff
changeset
|
258 %! assert (sprank ([1,0,2,0;2,0,4,0]), 2); |
6066 | 259 |
14501
60e5cf354d80
Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
260 %!error sprank (1,2) |
6066 | 261 */ |
29958
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29359
diff
changeset
|
262 |
32c3a5805893
move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents:
29359
diff
changeset
|
263 OCTAVE_NAMESPACE_END |