Mercurial > octave
diff libinterp/corefcn/balance.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 | 6ca3acf5fad8 |
line wrap: on
line diff
--- a/libinterp/corefcn/balance.cc Tue Jun 21 13:08:25 2016 -0700 +++ b/libinterp/corefcn/balance.cc Tue Jun 21 16:07:51 2016 -0400 @@ -45,49 +45,49 @@ #include "utils.h" DEFUN (balance, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {@var{AA} =} balance (@var{A})\n\ -@deftypefnx {} {@var{AA} =} balance (@var{A}, @var{opt})\n\ -@deftypefnx {} {[@var{DD}, @var{AA}] =} balance (@var{A}, @var{opt})\n\ -@deftypefnx {} {[@var{D}, @var{P}, @var{AA}] =} balance (@var{A}, @var{opt})\n\ -@deftypefnx {} {[@var{CC}, @var{DD}, @var{AA}, @var{BB}] =} balance (@var{A}, @var{B}, @var{opt})\n\ -\n\ -Balance the matrix @var{A} to reduce numerical errors in future\n\ -calculations.\n\ -\n\ -Compute @code{@var{AA} = @var{DD} \\ @var{A} * @var{DD}} in which @var{AA}\n\ -is a matrix whose row and column norms are roughly equal in magnitude, and\n\ -@code{@var{DD} = @var{P} * @var{D}}, in which @var{P} is a permutation\n\ -matrix and @var{D} is a diagonal matrix of powers of two. This allows the\n\ -equilibration to be computed without round-off. Results of eigenvalue\n\ -calculation are typically improved by balancing first.\n\ -\n\ -If two output values are requested, @code{balance} returns\n\ -the diagonal @var{D} and the permutation @var{P} separately as vectors.\n\ -In this case, @code{@var{DD} = eye(n)(:,@var{P}) * diag (@var{D})}, where\n\ -@math{n} is the matrix size.\n\ -\n\ -If four output values are requested, compute @code{@var{AA} =\n\ -@var{CC}*@var{A}*@var{DD}} and @code{@var{BB} = @var{CC}*@var{B}*@var{DD}},\n\ -in which @var{AA} and @var{BB} have nonzero elements of approximately the\n\ -same magnitude and @var{CC} and @var{DD} are permuted diagonal matrices as\n\ -in @var{DD} for the algebraic eigenvalue problem.\n\ -\n\ -The eigenvalue balancing option @var{opt} may be one of:\n\ -\n\ -@table @asis\n\ -@item @qcode{\"noperm\"}, @qcode{\"S\"}\n\ -Scale only; do not permute.\n\ -\n\ -@item @qcode{\"noscal\"}, @qcode{\"P\"}\n\ -Permute only; do not scale.\n\ -@end table\n\ -\n\ -Algebraic eigenvalue balancing uses standard @sc{lapack} routines.\n\ -\n\ -Generalized eigenvalue problem balancing uses Ward's algorithm\n\ -(SIAM Journal on Scientific and Statistical Computing, 1981).\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {@var{AA} =} balance (@var{A}) +@deftypefnx {} {@var{AA} =} balance (@var{A}, @var{opt}) +@deftypefnx {} {[@var{DD}, @var{AA}] =} balance (@var{A}, @var{opt}) +@deftypefnx {} {[@var{D}, @var{P}, @var{AA}] =} balance (@var{A}, @var{opt}) +@deftypefnx {} {[@var{CC}, @var{DD}, @var{AA}, @var{BB}] =} balance (@var{A}, @var{B}, @var{opt}) + +Balance the matrix @var{A} to reduce numerical errors in future +calculations. + +Compute @code{@var{AA} = @var{DD} \ @var{A} * @var{DD}} in which @var{AA} +is a matrix whose row and column norms are roughly equal in magnitude, and +@code{@var{DD} = @var{P} * @var{D}}, in which @var{P} is a permutation +matrix and @var{D} is a diagonal matrix of powers of two. This allows the +equilibration to be computed without round-off. Results of eigenvalue +calculation are typically improved by balancing first. + +If two output values are requested, @code{balance} returns +the diagonal @var{D} and the permutation @var{P} separately as vectors. +In this case, @code{@var{DD} = eye(n)(:,@var{P}) * diag (@var{D})}, where +@math{n} is the matrix size. + +If four output values are requested, compute @code{@var{AA} = +@var{CC}*@var{A}*@var{DD}} and @code{@var{BB} = @var{CC}*@var{B}*@var{DD}}, +in which @var{AA} and @var{BB} have nonzero elements of approximately the +same magnitude and @var{CC} and @var{DD} are permuted diagonal matrices as +in @var{DD} for the algebraic eigenvalue problem. + +The eigenvalue balancing option @var{opt} may be one of: + +@table @asis +@item @qcode{"noperm"}, @qcode{"S"} +Scale only; do not permute. + +@item @qcode{"noscal"}, @qcode{"P"} +Permute only; do not scale. +@end table + +Algebraic eigenvalue balancing uses standard @sc{lapack} routines. + +Generalized eigenvalue problem balancing uses Ward's algorithm +(SIAM Journal on Scientific and Statistical Computing, 1981). +@end deftypefn */) { int nargin = args.length ();