Mercurial > hg > octave-max
changeset 10602:38eae0c3a003
Add TeX equation to cond.m documentation
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Mon, 03 May 2010 12:08:57 -0700 |
parents | 3ce0c530a9c9 |
children | d909c4c14b63 |
files | scripts/ChangeLog scripts/linear-algebra/cond.m |
diffstat | 2 files changed, 17 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/ChangeLog +++ b/scripts/ChangeLog @@ -1,3 +1,7 @@ +2010-05-02 Rik <octave@nomad.inbox5.com> + + * linear-algebra/cond.m: Add TeX equation to documentation + 2010-05-02 Peter van den Biggelaar <peter@biglr.net> * plot/close.m: No error on "close([])".
--- a/scripts/linear-algebra/cond.m +++ b/scripts/linear-algebra/cond.m @@ -18,12 +18,21 @@ ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- -## @deftypefn {Function File} {} cond (@var{a},@var{p}) +## @deftypefn {Function File} {} cond (@var{a}) +## @deftypefnx {Function File} {} cond (@var{a},@var{p}) ## Compute the @var{p}-norm condition number of a matrix. @code{cond (@var{a})} is -## defined as @code{norm (@var{a}, @var{p}) * norm (inv (@var{a}), @var{p})}. -## By default @code{@var{p}=2} is used which implies a (relatively slow) +## defined as +## @tex +## $ {\parallel a \parallel_p * \parallel a^{-1} \parallel_p .} $ +## @end tex +## @ifnottex +## @code{norm (@var{a}, @var{p}) * norm (inv (@var{a}), @var{p})}. +## @end ifnottex +## +## By default @code{@var{p} = 2} is used which implies a (relatively slow) ## singular value decomposition. Other possible selections are -## @code{@var{p}= 1, Inf, inf, 'Inf', 'fro'} which are generally faster. +## @code{@var{p} = 1, Inf, "inf", "fro"} which are generally faster. See +## @code{norm} for a full discussion of possible @var{p} values. ## @seealso{condest, rcond, norm, svd} ## @end deftypefn