Mercurial > octave
view libinterp/corefcn/dmperm.cc @ 31605:e88a07dec498 stable
maint: Use macros to begin/end C++ namespaces.
* oct-conf-post-public.in.h: Define two macros (OCTAVE_BEGIN_NAMESPACE,
OCTAVE_END_NAMESPACE) that can be used to start/end a namespace.
* mk-opts.pl, build-env.h, build-env.in.cc, __betainc__.cc, __contourc__.cc,
__dsearchn__.cc, __eigs__.cc, __expint__.cc, __ftp__.cc, __gammainc__.cc,
__ichol__.cc, __ilu__.cc, __isprimelarge__.cc, __lin_interpn__.cc,
__magick_read__.cc, __pchip_deriv__.cc, __qp__.cc, amd.cc, auto-shlib.cc,
auto-shlib.h, balance.cc, base-text-renderer.cc, base-text-renderer.h,
besselj.cc, bitfcns.cc, bsxfun.cc, c-file-ptr-stream.cc, c-file-ptr-stream.h,
call-stack.cc, call-stack.h, ccolamd.cc, cellfun.cc, chol.cc, colamd.cc,
colloc.cc, conv2.cc, daspk.cc, dasrt.cc, dassl.cc, data.cc, data.h, debug.cc,
defaults.cc, defaults.h, defun-int.h, defun.cc, det.cc, dirfns.cc, display.cc,
display.h, dlmread.cc, dmperm.cc, dot.cc, dynamic-ld.cc, dynamic-ld.h, eig.cc,
ellipj.cc, environment.cc, environment.h, error.cc, error.h, errwarn.h,
event-manager.cc, event-manager.h, event-queue.cc, event-queue.h, fcn-info.cc,
fcn-info.h, fft.cc, fft2.cc, fftn.cc, file-io.cc, filter.cc, find.cc,
ft-text-renderer.cc, ft-text-renderer.h, gcd.cc, getgrent.cc, getpwent.cc,
getrusage.cc, givens.cc, gl-render.cc, gl-render.h, gl2ps-print.cc,
gl2ps-print.h, graphics-toolkit.cc, graphics-toolkit.h, graphics.cc,
graphics.in.h, gsvd.cc, gtk-manager.cc, gtk-manager.h, hash.cc, help.cc,
help.h, hess.cc, hex2num.cc, hook-fcn.cc, hook-fcn.h, input.cc, input.h,
interpreter-private.cc, interpreter-private.h, interpreter.cc, interpreter.h,
inv.cc, jsondecode.cc, jsonencode.cc, kron.cc, latex-text-renderer.cc,
latex-text-renderer.h, load-path.cc, load-path.h, load-save.cc, load-save.h,
lookup.cc, ls-ascii-helper.cc, ls-ascii-helper.h, ls-oct-text.cc, ls-utils.cc,
ls-utils.h, lsode.cc, lu.cc, mappers.cc, matrix_type.cc, max.cc, mex-private.h,
mex.cc, mgorth.cc, nproc.cc, oct-fstrm.cc, oct-fstrm.h, oct-hdf5-types.cc,
oct-hdf5-types.h, oct-hist.cc, oct-hist.h, oct-iostrm.cc, oct-iostrm.h,
oct-opengl.h, oct-prcstrm.cc, oct-prcstrm.h, oct-procbuf.cc, oct-procbuf.h,
oct-process.cc, oct-process.h, oct-stdstrm.h, oct-stream.cc, oct-stream.h,
oct-strstrm.cc, oct-strstrm.h, oct-tex-lexer.in.ll, oct-tex-parser.yy,
ordqz.cc, ordschur.cc, pager.cc, pager.h, pinv.cc, pow2.cc, pr-flt-fmt.cc,
pr-output.cc, procstream.cc, procstream.h, psi.cc, qr.cc, quad.cc, quadcc.cc,
qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, settings.cc, settings.h,
sighandlers.cc, sighandlers.h, sparse-xdiv.cc, sparse-xdiv.h, sparse-xpow.cc,
sparse-xpow.h, sparse.cc, spparms.cc, sqrtm.cc, stack-frame.cc, stack-frame.h,
stream-euler.cc, strfind.cc, strfns.cc, sub2ind.cc, svd.cc, sylvester.cc,
symbfact.cc, syminfo.cc, syminfo.h, symrcm.cc, symrec.cc, symrec.h,
symscope.cc, symscope.h, symtab.cc, symtab.h, syscalls.cc, sysdep.cc, sysdep.h,
text-engine.cc, text-engine.h, text-renderer.cc, text-renderer.h, time.cc,
toplev.cc, tril.cc, tsearch.cc, typecast.cc, url-handle-manager.cc,
url-handle-manager.h, urlwrite.cc, utils.cc, utils.h, variables.cc,
variables.h, xdiv.cc, xdiv.h, xnorm.cc, xnorm.h, xpow.cc, xpow.h,
__delaunayn__.cc, __fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __ode15__.cc, __voronoi__.cc, audiodevinfo.cc,
audioread.cc, convhulln.cc, fftw.cc, gzip.cc, mk-build-env-features.sh,
mk-builtins.pl, cdef-class.cc, cdef-class.h, cdef-fwd.h, cdef-manager.cc,
cdef-manager.h, cdef-method.cc, cdef-method.h, cdef-object.cc, cdef-object.h,
cdef-package.cc, cdef-package.h, cdef-property.cc, cdef-property.h,
cdef-utils.cc, cdef-utils.h, ov-base.cc, ov-base.h, ov-bool-mat.cc,
ov-builtin.h, ov-cell.cc, ov-class.cc, ov-class.h, ov-classdef.cc,
ov-classdef.h, ov-complex.cc, ov-fcn-handle.cc, ov-fcn-handle.h, ov-fcn.h,
ov-java.cc, ov-java.h, ov-mex-fcn.h, ov-null-mat.cc, ov-oncleanup.cc,
ov-struct.cc, ov-typeinfo.cc, ov-typeinfo.h, ov-usr-fcn.cc, ov-usr-fcn.h,
ov.cc, ov.h, octave.cc, octave.h, mk-ops.sh, op-b-b.cc, op-b-bm.cc,
op-b-sbm.cc, op-bm-b.cc, op-bm-bm.cc, op-bm-sbm.cc, op-cdm-cdm.cc, op-cell.cc,
op-chm.cc, op-class.cc, op-cm-cm.cc, op-cm-cs.cc, op-cm-m.cc, op-cm-s.cc,
op-cm-scm.cc, op-cm-sm.cc, op-cs-cm.cc, op-cs-cs.cc, op-cs-m.cc, op-cs-s.cc,
op-cs-scm.cc, op-cs-sm.cc, op-dm-dm.cc, op-dm-scm.cc, op-dm-sm.cc,
op-dm-template.cc, op-dms-template.cc, op-fcdm-fcdm.cc, op-fcm-fcm.cc,
op-fcm-fcs.cc, op-fcm-fm.cc, op-fcm-fs.cc, op-fcn.cc, op-fcs-fcm.cc,
op-fcs-fcs.cc, op-fcs-fm.cc, op-fcs-fs.cc, op-fdm-fdm.cc, op-fm-fcm.cc,
op-fm-fcs.cc, op-fm-fm.cc, op-fm-fs.cc, op-fs-fcm.cc, op-fs-fcs.cc,
op-fs-fm.cc, op-fs-fs.cc, op-i16-i16.cc, op-i32-i32.cc, op-i64-i64.cc,
op-i8-i8.cc, op-int-concat.cc, op-m-cm.cc, op-m-cs.cc, op-m-m.cc, op-m-s.cc,
op-m-scm.cc, op-m-sm.cc, op-mi.cc, op-pm-pm.cc, op-pm-scm.cc, op-pm-sm.cc,
op-pm-template.cc, op-range.cc, op-s-cm.cc, op-s-cs.cc, op-s-m.cc, op-s-s.cc,
op-s-scm.cc, op-s-sm.cc, op-sbm-b.cc, op-sbm-bm.cc, op-sbm-sbm.cc,
op-scm-cm.cc, op-scm-cs.cc, op-scm-m.cc, op-scm-s.cc, op-scm-scm.cc,
op-scm-sm.cc, op-sm-cm.cc, op-sm-cs.cc, op-sm-m.cc, op-sm-s.cc, op-sm-scm.cc,
op-sm-sm.cc, op-str-m.cc, op-str-s.cc, op-str-str.cc, op-struct.cc,
op-ui16-ui16.cc, op-ui32-ui32.cc, op-ui64-ui64.cc, op-ui8-ui8.cc, ops.h,
anon-fcn-validator.cc, anon-fcn-validator.h, bp-table.cc, bp-table.h,
comment-list.cc, comment-list.h, filepos.h, lex.h, lex.ll, oct-lvalue.cc,
oct-lvalue.h, oct-parse.yy, parse.h, profiler.cc, profiler.h,
pt-anon-scopes.cc, pt-anon-scopes.h, pt-arg-list.cc, pt-arg-list.h,
pt-args-block.cc, pt-args-block.h, pt-array-list.cc, pt-array-list.h,
pt-assign.cc, pt-assign.h, pt-binop.cc, pt-binop.h, pt-bp.cc, pt-bp.h,
pt-cbinop.cc, pt-cbinop.h, pt-cell.cc, pt-cell.h, pt-check.cc, pt-check.h,
pt-classdef.cc, pt-classdef.h, pt-cmd.h, pt-colon.cc, pt-colon.h, pt-const.cc,
pt-const.h, pt-decl.cc, pt-decl.h, pt-eval.cc, pt-eval.h, pt-except.cc,
pt-except.h, pt-exp.cc, pt-exp.h, pt-fcn-handle.cc, pt-fcn-handle.h, pt-id.cc,
pt-id.h, pt-idx.cc, pt-idx.h, pt-jump.h, pt-loop.cc, pt-loop.h, pt-mat.cc,
pt-mat.h, pt-misc.cc, pt-misc.h, pt-pr-code.cc, pt-pr-code.h, pt-select.cc,
pt-select.h, pt-spmd.cc, pt-spmd.h, pt-stmt.cc, pt-stmt.h, pt-tm-const.cc,
pt-tm-const.h, pt-unop.cc, pt-unop.h, pt-vm-eval.cc, pt-walk.cc, pt-walk.h,
pt.cc, pt.h, token.cc, token.h, Range.cc, Range.h, idx-vector.cc, idx-vector.h,
range-fwd.h, CollocWt.cc, CollocWt.h, aepbalance.cc, aepbalance.h, chol.cc,
chol.h, gepbalance.cc, gepbalance.h, gsvd.cc, gsvd.h, hess.cc, hess.h,
lo-mappers.cc, lo-mappers.h, lo-specfun.cc, lo-specfun.h, lu.cc, lu.h,
oct-convn.cc, oct-convn.h, oct-fftw.cc, oct-fftw.h, oct-norm.cc, oct-norm.h,
oct-rand.cc, oct-rand.h, oct-spparms.cc, oct-spparms.h, qr.cc, qr.h, qrp.cc,
qrp.h, randgamma.cc, randgamma.h, randmtzig.cc, randmtzig.h, randpoisson.cc,
randpoisson.h, schur.cc, schur.h, sparse-chol.cc, sparse-chol.h, sparse-lu.cc,
sparse-lu.h, sparse-qr.cc, sparse-qr.h, svd.cc, svd.h, child-list.cc,
child-list.h, dir-ops.cc, dir-ops.h, file-ops.cc, file-ops.h, file-stat.cc,
file-stat.h, lo-sysdep.cc, lo-sysdep.h, lo-sysinfo.cc, lo-sysinfo.h,
mach-info.cc, mach-info.h, oct-env.cc, oct-env.h, oct-group.cc, oct-group.h,
oct-password.cc, oct-password.h, oct-syscalls.cc, oct-syscalls.h, oct-time.cc,
oct-time.h, oct-uname.cc, oct-uname.h, action-container.cc, action-container.h,
base-list.h, cmd-edit.cc, cmd-edit.h, cmd-hist.cc, cmd-hist.h, f77-fcn.h,
file-info.cc, file-info.h, lo-array-errwarn.cc, lo-array-errwarn.h, lo-hash.cc,
lo-hash.h, lo-ieee.h, lo-regexp.cc, lo-regexp.h, lo-utils.cc, lo-utils.h,
oct-base64.cc, oct-base64.h, oct-glob.cc, oct-glob.h, oct-inttypes.h,
oct-mutex.cc, oct-mutex.h, oct-refcount.h, oct-shlib.cc, oct-shlib.h,
oct-sparse.cc, oct-sparse.h, oct-string.h, octave-preserve-stream-state.h,
pathsearch.cc, pathsearch.h, quit.cc, quit.h, unwind-prot.cc, unwind-prot.h,
url-transfer.cc, url-transfer.h : Use new macros to begin/end C++ namespaces.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 01 Dec 2022 14:23:45 -0800 |
parents | 796f54d4ddbf |
children | 597f3ee61a48 |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1998-2022 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // This file is part of Octave. // // Octave is free software: you can redistribute it and/or modify it // under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Octave is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Octave; see the file COPYING. If not, see // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if defined (HAVE_CONFIG_H) # include "config.h" #endif #include "CSparse.h" #include "dRowVector.h" #include "dSparse.h" #include "oct-sparse.h" #include "defun.h" #include "errwarn.h" #include "ov.h" #include "ovl.h" #include "utils.h" OCTAVE_BEGIN_NAMESPACE(octave) #if defined (OCTAVE_ENABLE_64) # define CXSPARSE_NAME(name) cs_dl ## name #else # define CXSPARSE_NAME(name) cs_di ## name #endif #if defined (HAVE_CXSPARSE) static RowVector put_int (suitesparse_integer *p, octave_idx_type n) { RowVector ret (n); for (octave_idx_type i = 0; i < n; i++) ret.xelem (i) = p[i] + 1; return ret; } static octave_value_list dmperm_internal (bool rank, const octave_value arg, int nargout) { octave_value_list retval; octave_idx_type nr = arg.rows (); octave_idx_type nc = arg.columns (); SparseMatrix m; SparseComplexMatrix cm; CXSPARSE_NAME () csm; csm.m = nr; csm.n = nc; csm.x = nullptr; csm.nz = -1; if (arg.isreal ()) { m = arg.sparse_matrix_value (); csm.nzmax = m.nnz (); csm.p = to_suitesparse_intptr (m.xcidx ()); csm.i = to_suitesparse_intptr (m.xridx ()); } else { cm = arg.sparse_complex_matrix_value (); csm.nzmax = cm.nnz (); csm.p = to_suitesparse_intptr (cm.xcidx ()); csm.i = to_suitesparse_intptr (cm.xridx ()); } if (nargout <= 1 || rank) { suitesparse_integer *jmatch = CXSPARSE_NAME (_maxtrans) (&csm, 0); if (rank) { octave_idx_type r = 0; for (octave_idx_type i = 0; i < nc; i++) if (jmatch[nr+i] >= 0) r++; retval(0) = static_cast<double> (r); } else retval(0) = put_int (jmatch + nr, nc); CXSPARSE_NAME (_free) (jmatch); } else { CXSPARSE_NAME (d) *dm = CXSPARSE_NAME(_dmperm) (&csm, 0); retval = ovl (put_int (dm->p, nr), put_int (dm->q, nc), put_int (dm->r, dm->nb+1), put_int (dm->s, dm->nb+1), put_int (dm->cc, 5), put_int (dm->rr, 5)); CXSPARSE_NAME (_dfree) (dm); } return retval; } #endif // NOTE: the docstring for dmperm is adapted from the text found in the // file cs_dmperm.m that is distributed with the CSparse portion of the // SuiteSparse library, version 5.6.0. CSparse is distributed under the // terms of the LGPL v2.1 or any later version. DEFUN (dmperm, args, nargout, doc: /* -*- texinfo -*- @deftypefn {} {@var{p} =} dmperm (@var{A}) @deftypefnx {} {[@var{p}, @var{q}, @var{r}, @var{s}, @var{cc}, @var{rr}] =} dmperm (@var{A}) @cindex @nospell{Dulmage-Mendelsohn} decomposition Perform a @nospell{Dulmage-Mendelsohn} permutation of the sparse matrix @var{A}. With a single output argument @code{dmperm}, return a maximum matching @var{p} such that @code{p(j) = i} if column @var{j} is matched to row @var{i}, or 0 if column @var{j} is unmatched. If @var{A} is square and full structural rank, @var{p} is a row permutation and @code{A(p,:)} has a zero-free diagonal. The structural rank of @var{A} is @code{sprank(A) = sum(p>0)}. Called with two or more output arguments, return the @nospell{Dulmage-Mendelsohn} decomposition of @var{A}. @var{p} and @var{q} are permutation vectors. @var{cc} and @var{rr} are vectors of length 5. @code{c = A(p,q)} is split into a 4-by-4 set of coarse blocks: @example @group A11 A12 A13 A14 0 0 A23 A24 0 0 0 A34 0 0 0 A44 @end group @end example @noindent where @code{A12}, @code{A23}, and @code{A34} are square with zero-free diagonals. The columns of @code{A11} are the unmatched columns, and the rows of @code{A44} are the unmatched rows. Any of these blocks can be empty. In the "coarse" decomposition, the (i,j)-th block is @code{C(rr(i):rr(i+1)-1,cc(j):cc(j+1)-1)}. In terms of a linear system, @code{[A11 A12]} is the underdetermined part of the system (it is always rectangular and with more columns and rows, or 0-by-0), @code{A23} is the well-determined part of the system (it is always square), and @code{[A34 ; A44]} is the over-determined part of the system (it is always rectangular with more rows than columns, or 0-by-0). The structural rank of @var{A} is @code{sprank (A) = rr(4)-1}, which is an upper bound on the numerical rank of @var{A}. @code{sprank(A) = rank(full(sprand(A)))} with probability 1 in exact arithmetic. The @code{A23} submatrix is further subdivided into block upper triangular form via the "fine" decomposition (the strongly-connected components of @code{A23}). If @var{A} is square and structurally non-singular, @code{A23} is the entire matrix. @code{C(r(i):r(i+1)-1,s(j):s(j+1)-1)} is the (i,j)-th block of the fine decomposition. The (1,1) block is the rectangular block @code{[A11 A12]}, unless this block is 0-by-0. The (b,b) block is the rectangular block @code{[A34 ; A44]}, unless this block is 0-by-0, where @code{b = length(r)-1}. All other blocks of the form @code{C(r(i):r(i+1)-1,s(i):s(i+1)-1)} are diagonal blocks of @code{A23}, and are square with a zero-free diagonal. The method used is described in: @nospell{A. Pothen & C.-J. Fan.} @cite{Computing the Block Triangular Form of a Sparse Matrix}. @nospell{ACM} Trans.@: Math.@: Software, 16(4):303--324, 1990. @seealso{colamd, ccolamd} @end deftypefn */) { #if defined (HAVE_CXSPARSE) if (args.length () != 1) print_usage (); return dmperm_internal (false, args(0), nargout); #else octave_unused_parameter (args); octave_unused_parameter (nargout); err_disabled_feature ("dmperm", "CXSparse"); #endif } /* %!testif HAVE_CXSPARSE %! n = 20; %! a = speye (n,n); %! a = a(randperm (n),:); %! assert (a(dmperm (a),:), speye (n)); %!testif HAVE_CXSPARSE %! n = 20; %! d = 0.2; %! a = tril (sprandn (n,n,d), -1) + speye (n,n); %! a = a(randperm (n), randperm (n)); %! [p,q,r,s] = dmperm (a); %! assert (tril (a(p,q), -1), sparse (n, n)); */ DEFUN (sprank, args, nargout, doc: /* -*- texinfo -*- @deftypefn {} {@var{p} =} sprank (@var{S}) @cindex structural rank Calculate the structural rank of the sparse matrix @var{S}. Note that only the structure of the matrix is used in this calculation based on a @nospell{Dulmage-Mendelsohn} permutation to block triangular form. As such the numerical rank of the matrix @var{S} is bounded by @code{sprank (@var{S}) >= rank (@var{S})}. Ignoring floating point errors @code{sprank (@var{S}) == rank (@var{S})}. @seealso{dmperm} @end deftypefn */) { #if defined (HAVE_CXSPARSE) if (args.length () != 1) print_usage (); return dmperm_internal (true, args(0), nargout); #else octave_unused_parameter (args); octave_unused_parameter (nargout); err_disabled_feature ("sprank", "CXSparse"); #endif } /* %!testif HAVE_CXSPARSE %! assert (sprank (speye (20)), 20); %!testif HAVE_CXSPARSE %! assert (sprank ([1,0,2,0;2,0,4,0]), 2); %!error sprank (1,2) */ OCTAVE_END_NAMESPACE(octave)