comparison libinterp/dldfcn/qr.cc @ 21547:ad0599a0acc6

doc: Wrap C++ docstrings to 79 characters + newline (80 total). * besselj.cc, bitfcns.cc, cellfun.cc, data.cc, debug.cc, error.cc, file-io.cc, graphics.cc, input.cc, lu.cc, matrix_type.cc, nproc.cc, pr-output.cc, quadcc.cc, regexp.cc, schur.cc, sparse.cc, strfind.cc, strfns.cc, syscalls.cc, urlwrite.cc, variables.cc, __osmesa_print__.cc, audiodevinfo.cc, audioread.cc, ccolamd.cc, chol.cc, colamd.cc, convhulln.cc, qr.cc, symbfact.cc, ov-java.cc, ov-struct.cc, ov-usr-fcn.cc, pt-arg-list.cc: doc: Wrap C++ docstrings to 79 characters + newline (80 total).
author Rik <rik@octave.org>
date Sun, 27 Mar 2016 20:39:19 -0700
parents 40de9f8f23a6
children ecce63c99c3f
comparison
equal deleted inserted replaced
21546:f7f97d7e9294 21547:ad0599a0acc6
135 @ifnottex\n\ 135 @ifnottex\n\
136 @code{@var{Q} * @var{R} = @var{A}} where @var{Q} is an orthogonal matrix and\n\ 136 @code{@var{Q} * @var{R} = @var{A}} where @var{Q} is an orthogonal matrix and\n\
137 @var{R} is upper triangular.\n\ 137 @var{R} is upper triangular.\n\
138 @end ifnottex\n\ 138 @end ifnottex\n\
139 \n\ 139 \n\
140 If given a second argument of @qcode{'0'}, @code{qr} returns an economy-sized\n\ 140 If given a second argument of @qcode{'0'}, @code{qr} returns an\n\
141 QR@tie{}factorization, omitting zero rows of @var{R} and the corresponding\n\ 141 economy-sized QR@tie{}factorization, omitting zero rows of @var{R} and the\n\
142 columns of @var{Q}.\n\ 142 corresponding columns of @var{Q}.\n\
143 \n\ 143 \n\
144 If the matrix @var{A} is full, the permuted QR@tie{}factorization\n\ 144 If the matrix @var{A} is full, the permuted QR@tie{}factorization\n\
145 @code{[@var{Q}, @var{R}, @var{P}] = qr (@var{A})} forms the\n\ 145 @code{[@var{Q}, @var{R}, @var{P}] = qr (@var{A})} forms the\n\
146 QR@tie{}factorization such that the diagonal entries of @var{R} are\n\ 146 QR@tie{}factorization such that the diagonal entries of @var{R} are\n\
147 decreasing in magnitude order. For example, given the matrix\n\ 147 decreasing in magnitude order. For example, given the matrix\n\
732 Given a QR@tie{}factorization of a real or complex matrix\n\ 732 Given a QR@tie{}factorization of a real or complex matrix\n\
733 @w{@var{A} = @var{Q}*@var{R}}, @var{Q}@tie{}unitary and\n\ 733 @w{@var{A} = @var{Q}*@var{R}}, @var{Q}@tie{}unitary and\n\
734 @var{R}@tie{}upper trapezoidal, return the QR@tie{}factorization of\n\ 734 @var{R}@tie{}upper trapezoidal, return the QR@tie{}factorization of\n\
735 @w{@var{A} + @var{u}*@var{v}'}, where @var{u} and @var{v} are column vectors\n\ 735 @w{@var{A} + @var{u}*@var{v}'}, where @var{u} and @var{v} are column vectors\n\
736 (rank-1 update) or matrices with equal number of columns\n\ 736 (rank-1 update) or matrices with equal number of columns\n\
737 (rank-k update). Notice that the latter case is done as a sequence of rank-1\n\ 737 (rank-k update). Notice that the latter case is done as a sequence of\n\
738 updates; thus, for k large enough, it will be both faster and more accurate\n\ 738 rank-1 updates; thus, for k large enough, it will be both faster and more\n\
739 to recompute the factorization from scratch.\n\ 739 accurate to recompute the factorization from scratch.\n\
740 \n\ 740 \n\
741 The QR@tie{}factorization supplied may be either full (Q is square) or\n\ 741 The QR@tie{}factorization supplied may be either full (Q is square) or\n\
742 economized (R is square).\n\ 742 economized (R is square).\n\
743 \n\ 743 \n\
744 @seealso{qr, qrinsert, qrdelete, qrshift}\n\ 744 @seealso{qr, qrinsert, qrdelete, qrshift}\n\