Mercurial > octave
diff libinterp/corefcn/qz.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 | b571fc85953f |
children | 278fc29b69ca |
line wrap: on
line diff
--- a/libinterp/corefcn/qz.cc Tue Jun 21 13:08:25 2016 -0700 +++ b/libinterp/corefcn/qz.cc Tue Jun 21 16:07:51 2016 -0400 @@ -290,87 +290,87 @@ //FIXME: Matlab does not produce lambda as the first output argument. // Compatibility problem? DEFUN (qz, args, nargout, - "-*- texinfo -*-\n\ -@deftypefn {} {@var{lambda} =} qz (@var{A}, @var{B})\n\ -@deftypefnx {} {@var{lambda} =} qz (@var{A}, @var{B}, @var{opt})\n\ -QZ@tie{}decomposition of the generalized eigenvalue problem\n\ -(@math{A x = s B x}).\n\ -\n\ -There are three ways to call this function:\n\ -@enumerate\n\ -@item @code{@var{lambda} = qz (@var{A}, @var{B})}\n\ -\n\ -Computes the generalized eigenvalues\n\ -@tex\n\ -$\\lambda$\n\ -@end tex\n\ -@ifnottex\n\ -@var{lambda}\n\ -@end ifnottex\n\ -of @math{(A - s B)}.\n\ -\n\ -@item @code{[AA, BB, Q, Z, V, W, @var{lambda}] = qz (@var{A}, @var{B})}\n\ -\n\ -Computes QZ@tie{}decomposition, generalized eigenvectors, and generalized\n\ -eigenvalues of @math{(A - s B)}\n\ -@tex\n\ -$$ AV = BV{ \\rm diag }(\\lambda) $$\n\ -$$ W^T A = { \\rm diag }(\\lambda)W^T B $$\n\ -$$ AA = Q^T AZ, BB = Q^T BZ $$\n\ -@end tex\n\ -@ifnottex\n\ -\n\ -@example\n\ -@group\n\ -\n\ -A * V = B * V * diag (@var{lambda})\n\ -W' * A = diag (@var{lambda}) * W' * B\n\ -AA = Q * A * Z, BB = Q * B * Z\n\ -\n\ -@end group\n\ -@end example\n\ -\n\ -@end ifnottex\n\ -with @var{Q} and @var{Z} orthogonal (unitary)= @var{I}\n\ -\n\ -@item @code{[AA,BB,Z@{, @var{lambda}@}] = qz (@var{A}, @var{B}, @var{opt})}\n\ -\n\ -As in form [2], but allows ordering of generalized eigenpairs for, e.g.,\n\ -solution of discrete time algebraic Riccati equations. Form 3 is not\n\ -available for complex matrices, and does not compute the generalized\n\ -eigenvectors @var{V}, @var{W}, nor the orthogonal matrix @var{Q}.\n\ -\n\ -@table @var\n\ -@item opt\n\ -for ordering eigenvalues of the @nospell{GEP} pencil. The leading block of\n\ -the revised pencil contains all eigenvalues that satisfy:\n\ -\n\ -@table @asis\n\ -@item @qcode{\"N\"}\n\ -= unordered (default)\n\ -\n\ -@item @qcode{\"S\"}\n\ -= small: leading block has all |lambda| @leq{} 1\n\ -\n\ -@item @qcode{\"B\"}\n\ -= big: leading block has all |lambda| @geq{} 1\n\ -\n\ -@item @qcode{\"-\"}\n\ -= negative real part: leading block has all eigenvalues\n\ -in the open left half-plane\n\ -\n\ -@item @qcode{\"+\"}\n\ -= non-negative real part: leading block has all eigenvalues\n\ -in the closed right half-plane\n\ -@end table\n\ -@end table\n\ -@end enumerate\n\ -\n\ -Note: @code{qz} performs permutation balancing, but not scaling\n\ -(@pxref{XREFbalance}). The order of output arguments was selected for\n\ -compatibility with @sc{matlab}.\n\ -@seealso{eig, balance, lu, chol, hess, qr, qzhess, schur, svd}\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {@var{lambda} =} qz (@var{A}, @var{B}) +@deftypefnx {} {@var{lambda} =} qz (@var{A}, @var{B}, @var{opt}) +QZ@tie{}decomposition of the generalized eigenvalue problem +(@math{A x = s B x}). + +There are three ways to call this function: +@enumerate +@item @code{@var{lambda} = qz (@var{A}, @var{B})} + +Computes the generalized eigenvalues +@tex +$\lambda$ +@end tex +@ifnottex +@var{lambda} +@end ifnottex +of @math{(A - s B)}. + +@item @code{[AA, BB, Q, Z, V, W, @var{lambda}] = qz (@var{A}, @var{B})} + +Computes QZ@tie{}decomposition, generalized eigenvectors, and generalized +eigenvalues of @math{(A - s B)} +@tex +$$ AV = BV{ \rm diag }(\lambda) $$ +$$ W^T A = { \rm diag }(\lambda)W^T B $$ +$$ AA = Q^T AZ, BB = Q^T BZ $$ +@end tex +@ifnottex + +@example +@group + +A * V = B * V * diag (@var{lambda}) +W' * A = diag (@var{lambda}) * W' * B +AA = Q * A * Z, BB = Q * B * Z + +@end group +@end example + +@end ifnottex +with @var{Q} and @var{Z} orthogonal (unitary)= @var{I} + +@item @code{[AA,BB,Z@{, @var{lambda}@}] = qz (@var{A}, @var{B}, @var{opt})} + +As in form [2], but allows ordering of generalized eigenpairs for, e.g., +solution of discrete time algebraic Riccati equations. Form 3 is not +available for complex matrices, and does not compute the generalized +eigenvectors @var{V}, @var{W}, nor the orthogonal matrix @var{Q}. + +@table @var +@item opt +for ordering eigenvalues of the @nospell{GEP} pencil. The leading block of +the revised pencil contains all eigenvalues that satisfy: + +@table @asis +@item @qcode{"N"} += unordered (default) + +@item @qcode{"S"} += small: leading block has all |lambda| @leq{} 1 + +@item @qcode{"B"} += big: leading block has all |lambda| @geq{} 1 + +@item @qcode{"-"} += negative real part: leading block has all eigenvalues +in the open left half-plane + +@item @qcode{"+"} += non-negative real part: leading block has all eigenvalues +in the closed right half-plane +@end table +@end table +@end enumerate + +Note: @code{qz} performs permutation balancing, but not scaling +(@pxref{XREFbalance}). The order of output arguments was selected for +compatibility with @sc{matlab}. +@seealso{eig, balance, lu, chol, hess, qr, qzhess, schur, svd} +@end deftypefn */) { int nargin = args.length ();