Mercurial > octave
diff libinterp/dldfcn/symbfact.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 | 55f7de37b618 |
children | bac0d6f07a3e |
line wrap: on
line diff
--- a/libinterp/dldfcn/symbfact.cc Tue Jun 21 13:08:25 2016 -0700 +++ b/libinterp/dldfcn/symbfact.cc Tue Jun 21 16:07:51 2016 -0400 @@ -40,67 +40,67 @@ #include "utils.h" DEFUN_DLD (symbfact, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {[@var{count}, @var{h}, @var{parent}, @var{post}, @var{R}] =} symbfact (@var{S})\n\ -@deftypefnx {} {[@dots{}] =} symbfact (@var{S}, @var{typ})\n\ -@deftypefnx {} {[@dots{}] =} symbfact (@var{S}, @var{typ}, @var{mode})\n\ -\n\ -Perform a symbolic factorization analysis of the sparse matrix @var{S}.\n\ -\n\ -The input variables are\n\ -\n\ -@table @var\n\ -@item S\n\ -@var{S} is a real or complex sparse matrix.\n\ -\n\ -@item typ\n\ -Is the type of the factorization and can be one of\n\ -\n\ -@table @asis\n\ -@item @qcode{\"sym\"} (default)\n\ -Factorize @var{S}. Assumes @var{S} is symmetric and uses the upper\n\ -triangular portion of the matrix.\n\ -\n\ -@item @qcode{\"col\"}\n\ -Factorize @tcode{@var{S}' * @var{S}}.\n\ -\n\ -@item @qcode{\"row\"}\n\ -Factorize @tcode{@var{S} * @var{S}'}.\n\ -\n\ -@item @qcode{\"lo\"}\n\ -Factorize @tcode{@var{S}'}. Assumes @var{S} is symmetric and uses the lower\n\ -triangular portion of the matrix.\n\ -@end table\n\ -\n\ -@item mode\n\ -When @var{mode} is unspecified return the Cholesky@tie{}factorization for\n\ -@var{R}. If @var{mode} is @qcode{\"lower\"} or @qcode{\"L\"} then return\n\ -the conjugate transpose @tcode{@var{R}'} which is a lower triangular factor.\n\ -The conjugate transpose version is faster and uses less memory, but still\n\ -returns the same values for all other outputs: @var{count}, @var{h},\n\ -@var{parent}, and @var{post}.\n\ -@end table\n\ -\n\ -The output variables are:\n\ -\n\ -@table @var\n\ -@item count\n\ -The row counts of the Cholesky@tie{}factorization as determined by\n\ -@var{typ}. The computational difficulty of performing the true\n\ -factorization using @code{chol} is @code{sum (@var{count} .^ 2)}.\n\ -\n\ -@item h\n\ -The height of the elimination tree.\n\ -\n\ -@item parent\n\ -The elimination tree itself.\n\ -\n\ -@item post\n\ -A sparse boolean matrix whose structure is that of the\n\ -Cholesky@tie{}factorization as determined by @var{typ}.\n\ -@end table\n\ -@seealso{chol, etree, treelayout}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {[@var{count}, @var{h}, @var{parent}, @var{post}, @var{R}] =} symbfact (@var{S}) +@deftypefnx {} {[@dots{}] =} symbfact (@var{S}, @var{typ}) +@deftypefnx {} {[@dots{}] =} symbfact (@var{S}, @var{typ}, @var{mode}) + +Perform a symbolic factorization analysis of the sparse matrix @var{S}. + +The input variables are + +@table @var +@item S +@var{S} is a real or complex sparse matrix. + +@item typ +Is the type of the factorization and can be one of + +@table @asis +@item @qcode{"sym"} (default) +Factorize @var{S}. Assumes @var{S} is symmetric and uses the upper +triangular portion of the matrix. + +@item @qcode{"col"} +Factorize @tcode{@var{S}' * @var{S}}. + +@item @qcode{"row"} +Factorize @tcode{@var{S} * @var{S}'}. + +@item @qcode{"lo"} +Factorize @tcode{@var{S}'}. Assumes @var{S} is symmetric and uses the lower +triangular portion of the matrix. +@end table + +@item mode +When @var{mode} is unspecified return the Cholesky@tie{}factorization for +@var{R}. If @var{mode} is @qcode{"lower"} or @qcode{"L"} then return +the conjugate transpose @tcode{@var{R}'} which is a lower triangular factor. +The conjugate transpose version is faster and uses less memory, but still +returns the same values for all other outputs: @var{count}, @var{h}, +@var{parent}, and @var{post}. +@end table + +The output variables are: + +@table @var +@item count +The row counts of the Cholesky@tie{}factorization as determined by +@var{typ}. The computational difficulty of performing the true +factorization using @code{chol} is @code{sum (@var{count} .^ 2)}. + +@item h +The height of the elimination tree. + +@item parent +The elimination tree itself. + +@item post +A sparse boolean matrix whose structure is that of the +Cholesky@tie{}factorization as determined by @var{typ}. +@end table +@seealso{chol, etree, treelayout} +@end deftypefn */) { #if defined (HAVE_CHOLMOD)