octave-antonio: libinterp/dldfcn/dmperm.cc annotate

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

doc: Update more docstrings to have one sentence summary as first line. Reviewed build-aux, libinterp/dldfcn, libinterp/octave-value, libinterp/parse-tree directories. * build-aux/mk-opts.pl, libinterp/dldfcn/__magick_read__.cc, libinterp/dldfcn/amd.cc, libinterp/dldfcn/audiodevinfo.cc, libinterp/dldfcn/audioread.cc, libinterp/dldfcn/ccolamd.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/convhulln.cc, libinterp/dldfcn/dmperm.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/dldfcn/symrcm.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-bool-mat.cc, libinterp/octave-value/ov-cell.cc, libinterp/octave-value/ov-class.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-null-mat.cc, libinterp/octave-value/ov-oncleanup.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-typeinfo.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/octave-value/ov.cc, libinterp/parse-tree/lex.ll, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc: doc: Update more docstrings to have one sentence summary as first line.

author	Rik <rik@octave.org>
date	Sun, 03 May 2015 21:52:42 -0700
parents	4197fc428c7d
children

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
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	25 #include <config.h>
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"
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	30 #include "gripes.h"
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	31 #include "oct-obj.h"
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"
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	37 #include "SparseQR.h"
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	38 #include "SparseCmplxQR.h"
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	39
16313 6aafe87a3144 use int64_t for idx type if --enable-64 John W. Eaton <jwe@octave.org> parents: 15195 diff changeset	40 #ifdef USE_64_BIT_IDX_T
5648 69a4f320d95a [project @ 2006-03-08 20:17:37 by dbateman] dbateman parents: 5642 diff changeset	41 #define CXSPARSE_NAME(name) cs_dl ## name
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	42 #else
5648 69a4f320d95a [project @ 2006-03-08 20:17:37 by dbateman] dbateman parents: 5642 diff changeset	43 #define CXSPARSE_NAME(name) cs_di ## name
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	44 #endif
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	45
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	46 static RowVector
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	47 put_int (octave_idx_type *p, octave_idx_type n)
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	48 {
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	49 RowVector ret (n);
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	50 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	51 ret.xelem (i) = p[i] + 1;
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	52 return ret;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	53 }
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	54
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	55 #if HAVE_CXSPARSE
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;
7520 b166043585a8 use 0 instead of NULL John W. Eaton <jwe@octave.org> parents: 7505 diff changeset	67 csm.x = 0;
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
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	70 if (arg.is_real_type ())
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 ();
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	74 csm.p = m.xcidx ();
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	75 csm.i = m.xridx ();
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 ();
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	81 csm.p = cm.xcidx ();
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	82 csm.i = cm.xridx ();
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
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	85 if (!error_state)
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	86 {
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	87 if (nargout <= 1 \|\| rank)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	88 {
5792 eb90c83b4f91 [project @ 2006-05-04 20:14:49 by dbateman] dbateman parents: 5681 diff changeset	89 #if defined(CS_VER) && (CS_VER >= 2)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	90 octave_idx_type *jmatch = CXSPARSE_NAME (_maxtrans) (&csm, 0);
5792 eb90c83b4f91 [project @ 2006-05-04 20:14:49 by dbateman] dbateman parents: 5681 diff changeset	91 #else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	92 octave_idx_type *jmatch = CXSPARSE_NAME (_maxtrans) (&csm);
5792 eb90c83b4f91 [project @ 2006-05-04 20:14:49 by dbateman] dbateman parents: 5681 diff changeset	93 #endif
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	94 if (rank)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	95 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	96 octave_idx_type r = 0;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	97 for (octave_idx_type i = 0; i < nc; i++)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	98 if (jmatch[nr+i] >= 0)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	99 r++;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	100 retval(0) = static_cast<double>(r);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	101 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	102 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	103 retval(0) = put_int (jmatch + nr, nc);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	104 CXSPARSE_NAME (_free) (jmatch);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	105 }
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	106 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	107 {
5792 eb90c83b4f91 [project @ 2006-05-04 20:14:49 by dbateman] dbateman parents: 5681 diff changeset	108 #if defined(CS_VER) && (CS_VER >= 2)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	109 CXSPARSE_NAME (d) *dm = CXSPARSE_NAME(_dmperm) (&csm, 0);
5792 eb90c83b4f91 [project @ 2006-05-04 20:14:49 by dbateman] dbateman parents: 5681 diff changeset	110 #else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	111 CXSPARSE_NAME (d) *dm = CXSPARSE_NAME(_dmperm) (&csm);
5792 eb90c83b4f91 [project @ 2006-05-04 20:14:49 by dbateman] dbateman parents: 5681 diff changeset	112 #endif
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	113
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	114 //retval(5) = put_int (dm->rr, 5);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	115 //retval(4) = put_int (dm->cc, 5);
5792 eb90c83b4f91 [project @ 2006-05-04 20:14:49 by dbateman] dbateman parents: 5681 diff changeset	116 #if defined(CS_VER) && (CS_VER >= 2)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	117 retval(3) = put_int (dm->s, dm->nb+1);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	118 retval(2) = put_int (dm->r, dm->nb+1);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	119 retval(1) = put_int (dm->q, nc);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	120 retval(0) = put_int (dm->p, nr);
5792 eb90c83b4f91 [project @ 2006-05-04 20:14:49 by dbateman] dbateman parents: 5681 diff changeset	121 #else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	122 retval(3) = put_int (dm->S, dm->nb+1);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	123 retval(2) = put_int (dm->R, dm->nb+1);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	124 retval(1) = put_int (dm->Q, nc);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	125 retval(0) = put_int (dm->P, nr);
5792 eb90c83b4f91 [project @ 2006-05-04 20:14:49 by dbateman] dbateman parents: 5681 diff changeset	126 #endif
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	127 CXSPARSE_NAME (_dfree) (dm);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	128 }
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	129 }
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	130 return retval;
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	131 }
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	132 #endif
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	133
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	134 DEFUN_DLD (dmperm, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	135 "-- texinfo --\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	136 @deftypefn {Loadable Function} {@var{p} =} dmperm (@var{S})\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	137 @deftypefnx {Loadable Function} {[@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	138 \n\
19040 0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17787 diff changeset	139 @cindex @nospell{Dulmage-Mendelsohn} decomposition\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17787 diff changeset	140 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	141 @var{S}.\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17787 diff changeset	142 \n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	143 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	144 @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	145 diagonal.\n\
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	146 \n\
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	147 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	148 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	149 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	150 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	151 \n\
19040 0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17787 diff changeset	152 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	153 @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	154 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	155 @seealso{colamd, ccolamd}\n\
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	156 @end deftypefn")
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	157 {
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	158 int nargin = args.length ();
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	159 octave_value_list retval;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	160
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	161 if (nargin != 1)
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	162 {
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	163 print_usage ();
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	164 return retval;
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	165 }
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	166
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	167 #if HAVE_CXSPARSE
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	168 retval = dmperm_internal (false, args(0), nargout);
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	169 #else
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	170 error ("dmperm: not available in this version of Octave");
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	171 #endif
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 return retval;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	174 }
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	175
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	176 /*
7243 e8d7eed42935 [project @ 2007-12-04 02:10:17 by jwe] jwe parents: 7017 diff changeset	177 %!testif HAVE_CXSPARSE
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	178 %! n = 20;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	179 %! a = speye (n,n);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	180 %! a = a(randperm (n),:);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	181 %! assert (a(dmperm (a),:), speye (n));
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	182
7243 e8d7eed42935 [project @ 2007-12-04 02:10:17 by jwe] jwe parents: 7017 diff changeset	183 %!testif HAVE_CXSPARSE
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	184 %! n = 20;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	185 %! d = 0.2;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	186 %! 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	187 %! 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	188 %! [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	189 %! assert (tril (a(p,q), -1), sparse (n, n));
5610 9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	190 */
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman] dbateman parents: diff changeset	191
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	192 DEFUN_DLD (sprank, args, nargout,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	193 "-- texinfo --\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	194 @deftypefn {Loadable Function} {@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	195 @cindex structural rank\n\
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	196 \n\
20163 075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	197 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	198 \n\
075a5e2e1ba5 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	199 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	200 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	201 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	202 @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	203 @code{sprank (@var{S}) == rank (@var{S})}.\n\
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	204 @seealso{dmperm}\n\
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	205 @end deftypefn")
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	206 {
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	207 int nargin = args.length ();
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	208 octave_value_list retval;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	209
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	210 if (nargin != 1)
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	211 {
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	212 print_usage ();
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	213 return retval;
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	214 }
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	215
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	216 #if HAVE_CXSPARSE
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	217 retval = dmperm_internal (true, args(0), nargout);
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	218 #else
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	219 error ("sprank: not available in this version of Octave");
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	220 #endif
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	221
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	222 return retval;
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	223 }
27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	224
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	225 /*
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	226 %!testif HAVE_CXSPARSE
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	227 %! assert (sprank (speye (20)), 20)
7243 e8d7eed42935 [project @ 2007-12-04 02:10:17 by jwe] jwe parents: 7017 diff changeset	228 %!testif HAVE_CXSPARSE
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	229 %! 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	230
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	231 %!error sprank (1,2)
6066 27fa671e5599 [project @ 2006-10-20 08:33:19 by dbateman] dbateman parents: 5823 diff changeset	232 */

Mercurial > octave-antonio

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