Mercurial > octave
diff libinterp/dldfcn/dmperm.cc @ 21966:112b20240c87
move docstrings in C++ files out of C strings and into comments
* __contourc__.cc, __dispatch__.cc, __dsearchn__.cc, __ichol__.cc,
__ilu__.cc, __lin_interpn__.cc, __luinc__.cc, __magick_read__.cc,
__pchip_deriv__.cc, __qp__.cc, balance.cc, besselj.cc, betainc.cc,
bitfcns.cc, bsxfun.cc, cellfun.cc, colloc.cc, conv2.cc, daspk.cc,
dasrt.cc, dassl.cc, data.cc, debug.cc, defaults.cc, det.cc, dirfns.cc,
dlmread.cc, dot.cc, eig.cc, ellipj.cc, error.cc, fft.cc, fft2.cc,
fftn.cc, file-io.cc, filter.cc, find.cc, gammainc.cc, gcd.cc,
getgrent.cc, getpwent.cc, getrusage.cc, givens.cc, graphics.cc,
hash.cc, help.cc, hess.cc, hex2num.cc, input.cc, inv.cc, kron.cc,
load-path.cc, load-save.cc, lookup.cc, ls-oct-text.cc, lsode.cc,
lu.cc, mappers.cc, matrix_type.cc, max.cc, mgorth.cc, nproc.cc,
oct-hist.cc, octave-link.cc, ordschur.cc, pager.cc, pinv.cc,
pr-output.cc, profiler.cc, psi.cc, pt-jit.cc, quad.cc, quadcc.cc,
qz.cc, rand.cc, rcond.cc, regexp.cc, schur.cc, sighandlers.cc,
sparse.cc, spparms.cc, sqrtm.cc, str2double.cc, strfind.cc, strfns.cc,
sub2ind.cc, svd.cc, sylvester.cc, symtab.cc, syscalls.cc, sysdep.cc,
time.cc, toplev.cc, tril.cc, tsearch.cc, typecast.cc, urlwrite.cc,
utils.cc, variables.cc, __delaunayn__.cc, __eigs__.cc,
__fltk_uigetfile__.cc, __glpk__.cc, __init_fltk__.cc,
__init_gnuplot__.cc, __osmesa_print__.cc, __voronoi__.cc, amd.cc,
audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc,
convhulln.cc, dmperm.cc, fftw.cc, qr.cc, symbfact.cc, symrcm.cc,
ov-base.cc, ov-bool-mat.cc, ov-cell.cc, ov-class.cc, ov-classdef.cc,
ov-fcn-handle.cc, ov-fcn-inline.cc, ov-flt-re-mat.cc, ov-int16.cc,
ov-int32.cc, ov-int64.cc, ov-int8.cc, ov-java.cc, ov-null-mat.cc,
ov-oncleanup.cc, ov-range.cc, ov-re-mat.cc, ov-struct.cc,
ov-typeinfo.cc, ov-uint16.cc, ov-uint32.cc, ov-uint64.cc, ov-uint8.cc,
ov-usr-fcn.cc, ov.cc, octave.cc, pt-arg-list.cc, pt-binop.cc,
pt-eval.cc, pt-mat.cc, lex.ll, oct-parse.in.yy:
Docstrings are now comments instead of C strings.
* build-aux/mk-opts.pl: Emit docstrings as comments instead of C
strings.
* DASPK-opts.in, LSODE-opts.in: Don't quote " in docstring fragments.
* builtins.h: Include builtin-defun-decls.h unconditionally.
* defun.h (DEFUN, DEFUNX, DEFCONSTFUN): Simply emit declaration.
(DEFALIAS): Always expand to nothing.
* defun-dld.h: No special macro expansions for MAKE_BUILTINS.
(DEFUN_DLD): Use FORWARD_DECLARE_FUN.
(DEFUNX_DLD): Use FORWARD_DECLARE_FUNX.
* defun-int.h: No special macro expansions for MAKE_BUILTINS.
(FORWARD_DECLARE_FUN, FORWARD_DECLARE_FUNX): New macros.
(DEFINE_FUN_INSTALLER_FUN): If compiling an Octave source file, pass
"external-doc" to DEFINE_FUNX_INSTALLER_FUN.
(DEFUN_INTERNAL, DEFCONSTFUN_INTERNAL, DEFUNX_INTERNAL,
DEFALIAS_INTERNAL): Delete.
* common.mk (move_if_change_rule): New macro.
(simple_move_if_change_rule): Define using move_if_change_rule.
* find-defun-files.sh (DEFUN_PATTERN): Update. Don't transform file
name extension to ".df".
* libinterp/mk-pkg-add, gendoc.pl: Operate directly on source files.
* mkbuiltins: New argument, SRCDIR. Operate directly on source files.
* mkdefs: Delete.
* libinterp/module.mk (BUILT_SOURCES): Update list to contain only
files included in other source files.
(GENERATED_MAKE_BUILTINS_INCS, DEF_FILES): Delete.
(LIBINTERP_BUILT_DISTFILES): Include $(OPT_HANDLERS) here.
(LIBINTERP_BUILT_NODISTFILES): Not here. Remove $(ALL_DEF_FILES from
the list.
(libinterp_EXTRA_DIST): Remove mkdefs from the list.
(FOUND_DEFUN_FILES): Rename from SRC_DEF_FILES.
(DLDFCN_DEFUN_FILES): Rename from DLDFCN_DEF_FILES.
(SRC_DEFUN_FILES): Rename from SRC_DEF_FILES.
(ALL_DEFUN_FILES): Rename from ALL_DEF_FILES.
(%.df: %.cc): Delete pattern rule.
(libinterp/build-env-features.cc, libinterp/builtins.cc,
libinterp/dldfcn/PKG_ADD): Use mv instead of move-if-change.
(libinterp/builtins.cc, libinterp/builtin-defun-decls.h):
Update mkbuiltins command.
($(srcdir)/libinterp/DOCSTRINGS): Update gendoc.pl command.
* liboctave/module.mk (BUILT_SOURCES): Don't include
liboctave-build-info.cc in the list.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Tue, 21 Jun 2016 16:07:51 -0400 |
parents | aba2e6293dd8 |
children | b602ce0b5acf |
line wrap: on
line diff
--- a/libinterp/dldfcn/dmperm.cc Tue Jun 21 13:08:25 2016 -0700 +++ b/libinterp/dldfcn/dmperm.cc Tue Jun 21 16:07:51 2016 -0400 @@ -115,28 +115,28 @@ #endif DEFUN_DLD (dmperm, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {@var{p} =} dmperm (@var{S})\n\ -@deftypefnx {} {[@var{p}, @var{q}, @var{r}, @var{S}] =} dmperm (@var{S})\n\ -\n\ -@cindex @nospell{Dulmage-Mendelsohn} decomposition\n\ -Perform a @nospell{Dulmage-Mendelsohn} permutation of the sparse matrix\n\ -@var{S}.\n\ -\n\ -With a single output argument @code{dmperm} performs the row permutations\n\ -@var{p} such that @code{@var{S}(@var{p},:)} has no zero elements on the\n\ -diagonal.\n\ -\n\ -Called with two or more output arguments, returns the row and column\n\ -permutations, such that @code{@var{S}(@var{p}, @var{q})} is in block\n\ -triangular form. The values of @var{r} and @var{S} define the boundaries\n\ -of the blocks. If @var{S} is square then @code{@var{r} == @var{S}}.\n\ -\n\ -The method used is described in: @nospell{A. Pothen & C.-J. Fan.}\n\ -@cite{Computing the Block Triangular Form of a Sparse Matrix}.\n\ -ACM Trans. Math. Software, 16(4):303-324, 1990.\n\ -@seealso{colamd, ccolamd}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {@var{p} =} dmperm (@var{S}) +@deftypefnx {} {[@var{p}, @var{q}, @var{r}, @var{S}] =} dmperm (@var{S}) + +@cindex @nospell{Dulmage-Mendelsohn} decomposition +Perform a @nospell{Dulmage-Mendelsohn} permutation of the sparse matrix +@var{S}. + +With a single output argument @code{dmperm} performs the row permutations +@var{p} such that @code{@var{S}(@var{p},:)} has no zero elements on the +diagonal. + +Called with two or more output arguments, returns the row and column +permutations, such that @code{@var{S}(@var{p}, @var{q})} is in block +triangular form. The values of @var{r} and @var{S} define the boundaries +of the blocks. If @var{S} is square then @code{@var{r} == @var{S}}. + +The method used is described in: @nospell{A. Pothen & C.-J. Fan.} +@cite{Computing the Block Triangular Form of a Sparse Matrix}. +ACM Trans. Math. Software, 16(4):303-324, 1990. +@seealso{colamd, ccolamd} +@end deftypefn */) { #if defined (HAVE_CXSPARSE) @@ -172,19 +172,19 @@ */ DEFUN_DLD (sprank, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {@var{p} =} sprank (@var{S})\n\ -@cindex structural rank\n\ -\n\ -Calculate the structural rank of the sparse matrix @var{S}.\n\ -\n\ -Note that only the structure of the matrix is used in this calculation based\n\ -on a @nospell{Dulmage-Mendelsohn} permutation to block triangular form. As\n\ -such the numerical rank of the matrix @var{S} is bounded by\n\ -@code{sprank (@var{S}) >= rank (@var{S})}. Ignoring floating point errors\n\ -@code{sprank (@var{S}) == rank (@var{S})}.\n\ -@seealso{dmperm}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {@var{p} =} sprank (@var{S}) +@cindex structural rank + +Calculate the structural rank of the sparse matrix @var{S}. + +Note that only the structure of the matrix is used in this calculation based +on a @nospell{Dulmage-Mendelsohn} permutation to block triangular form. As +such the numerical rank of the matrix @var{S} is bounded by +@code{sprank (@var{S}) >= rank (@var{S})}. Ignoring floating point errors +@code{sprank (@var{S}) == rank (@var{S})}. +@seealso{dmperm} +@end deftypefn */) { #if defined (HAVE_CXSPARSE)