Mercurial > octave-antonio

comparison scripts/sparse/spaugment.m @ 20164:df437a52bcaf stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update more docstrings to have one sentence summary as first line. Reviewed miscellaneous, sparse, strings in scripts directory. * scripts/miscellaneous/bzip2.m, scripts/miscellaneous/citation.m, scripts/miscellaneous/compare_versions.m, scripts/miscellaneous/computer.m, scripts/miscellaneous/debug.m, scripts/miscellaneous/dir.m, scripts/miscellaneous/edit.m, scripts/miscellaneous/error_ids.m, scripts/miscellaneous/fileattrib.m, scripts/miscellaneous/fullfile.m, scripts/miscellaneous/genvarname.m, scripts/miscellaneous/gzip.m, scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/news.m, scripts/miscellaneous/open.m, scripts/miscellaneous/parseparams.m, scripts/miscellaneous/recycle.m, scripts/miscellaneous/run.m, scripts/miscellaneous/swapbytes.m, scripts/miscellaneous/tar.m, scripts/miscellaneous/tmpnam.m, scripts/miscellaneous/unpack.m, scripts/miscellaneous/what.m, scripts/sparse/bicg.m, scripts/sparse/bicgstab.m, scripts/sparse/cgs.m, scripts/sparse/colperm.m, scripts/sparse/eigs.m, scripts/sparse/etreeplot.m, scripts/sparse/gmres.m, scripts/sparse/gplot.m, scripts/sparse/ichol.m, scripts/sparse/ilu.m, scripts/sparse/pcg.m, scripts/sparse/pcr.m, scripts/sparse/qmr.m, scripts/sparse/spaugment.m, scripts/sparse/spconvert.m, scripts/sparse/spdiags.m, scripts/sparse/spfun.m, scripts/sparse/spones.m, scripts/sparse/sprandsym.m, scripts/sparse/spstats.m, scripts/sparse/spy.m, scripts/sparse/svds.m, scripts/sparse/treelayout.m, scripts/sparse/treeplot.m, scripts/strings/base2dec.m, scripts/strings/bin2dec.m, scripts/strings/blanks.m, scripts/strings/cstrcat.m, scripts/strings/deblank.m, scripts/strings/dec2base.m, scripts/strings/dec2bin.m, scripts/strings/dec2hex.m, scripts/strings/findstr.m, scripts/strings/hex2dec.m, scripts/strings/index.m, scripts/strings/isletter.m, scripts/strings/isstrprop.m, scripts/strings/mat2str.m, scripts/strings/ostrsplit.m, scripts/strings/regexptranslate.m, scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m, scripts/strings/strchr.m, scripts/strings/strjoin.m, scripts/strings/strjust.m, scripts/strings/strmatch.m, scripts/strings/strsplit.m, scripts/strings/strtok.m, scripts/strings/strtrim.m, scripts/strings/strtrunc.m, scripts/strings/substr.m, scripts/strings/untabify.m, scripts/time/datenum.m: Update more docstrings to have one sentence summary as first line.
author Rik <rik@octave.org>
date Mon, 04 May 2015 14:22:02 -0700
parents 9fc020886ae9
children
comparison
equal deleted inserted replaced
20163:075a5e2e1ba5 20164:df437a52bcaf
44 ## 44 ##
45 ## @example 45 ## @example
46 ## @var{r} = @var{b} - @var{A} * @var{x} 46 ## @var{r} = @var{b} - @var{A} * @var{x}
47 ## @end example 47 ## @end example
48 ## 48 ##
49 ## As the matrix @var{s} is symmetric indefinite it can be factorized 49 ## As the matrix @var{s} is symmetric indefinite it can be factorized with
50 ## with @code{lu}, and the minimum norm solution can therefore be found 50 ## @code{lu}, and the minimum norm solution can therefore be found without the
51 ## without the need for a @code{qr} factorization. As the residual 51 ## need for a @code{qr} factorization. As the residual error will be
52 ## error will be @code{zeros (@var{m}, @var{m})} for underdetermined 52 ## @code{zeros (@var{m}, @var{m})} for underdetermined problems, and example
53 ## problems, and example can be 53 ## can be
54 ## 54 ##
55 ## @example 55 ## @example
56 ## @group 56 ## @group
57 ## m = 11; n = 10; mn = max (m, n); 57 ## m = 11; n = 10; mn = max (m, n);
58 ## A = spdiags ([ones(mn,1), 10*ones(mn,1), -ones(mn,1)], 58 ## A = spdiags ([ones(mn,1), 10*ones(mn,1), -ones(mn,1)],
63 ## x1 = Q * (U \ (L \ (P * [ones(m,1); zeros(n,1)]))); 63 ## x1 = Q * (U \ (L \ (P * [ones(m,1); zeros(n,1)])));
64 ## x1 = x1(end - n + 1 : end); 64 ## x1 = x1(end - n + 1 : end);
65 ## @end group 65 ## @end group
66 ## @end example 66 ## @end example
67 ## 67 ##
68 ## To find the solution of an overdetermined problem needs an estimate 68 ## To find the solution of an overdetermined problem needs an estimate of the
69 ## of the residual error @var{r} and so it is more complex to formulate 69 ## residual error @var{r} and so it is more complex to formulate a minimum norm
70 ## a minimum norm solution using the @code{spaugment} function. 70 ## solution using the @code{spaugment} function.
71 ## 71 ##
72 ## In general the left division operator is more stable and faster than 72 ## In general the left division operator is more stable and faster than using
73 ## using the @code{spaugment} function. 73 ## the @code{spaugment} function.
74 ## @seealso{mldivide} 74 ## @seealso{mldivide}
75 ## @end deftypefn 75 ## @end deftypefn
76 76
77 function s = spaugment (A, c) 77 function s = spaugment (A, c)
78 if (nargin < 2) 78 if (nargin < 2)