comparison libinterp/dldfcn/qr.cc @ 17281:bc924baa2c4e

doc: Add new @qcode macro for code samples which are quoted. Macro handles options ("on") or properties ("position") more elegantly than @code{"text"}. * doc/interpreter/macros.texi: Add new @qcode macro. * doc/interpreter/tips.txi: Add documentation about @qcode macro. * doc/interpreter/basics.txi, doc/interpreter/container.txi, doc/interpreter/emacs.txi, doc/interpreter/errors.txi, doc/interpreter/eval.txi, doc/interpreter/expr.txi, doc/interpreter/external.txi, doc/interpreter/func.txi, doc/interpreter/grammar.txi, doc/interpreter/image.txi, doc/interpreter/install.txi, doc/interpreter/interp.txi, doc/interpreter/io.txi, doc/interpreter/matrix.txi, doc/interpreter/numbers.txi, doc/interpreter/oop.txi, doc/interpreter/package.txi, doc/interpreter/plot.txi, doc/interpreter/quad.txi, doc/interpreter/sparse.txi, doc/interpreter/strings.txi, doc/interpreter/system.txi, doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc, libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc, libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc, libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc, libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc, libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc, libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc, libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc, libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc, libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc, libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc, libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc, libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc, libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc, libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc, libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc, libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc, libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc, libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc, libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc, libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc, libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc, libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc, libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc, libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc, libinterp/octave-value/ov-fcn-handle.cc, libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc, libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc, libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy, libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc, libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m, scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m, scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m, scripts/general/dblquad.m, scripts/general/display.m, scripts/general/genvarname.m, scripts/general/idivide.m, scripts/general/interp1.m, scripts/general/interp2.m, scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m, scripts/general/profexplore.m, scripts/general/profile.m, scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m, scripts/general/subsindex.m, scripts/general/triplequad.m, scripts/geometry/griddata.m, scripts/geometry/griddata3.m, scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m, scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m, scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m, scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m, scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m, scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m, scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m, scripts/java/javaclasspath.m, scripts/java/usejava.m, scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m, scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m, scripts/optimization/fminunc.m, scripts/optimization/fsolve.m, scripts/optimization/fzero.m, scripts/optimization/glpk.m, scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m, scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m, scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m, scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m, scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m, scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m, scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m, scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m, scripts/plot/plot.m, scripts/plot/print.m, scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m, scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m, scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m, scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m, scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m, scripts/polynomial/conv.m, scripts/polynomial/polyout.m, scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m, scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m, scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m, scripts/signal/periodogram.m, scripts/signal/spectral_adf.m, scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m, scripts/specfun/legendre.m, scripts/special-matrix/gallery.m, scripts/statistics/base/mean.m, scripts/statistics/base/moment.m, scripts/statistics/tests/cor_test.m, scripts/statistics/tests/kolmogorov_smirnov_test.m, scripts/statistics/tests/kolmogorov_smirnov_test_2.m, scripts/statistics/tests/kruskal_wallis_test.m, scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m, scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m, scripts/statistics/tests/t_test_regression.m, scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m, scripts/statistics/tests/welch_test.m, scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m, scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m, scripts/strings/index.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/validatestring.m, scripts/testfun/demo.m, scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m, scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m, scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m, scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m, scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
author Rik <rik@octave.org>
date Mon, 19 Aug 2013 20:46:38 -0700
parents 53eaa83e4181
children b81b9d079515
comparison
equal deleted inserted replaced
17280:1a5407bae739 17281:bc924baa2c4e
131 @ifnottex\n\ 131 @ifnottex\n\
132 @code{@var{Q} * @var{Q} = @var{A}} where @var{Q} is an orthogonal matrix and\n\ 132 @code{@var{Q} * @var{Q} = @var{A}} where @var{Q} is an orthogonal matrix and\n\
133 @var{R} is upper triangular.\n\ 133 @var{R} is upper triangular.\n\
134 @end ifnottex\n\ 134 @end ifnottex\n\
135 \n\ 135 \n\
136 If given a second argument of '0', @code{qr} returns an economy-sized\n\ 136 If given a second argument of @qcode{'0'}, @code{qr} returns an economy-sized\n\
137 QR@tie{}factorization, omitting zero rows of @var{R} and the corresponding\n\ 137 QR@tie{}factorization, omitting zero rows of @var{R} and the corresponding\n\
138 columns of @var{Q}.\n\ 138 columns of @var{Q}.\n\
139 \n\ 139 \n\
140 If the matrix @var{A} is full, the permuted QR@tie{}factorization\n\ 140 If the matrix @var{A} is full, the permuted QR@tie{}factorization\n\
141 @code{[@var{Q}, @var{R}, @var{P}] = qr (@var{A})} forms the\n\ 141 @code{[@var{Q}, @var{R}, @var{P}] = qr (@var{A})} forms the\n\
940 @deftypefn {Loadable Function} {[@var{Q1}, @var{R1}] =} qrinsert (@var{Q}, @var{R}, @var{j}, @var{x}, @var{orient})\n\ 940 @deftypefn {Loadable Function} {[@var{Q1}, @var{R1}] =} qrinsert (@var{Q}, @var{R}, @var{j}, @var{x}, @var{orient})\n\
941 Given a QR@tie{}factorization of a real or complex matrix\n\ 941 Given a QR@tie{}factorization of a real or complex matrix\n\
942 @w{@var{A} = @var{Q}*@var{R}}, @var{Q}@tie{}unitary and\n\ 942 @w{@var{A} = @var{Q}*@var{R}}, @var{Q}@tie{}unitary and\n\
943 @var{R}@tie{}upper trapezoidal, return the QR@tie{}factorization of\n\ 943 @var{R}@tie{}upper trapezoidal, return the QR@tie{}factorization of\n\
944 @w{[A(:,1:j-1) x A(:,j:n)]}, where @var{u} is a column vector to be\n\ 944 @w{[A(:,1:j-1) x A(:,j:n)]}, where @var{u} is a column vector to be\n\
945 inserted into @var{A} (if @var{orient} is @code{\"col\"}), or the\n\ 945 inserted into @var{A} (if @var{orient} is @qcode{\"col\"}), or the\n\
946 QR@tie{}factorization of @w{[A(1:j-1,:);x;A(:,j:n)]}, where @var{x}\n\ 946 QR@tie{}factorization of @w{[A(1:j-1,:);x;A(:,j:n)]}, where @var{x}\n\
947 is a row vector to be inserted into @var{A} (if @var{orient} is\n\ 947 is a row vector to be inserted into @var{A} (if @var{orient} is\n\
948 @code{\"row\"}).\n\ 948 @qcode{\"row\"}).\n\
949 \n\ 949 \n\
950 The default value of @var{orient} is @code{\"col\"}.\n\ 950 The default value of @var{orient} is @qcode{\"col\"}.\n\
951 If @var{orient} is @code{\"col\"},\n\ 951 If @var{orient} is @qcode{\"col\"},\n\
952 @var{u} may be a matrix and @var{j} an index vector\n\ 952 @var{u} may be a matrix and @var{j} an index vector\n\
953 resulting in the QR@tie{}factorization of a matrix @var{B} such that\n\ 953 resulting in the QR@tie{}factorization of a matrix @var{B} such that\n\
954 @w{B(:,@var{j})} gives @var{u} and @w{B(:,@var{j}) = []} gives @var{A}.\n\ 954 @w{B(:,@var{j})} gives @var{u} and @w{B(:,@var{j}) = []} gives @var{A}.\n\
955 Notice that the latter case is done as a sequence of k insertions;\n\ 955 Notice that the latter case is done as a sequence of k insertions;\n\
956 thus, for k large enough, it will be both faster and more accurate to\n\ 956 thus, for k large enough, it will be both faster and more accurate to\n\
957 recompute the factorization from scratch.\n\ 957 recompute the factorization from scratch.\n\
958 \n\ 958 \n\
959 If @var{orient} is @code{\"col\"},\n\ 959 If @var{orient} is @qcode{\"col\"},\n\
960 the QR@tie{}factorization supplied may be either full\n\ 960 the QR@tie{}factorization supplied may be either full\n\
961 (Q is square) or economized (R is square).\n\ 961 (Q is square) or economized (R is square).\n\
962 \n\ 962 \n\
963 If @var{orient} is @code{\"row\"}, full factorization is needed.\n\ 963 If @var{orient} is @qcode{\"row\"}, full factorization is needed.\n\
964 @seealso{qr, qrupdate, qrdelete, qrshift}\n\ 964 @seealso{qr, qrupdate, qrdelete, qrshift}\n\
965 @end deftypefn") 965 @end deftypefn")
966 { 966 {
967 octave_idx_type nargin = args.length (); 967 octave_idx_type nargin = args.length ();
968 octave_value_list retval; 968 octave_value_list retval;
1159 @deftypefn {Loadable Function} {[@var{Q1}, @var{R1}] =} qrdelete (@var{Q}, @var{R}, @var{j}, @var{orient})\n\ 1159 @deftypefn {Loadable Function} {[@var{Q1}, @var{R1}] =} qrdelete (@var{Q}, @var{R}, @var{j}, @var{orient})\n\
1160 Given a QR@tie{}factorization of a real or complex matrix\n\ 1160 Given a QR@tie{}factorization of a real or complex matrix\n\
1161 @w{@var{A} = @var{Q}*@var{R}}, @var{Q}@tie{}unitary and\n\ 1161 @w{@var{A} = @var{Q}*@var{R}}, @var{Q}@tie{}unitary and\n\
1162 @var{R}@tie{}upper trapezoidal, return the QR@tie{}factorization of\n\ 1162 @var{R}@tie{}upper trapezoidal, return the QR@tie{}factorization of\n\
1163 @w{[A(:,1:j-1) A(:,j+1:n)]}, i.e., @var{A} with one column deleted\n\ 1163 @w{[A(:,1:j-1) A(:,j+1:n)]}, i.e., @var{A} with one column deleted\n\
1164 (if @var{orient} is \"col\"), or the QR@tie{}factorization of\n\ 1164 (if @var{orient} is @qcode{\"col\"}), or the QR@tie{}factorization of\n\
1165 @w{[A(1:j-1,:);A(j+1:n,:)]}, i.e., @var{A} with one row deleted (if\n\ 1165 @w{[A(1:j-1,:);A(j+1:n,:)]}, i.e., @var{A} with one row deleted (if\n\
1166 @var{orient} is \"row\").\n\ 1166 @var{orient} is @qcode{\"row\"}).\n\
1167 \n\ 1167 \n\
1168 The default value of @var{orient} is \"col\".\n\ 1168 The default value of @var{orient} is @qcode{\"col\"}.\n\
1169 \n\ 1169 \n\
1170 If @var{orient} is @code{\"col\"},\n\ 1170 If @var{orient} is @qcode{\"col\"},\n\
1171 @var{j} may be an index vector\n\ 1171 @var{j} may be an index vector\n\
1172 resulting in the QR@tie{}factorization of a matrix @var{B} such that\n\ 1172 resulting in the QR@tie{}factorization of a matrix @var{B} such that\n\
1173 @w{A(:,@var{j}) = []} gives @var{B}.\n\ 1173 @w{A(:,@var{j}) = []} gives @var{B}.\n\
1174 Notice that the latter case is done as a sequence of k deletions;\n\ 1174 Notice that the latter case is done as a sequence of k deletions;\n\
1175 thus, for k large enough, it will be both faster and more accurate to\n\ 1175 thus, for k large enough, it will be both faster and more accurate to\n\
1176 recompute the factorization from scratch.\n\ 1176 recompute the factorization from scratch.\n\
1177 \n\ 1177 \n\
1178 If @var{orient} is @code{\"col\"},\n\ 1178 If @var{orient} is @qcode{\"col\"},\n\
1179 the QR@tie{}factorization supplied may be either full\n\ 1179 the QR@tie{}factorization supplied may be either full\n\
1180 (Q is square) or economized (R is square).\n\ 1180 (Q is square) or economized (R is square).\n\
1181 \n\ 1181 \n\
1182 If @var{orient} is @code{\"row\"}, full factorization is needed.\n\ 1182 If @var{orient} is @qcode{\"row\"}, full factorization is needed.\n\
1183 @seealso{qr, qrupdate, qrinsert, qrshift}\n\ 1183 @seealso{qr, qrupdate, qrinsert, qrshift}\n\
1184 @end deftypefn") 1184 @end deftypefn")
1185 { 1185 {
1186 octave_idx_type nargin = args.length (); 1186 octave_idx_type nargin = args.length ();
1187 octave_value_list retval; 1187 octave_value_list retval;