octave: libinterp/dldfcn/dmperm.cc annotate

annotate libinterp/dldfcn/dmperm.cc @ 27795:afbaad39d25c

doc: grammarcheck C++ files in libinterp/ directory. * debug.cc, event-manager.cc, file-io.cc, stream-euler.cc, strfns.cc, urlwrite.cc, dmperm.cc: grammarcheck C++ files in libinterp/ directory.

author	Rik <rik@octave.org>
date	Tue, 10 Dec 2019 13:19:07 -0800
parents	757a7119e319
children	b442ec6dda5c

rev	line source
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	1 /*
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	2
26376 00f796120a6d maint: Update copyright dates in all source files. John W. Eaton <jwe@octave.org> parents: 25688 diff changeset	3 Copyright (C) 2005-2019 David Bateman
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 10840 diff changeset	4 Copyright (C) 1998-2005 Andy Adler
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6066 diff changeset	5
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6066 diff changeset	6 This file is part of Octave.
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	7
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23924 diff changeset	8 Octave is free software: you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	9 under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23924 diff changeset	10 the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	11 (at your option) any later version.
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	12
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	13 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	14 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22407 diff changeset	16 GNU General Public License for more details.
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	17
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	18 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: 6066 diff changeset	19 along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23924 diff changeset	20 <https://www.gnu.org/licenses/>.
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	21
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	22 */
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	23
21724 aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef" John W. Eaton <jwe@octave.org> parents: 21691 diff changeset	24 #if defined (HAVE_CONFIG_H)
21301 40de9f8f23a6 Use '#include "config.h"' rather than <config.h>. Rik <rik@octave.org> parents: 21229 diff changeset	25 # include "config.h"
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	26 #endif
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	27
23024 a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory. Rik <rik@octave.org> parents: 22755 diff changeset	28 #include "CSparse.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory. Rik <rik@octave.org> parents: 22755 diff changeset	29 #include "dRowVector.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory. Rik <rik@octave.org> parents: 22755 diff changeset	30 #include "dSparse.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory. Rik <rik@octave.org> parents: 22755 diff changeset	31 #include "oct-sparse.h"
a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory. Rik <rik@octave.org> parents: 22755 diff changeset	32
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	33 #include "defun-dld.h"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20940 diff changeset	34 #include "errwarn.h"
23024 a6a7b054e4ba Rationalize #includes in libinterp/dldfcn directory. Rik <rik@octave.org> parents: 22755 diff changeset	35 #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	36 #include "ovl.h"
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	37 #include "utils.h"
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	38
21229 a83e7a384ee0 create and install a subset of config.h in octave-config.h John W. Eaton <jwe@octave.org> parents: 21211 diff changeset	39 #if defined (OCTAVE_ENABLE_64)
21200 fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp. Rik <rik@octave.org> parents: 21176 diff changeset	40 # define CXSPARSE_NAME(name) cs_dl ## name
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	41 #else
21200 fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp. Rik <rik@octave.org> parents: 21176 diff changeset	42 # define CXSPARSE_NAME(name) cs_di ## name
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	43 #endif
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	44
21691 263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21580 diff changeset	45 #if defined (HAVE_CXSPARSE)
263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21580 diff changeset	46
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	47 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	48 put_int (octave::suitesparse_integer *p, octave_idx_type n)
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	49 {
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	50 RowVector ret (n);
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	51 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	52 ret.xelem (i) = p[i] + 1;
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	53 return ret;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	54 }
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	55
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	56 static octave_value_list
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	57 dmperm_internal (bool rank, const octave_value arg, int nargout)
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	58 {
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	59 octave_value_list retval;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	60 octave_idx_type nr = arg.rows ();
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	61 octave_idx_type nc = arg.columns ();
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	62 SparseMatrix m;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	63 SparseComplexMatrix cm;
5648 69a4f320d95a [project @ 2006-03-08 20:17:37 by dbateman] dbateman parents: 5642 diff changeset	64 CXSPARSE_NAME () csm;
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	65 csm.m = nr;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	66 csm.n = nc;
23795 980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565). Rik <rik@octave.org> parents: 23582 diff changeset	67 csm.x = nullptr;
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	68 csm.nz = -1;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	69
23582 0cc2011d800e maint: Deprecate is_real_type and replace with isreal. Rik <rik@octave.org> parents: 23391 diff changeset	70 if (arg.isreal ())
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	71 {
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	72 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	73 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	74 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	75 csm.i = octave::to_suitesparse_intptr (m.xridx ());
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	76 }
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	77 else
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	78 {
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	79 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	80 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	81 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	82 csm.i = octave::to_suitesparse_intptr (cm.xridx ());
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	83 }
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	84
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	85 if (nargout <= 1 \|\| rank)
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	86 {
23391 209e749363a2 safe cast between SuiteSparse_long and octave_idx_type pointers (bug #50510) John W. Eaton <jwe@octave.org> parents: 23220 diff changeset	87 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	88 if (rank)
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	89 {
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	90 octave_idx_type r = 0;
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	91 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	92 if (jmatch[nr+i] >= 0)
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	93 r++;
25688 b2917b7858ba maint: Use Octave convention for spacing of C++ cast statements. Rik <rik@octave.org> parents: 25054 diff changeset	94 retval(0) = static_cast<double> (r);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	95 }
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	96 else
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	97 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	98 CXSPARSE_NAME (_free) (jmatch);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	99 }
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	100 else
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	101 {
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	102 CXSPARSE_NAME (d) *dm = CXSPARSE_NAME(_dmperm) (&csm, 0);
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	103
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	104 //retval(5) = put_int (dm->rr, 5);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	105 //retval(4) = put_int (dm->cc, 5);
20860 61892a245653 2015 Code Sprint: dmperm.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	106 retval = ovl (put_int (dm->p, nr), put_int (dm->q, nc),
61892a245653 2015 Code Sprint: dmperm.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	107 put_int (dm->r, dm->nb+1), put_int (dm->s, dm->nb+1));
21152 8ad3907b8fad require CXSparse 2.2 or later John W. Eaton <jwe@octave.org> parents: 21140 diff changeset	108
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	109 CXSPARSE_NAME (_dfree) (dm);
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	110 }
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	111
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	112 return retval;
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	113 }
21691 263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21580 diff changeset	114
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	115 #endif
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	116
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	117 DEFUN_DLD (dmperm, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	118 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	119 @deftypefn {} {@var{p} =} dmperm (@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	120 @deftypefnx {} {[@var{p}, @var{q}, @var{r}, @var{S}] =} dmperm (@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	121
25003 2365c2661b3c doc: Spellcheck documentation ahead of 4.4 release. Rik <rik@octave.org> parents: 24534 diff changeset	122 @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	123 Perform a @nospell{Dulmage-Mendelsohn} permutation of the sparse matrix
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	124 @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	125
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	126 With a single output argument @code{dmperm} performs the row permutations
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	127 @var{p} such that @code{@var{S}(@var{p},:)} has no zero elements on the
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	128 diagonal.
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	129
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	130 Called with two or more output arguments, returns the row and column
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	131 permutations, such that @code{@var{S}(@var{p}, @var{q})} is in block
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	132 triangular form. The values of @var{r} and @var{S} define the boundaries
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	133 of the blocks. If @var{S} is square then @code{@var{r} == @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	134
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	135 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	136 @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	137 @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	138 @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	139 @end deftypefn */)
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	140 {
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	141 #if defined (HAVE_CXSPARSE)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	142
20818 cef0448a6ed2 eliminate unnecessary uses of nargin John W. Eaton <jwe@octave.org> parents: 20812 diff changeset	143 if (args.length () != 1)
20790 c2d9556d51d0 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	144 print_usage ();
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	145
23924 0519eaf0cca6 fix remaining spurious octave_value_list conversions (bug #51767) Mike Miller <mtmiller@octave.org> parents: 23795 diff changeset	146 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	147
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	148 #else
21691 263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21580 diff changeset	149
263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21580 diff changeset	150 octave_unused_parameter (args);
263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21580 diff changeset	151 octave_unused_parameter (nargout);
263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21580 diff changeset	152
21109 bd1752782e56 Use err_disabled_feature, warn_disabled_feature throughout code base. Rik <rik@octave.org> parents: 21100 diff changeset	153 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	154
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	155 #endif
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	156 }
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	157
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	158 /*
7243 e8d7eed42935 [project @ 2007-12-04 02:10:17 by jwe] jwe parents: 7017 diff changeset	159 %!testif HAVE_CXSPARSE
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	160 %! n = 20;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	161 %! a = speye (n,n);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	162 %! a = a(randperm (n),:);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	163 %! assert (a(dmperm (a),:), speye (n));
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	164
7243 e8d7eed42935 [project @ 2007-12-04 02:10:17 by jwe] jwe parents: 7017 diff changeset	165 %!testif HAVE_CXSPARSE
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	166 %! n = 20;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	167 %! d = 0.2;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	168 %! 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	169 %! 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	170 %! [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	171 %! assert (tril (a(p,q), -1), sparse (n, n));
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	172 */
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	173
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	174 DEFUN_DLD (sprank, args, nargout,
21966 112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	175 doc: /* -- texinfo --
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	176 @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	177 @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	178
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	179 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	180
112b20240c87 move docstrings in C++ files out of C strings and into comments John W. Eaton <jwe@octave.org> parents: 21724 diff changeset	181 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	182 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	183 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	184 @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	185 @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	186 @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	187 @end deftypefn */)
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	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 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	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 (true, args(0), nargout);
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20860 diff changeset	195
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	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 ("sprank", "CXSparse");
21691 263d18409fdf Eliminate unused variable warnings for conditionally compiled code. John W. Eaton <jwe@octave.org> parents: 21580 diff changeset	202
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	203 #endif
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	204 }
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	205
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	206 /*
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	207 %!testif HAVE_CXSPARSE
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21301 diff changeset	208 %! assert (sprank (speye (20)), 20);
7243 e8d7eed42935 [project @ 2007-12-04 02:10:17 by jwe] jwe parents: 7017 diff changeset	209 %!testif HAVE_CXSPARSE
21580 ecce63c99c3f maint: Add semicolons to terminate code in %! blocks. Rik <rik@octave.org> parents: 21301 diff changeset	210 %! assert (sprank ([1,0,2,0;2,0,4,0]), 2);
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	211
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	212 %!error sprank (1,2)
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	213 */

Mercurial > octave

annotate libinterp/dldfcn/dmperm.cc @ 27795:afbaad39d25c