Mercurial > octave
diff libinterp/corefcn/matrix_type.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 | bac0d6f07a3e |
line wrap: on
line diff
--- a/libinterp/corefcn/matrix_type.cc Tue Jun 21 13:08:25 2016 -0700 +++ b/libinterp/corefcn/matrix_type.cc Tue Jun 21 16:07:51 2016 -0400 @@ -37,87 +37,87 @@ #include "oct-locbuf.h" DEFUN (matrix_type, args, , - "-*- texinfo -*-\n\ -@deftypefn {} {@var{type} =} matrix_type (@var{A})\n\ -@deftypefnx {} {@var{type} =} matrix_type (@var{A}, \"nocompute\")\n\ -@deftypefnx {} {@var{A} =} matrix_type (@var{A}, @var{type})\n\ -@deftypefnx {} {@var{A} =} matrix_type (@var{A}, \"upper\", @var{perm})\n\ -@deftypefnx {} {@var{A} =} matrix_type (@var{A}, \"lower\", @var{perm})\n\ -@deftypefnx {} {@var{A} =} matrix_type (@var{A}, \"banded\", @var{nl}, @var{nu})\n\ -Identify the matrix type or mark a matrix as a particular type.\n\ -\n\ -This allows more rapid solutions of linear equations involving @var{A} to be\n\ -performed.\n\ -\n\ -Called with a single argument, @code{matrix_type} returns the type of the\n\ -matrix and caches it for future use.\n\ -\n\ -Called with more than one argument, @code{matrix_type} allows the type of\n\ -the matrix to be defined.\n\ -\n\ -If the option @qcode{\"nocompute\"} is given, the function will not attempt\n\ -to guess the type if it is still unknown. This is useful for debugging\n\ -purposes.\n\ -\n\ -The possible matrix types depend on whether the matrix is full or sparse,\n\ -and can be one of the following\n\ -\n\ -@table @asis\n\ -@item @qcode{\"unknown\"}\n\ -Remove any previously cached matrix type, and mark type as unknown.\n\ -\n\ -@item @qcode{\"full\"}\n\ -Mark the matrix as full.\n\ -\n\ -@item @qcode{\"positive definite\"}\n\ -Probable full positive definite matrix.\n\ -\n\ -@item @qcode{\"diagonal\"}\n\ -Diagonal matrix. (Sparse matrices only)\n\ -\n\ -@item @qcode{\"permuted diagonal\"}\n\ -Permuted Diagonal matrix. The permutation does not need to be specifically\n\ -indicated, as the structure of the matrix explicitly gives this. (Sparse\n\ -matrices only)\n\ -\n\ -@item @qcode{\"upper\"}\n\ -Upper triangular. If the optional third argument @var{perm} is given, the\n\ -matrix is assumed to be a permuted upper triangular with the permutations\n\ -defined by the vector @var{perm}.\n\ -\n\ -@item @qcode{\"lower\"}\n\ -Lower triangular. If the optional third argument @var{perm} is given, the\n\ -matrix is assumed to be a permuted lower triangular with the permutations\n\ -defined by the vector @var{perm}.\n\ -\n\ -@item @qcode{\"banded\"}\n\ -@itemx @qcode{\"banded positive definite\"}\n\ -Banded matrix with the band size of @var{nl} below the diagonal and @var{nu}\n\ -above it. If @var{nl} and @var{nu} are 1, then the matrix is tridiagonal\n\ -and treated with specialized code. In addition the matrix can be marked as\n\ -probably a positive definite. (Sparse matrices only)\n\ -\n\ -@item @qcode{\"singular\"}\n\ -The matrix is assumed to be singular and will be treated with a minimum norm\n\ -solution.\n\ -\n\ -@end table\n\ -\n\ -Note that the matrix type will be discovered automatically on the first\n\ -attempt to solve a linear equation involving @var{A}. Therefore\n\ -@code{matrix_type} is only useful to give Octave hints of the matrix type.\n\ -Incorrectly defining the matrix type will result in incorrect results from\n\ -solutions of linear equations; it is entirely @strong{the responsibility of\n\ -the user} to correctly identify the matrix type.\n\ -\n\ -Also, the test for positive definiteness is a low-cost test for a Hermitian\n\ -matrix with a real positive diagonal. This does not guarantee that the\n\ -matrix is positive definite, but only that it is a probable candidate. When\n\ -such a matrix is factorized, a Cholesky@tie{}factorization is first\n\ -attempted, and if that fails the matrix is then treated with an\n\ -LU@tie{}factorization. Once the matrix has been factorized,\n\ -@code{matrix_type} will return the correct classification of the matrix.\n\ -@end deftypefn") + doc: /* -*- texinfo -*- +@deftypefn {} {@var{type} =} matrix_type (@var{A}) +@deftypefnx {} {@var{type} =} matrix_type (@var{A}, "nocompute") +@deftypefnx {} {@var{A} =} matrix_type (@var{A}, @var{type}) +@deftypefnx {} {@var{A} =} matrix_type (@var{A}, "upper", @var{perm}) +@deftypefnx {} {@var{A} =} matrix_type (@var{A}, "lower", @var{perm}) +@deftypefnx {} {@var{A} =} matrix_type (@var{A}, "banded", @var{nl}, @var{nu}) +Identify the matrix type or mark a matrix as a particular type. + +This allows more rapid solutions of linear equations involving @var{A} to be +performed. + +Called with a single argument, @code{matrix_type} returns the type of the +matrix and caches it for future use. + +Called with more than one argument, @code{matrix_type} allows the type of +the matrix to be defined. + +If the option @qcode{"nocompute"} is given, the function will not attempt +to guess the type if it is still unknown. This is useful for debugging +purposes. + +The possible matrix types depend on whether the matrix is full or sparse, +and can be one of the following + +@table @asis +@item @qcode{"unknown"} +Remove any previously cached matrix type, and mark type as unknown. + +@item @qcode{"full"} +Mark the matrix as full. + +@item @qcode{"positive definite"} +Probable full positive definite matrix. + +@item @qcode{"diagonal"} +Diagonal matrix. (Sparse matrices only) + +@item @qcode{"permuted diagonal"} +Permuted Diagonal matrix. The permutation does not need to be specifically +indicated, as the structure of the matrix explicitly gives this. (Sparse +matrices only) + +@item @qcode{"upper"} +Upper triangular. If the optional third argument @var{perm} is given, the +matrix is assumed to be a permuted upper triangular with the permutations +defined by the vector @var{perm}. + +@item @qcode{"lower"} +Lower triangular. If the optional third argument @var{perm} is given, the +matrix is assumed to be a permuted lower triangular with the permutations +defined by the vector @var{perm}. + +@item @qcode{"banded"} +@itemx @qcode{"banded positive definite"} +Banded matrix with the band size of @var{nl} below the diagonal and @var{nu} +above it. If @var{nl} and @var{nu} are 1, then the matrix is tridiagonal +and treated with specialized code. In addition the matrix can be marked as +probably a positive definite. (Sparse matrices only) + +@item @qcode{"singular"} +The matrix is assumed to be singular and will be treated with a minimum norm +solution. + +@end table + +Note that the matrix type will be discovered automatically on the first +attempt to solve a linear equation involving @var{A}. Therefore +@code{matrix_type} is only useful to give Octave hints of the matrix type. +Incorrectly defining the matrix type will result in incorrect results from +solutions of linear equations; it is entirely @strong{the responsibility of +the user} to correctly identify the matrix type. + +Also, the test for positive definiteness is a low-cost test for a Hermitian +matrix with a real positive diagonal. This does not guarantee that the +matrix is positive definite, but only that it is a probable candidate. When +such a matrix is factorized, a Cholesky@tie{}factorization is first +attempted, and if that fails the matrix is then treated with an +LU@tie{}factorization. Once the matrix has been factorized, +@code{matrix_type} will return the correct classification of the matrix. +@end deftypefn */) { int nargin = args.length ();