octave: libinterp/dldfcn/dmperm.cc annotate

annotate libinterp/dldfcn/dmperm.cc @ 21211:2cf8bc5c7017

use "#if defined (HAVE_FOO)" instead of "#if HAVE_FOO" for feature tests * configure.ac (HAVE_HDF5_INT2FLOAT_CONVERSIONS): AC_DEFINE here. * ls-hdf5.cc (HAVE_HDF5_INT2FLOAT_CONVERSION): Delete definition. * ls-hdf5.cc, ls-hdf5.h, ccolamd.cc, dmperm.cc, ov-base-int.cc, ov-bool-mat.cc, ov-bool-sparse.cc, ov-bool.cc, ov-cell.cc, ov-class.cc, ov-complex.cc, ov-cx-mat.cc, ov-cx-sparse.cc, ov-fcn-handle.cc, ov-fcn-inline.cc, ov-float.cc, ov-flt-complex.cc, ov-flt-cx-mat.cc, ov-flt-re-mat.cc, ov-java.cc, ov-range.cc, ov-re-mat.cc, ov-re-sparse.cc, ov-scalar.cc, ov-str-mat.cc, ov-struct.cc, pt-eval.cc: Use #if defined (HAVE_FOO) instead of #if HAVE_FOO.

author	John W. Eaton <jwe@octave.org>
date	Sat, 06 Feb 2016 08:48:47 -0500
parents	fcac5dbbf9ed
children	a83e7a384ee0

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
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
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
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	8 Octave is free software; you can redistribute it and/or modify it
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	9 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: 6066 diff changeset	10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6066 diff changeset	11 option) any later version.
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	12
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	13 Octave is distributed in the hope that it will be useful, but WITHOUT
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	16 for more details.
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
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6066 diff changeset	20 <http://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
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	24 #ifdef HAVE_CONFIG_H
21200 fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp. Rik <rik@octave.org> parents: 21176 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
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	28 #include "defun-dld.h"
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	29 #include "error.h"
21100 e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme. Rik <rik@octave.org> parents: 20940 diff changeset	30 #include "errwarn.h"
20940 48b2ad5ee801 maint: Rename oct-obj.[cc\|h] to ovl.[cc\|h] for clarity. Rik <rik@octave.org> parents: 20939 diff changeset	31 #include "ovl.h"
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	32 #include "utils.h"
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	33
5616 44c592934077 [project @ 2006-02-10 22:42:38 by dbateman] dbateman parents: 5610 diff changeset	34 #include "oct-sparse.h"
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	35 #include "ov-re-sparse.h"
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	36 #include "ov-cx-sparse.h"
21176 791dcb32b657 revamp sparse QR factorizatino classes John W. Eaton <jwe@octave.org> parents: 21152 diff changeset	37 #include "sparse-qr.h"
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	38
21140 e06e600f396a eliminate use of USE_64_BIT_IDX_T John W. Eaton <jwe@octave.org> parents: 21109 diff changeset	39 #if defined (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
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	45 static RowVector
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	46 put_int (octave_idx_type *p, octave_idx_type n)
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	47 {
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	48 RowVector ret (n);
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	49 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	50 ret.xelem (i) = p[i] + 1;
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	51 return ret;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	52 }
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	53
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	54 #if defined (HAVE_CXSPARSE)
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	55 static octave_value_list
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	56 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	57 {
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	58 octave_value_list retval;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	59 octave_idx_type nr = arg.rows ();
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	60 octave_idx_type nc = arg.columns ();
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	61 SparseMatrix m;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	62 SparseComplexMatrix cm;
5648 69a4f320d95a [project @ 2006-03-08 20:17:37 by dbateman] dbateman parents: 5642 diff changeset	63 CXSPARSE_NAME () csm;
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	64 csm.m = nr;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	65 csm.n = nc;
7520 b166043585a8 use 0 instead of NULL John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	66 csm.x = 0;
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	67 csm.nz = -1;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	68
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	69 if (arg.is_real_type ())
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	70 {
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	71 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	72 csm.nzmax = m.nnz ();
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	73 csm.p = m.xcidx ();
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	74 csm.i = m.xridx ();
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	75 }
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	76 else
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	77 {
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	78 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	79 csm.nzmax = cm.nnz ();
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	80 csm.p = cm.xcidx ();
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	81 csm.i = cm.xridx ();
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	82 }
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	83
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	84 if (nargout <= 1 \|\| rank)
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	85 {
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	86 octave_idx_type *jmatch = CXSPARSE_NAME (_maxtrans) (&csm, 0);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	87 if (rank)
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	88 {
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	89 octave_idx_type r = 0;
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	90 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	91 if (jmatch[nr+i] >= 0)
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	92 r++;
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	93 retval(0) = static_cast<double>(r);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	94 }
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	95 else
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	96 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	97 CXSPARSE_NAME (_free) (jmatch);
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	98 }
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	99 else
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	100 {
f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	101 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	102
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	103 //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	104 //retval(4) = put_int (dm->cc, 5);
20860 61892a245653 2015 Code Sprint: dmperm.cc: use ovl(). Rik <rik@octave.org> parents: 20853 diff changeset	105 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	106 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	107
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	108 CXSPARSE_NAME (_dfree) (dm);
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	109 }
20555 f90c8372b7ba eliminate many more simple uses of error_state John W. Eaton <jwe@octave.org> parents: 20163 diff changeset	110
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	111 return retval;
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	112 }
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	113 #endif
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	114
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	115 DEFUN_DLD (dmperm, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	116 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20818 diff changeset	117 @deftypefn {} {@var{p} =} dmperm (@var{S})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20818 diff changeset	118 @deftypefnx {} {[@var{p}, @var{q}, @var{r}, @var{S}] =} dmperm (@var{S})\n\
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	119 \n\
19040 0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17787 diff changeset	120 @cindex @nospell{Dulmage-Mendelsohn} decomposition\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17787 diff changeset	121 Perform a @nospell{Dulmage-Mendelsohn} permutation of the sparse matrix\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17787 diff changeset	122 @var{S}.\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17787 diff changeset	123 \n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	124 With a single output argument @code{dmperm} performs the row permutations\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	125 @var{p} such that @code{@var{S}(@var{p},:)} has no zero elements on the\n\
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	126 diagonal.\n\
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	127 \n\
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	128 Called with two or more output arguments, returns the row and column\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	129 permutations, such that @code{@var{S}(@var{p}, @var{q})} is in block\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	130 triangular form. The values of @var{r} and @var{S} define the boundaries\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	131 of the blocks. If @var{S} is square then @code{@var{r} == @var{S}}.\n\
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	132 \n\
19040 0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17787 diff changeset	133 The method used is described in: @nospell{A. Pothen & C.-J. Fan.}\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17787 diff changeset	134 @cite{Computing the Block Triangular Form of a Sparse Matrix}.\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17787 diff changeset	135 ACM Trans. Math. Software, 16(4):303-324, 1990.\n\
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	136 @seealso{colamd, ccolamd}\n\
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	137 @end deftypefn")
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	138 {
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	139 #if defined (HAVE_CXSPARSE)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	140
20818 cef0448a6ed2 eliminate unnecessary uses of nargin John W. Eaton <jwe@octave.org> parents: 20812 diff changeset	141 if (args.length () != 1)
20790 c2d9556d51d0 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	142 print_usage ();
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	143
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20860 diff changeset	144 return ovl (dmperm_internal (false, args(0), nargout));
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20860 diff changeset	145
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	146 #else
21109 bd1752782e56 Use err_disabled_feature, warn_disabled_feature throughout code base. Rik <rik@octave.org> parents: 21100 diff changeset	147 err_disabled_feature ("dmperm", "CXSparse");
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	148 #endif
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	149 }
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	150
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	151 /*
7243 e8d7eed42935 [project @ 2007-12-04 02:10:17 by jwe] jwe parents: 7017 diff changeset	152 %!testif HAVE_CXSPARSE
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	153 %! n = 20;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	154 %! a = speye (n,n);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	155 %! a = a(randperm (n),:);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	156 %! assert (a(dmperm (a),:), speye (n));
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	157
7243 e8d7eed42935 [project @ 2007-12-04 02:10:17 by jwe] jwe parents: 7017 diff changeset	158 %!testif HAVE_CXSPARSE
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	159 %! n = 20;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	160 %! d = 0.2;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	161 %! 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	162 %! 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	163 %! [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	164 %! assert (tril (a(p,q), -1), sparse (n, n));
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	165 */
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	166
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	167 DEFUN_DLD (sprank, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	168 "-- texinfo --\n\
20853 1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files. Rik <rik@octave.org> parents: 20818 diff changeset	169 @deftypefn {} {@var{p} =} sprank (@var{S})\n\
12578 f5a780d675a1 Clean up operator and function indices in documentation. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	170 @cindex structural rank\n\
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	171 \n\
20163 075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	172 Calculate the structural rank of the sparse matrix @var{S}.\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	173 \n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	174 Note that only the structure of the matrix is used in this calculation based\n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	175 on a @nospell{Dulmage-Mendelsohn} permutation to block triangular form. As\n\
19040 0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17787 diff changeset	176 such the numerical rank of the matrix @var{S} is bounded by\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	177 @code{sprank (@var{S}) >= rank (@var{S})}. Ignoring floating point errors\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	178 @code{sprank (@var{S}) == rank (@var{S})}.\n\
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	179 @seealso{dmperm}\n\
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	180 @end deftypefn")
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	181 {
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	182 #if defined (HAVE_CXSPARSE)
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	183
20818 cef0448a6ed2 eliminate unnecessary uses of nargin John W. Eaton <jwe@octave.org> parents: 20812 diff changeset	184 if (args.length () != 1)
20790 c2d9556d51d0 eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20555 diff changeset	185 print_usage ();
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	186
20939 b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20860 diff changeset	187 return ovl (dmperm_internal (true, args(0), nargout));
b17fda023ca6 maint: Use new C++ archetype in more files. Rik <rik@octave.org> parents: 20860 diff changeset	188
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	189 #else
21109 bd1752782e56 Use err_disabled_feature, warn_disabled_feature throughout code base. Rik <rik@octave.org> parents: 21100 diff changeset	190 err_disabled_feature ("sprank", "CXSparse");
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	191 #endif
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	192 }
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	193
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	194 /*
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	195 %!testif HAVE_CXSPARSE
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	196 %! assert (sprank (speye (20)), 20)
7243 e8d7eed42935 [project @ 2007-12-04 02:10:17 by jwe] jwe parents: 7017 diff changeset	197 %!testif HAVE_CXSPARSE
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	198 %! 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	199
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	200 %!error sprank (1,2)
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	201 */

Mercurial > octave

annotate libinterp/dldfcn/dmperm.cc @ 21211:2cf8bc5c7017