octave-antonio: scripts/linear-algebra/cond.m annotate

annotate scripts/linear-algebra/cond.m @ 20160:03b9d17a2d95 stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed io, java, linear-algebra, prefs, and set script directories. * scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m, scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m, scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m, scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m, scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m, scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m, scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m, scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m, scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m, scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m, scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m, scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m, scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m, scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m, scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m, scripts/set/powerset.m, scripts/set/setdiff.m: Update more docstrings to have one sentence summary as first line.

author	Rik <rik@octave.org>
date	Sun, 03 May 2015 15:36:23 -0700
parents	4197fc428c7d
children

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 17744 diff changeset	1 ## Copyright (C) 1993-2015 John W. Eaton
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	6 ## under the terms of the GNU General Public License as published by
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	8 ## your option) any later version.
2313 5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe] jwe parents: 2311 diff changeset	15 ## You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6046 diff changeset	17 ## <http://www.gnu.org/licenses/>.
245 16a24e76d6e0 [project @ 1993-12-03 02:00:15 by jwe] jwe parents: 4 diff changeset	18
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3265 diff changeset	19 ## -- texinfo --
11471 994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	20 ## @deftypefn {Function File} {} cond (@var{A})
11563 3c6e8aaa9555 Grammarcheck m-files before 3.4 release. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	21 ## @deftypefnx {Function File} {} cond (@var{A}, @var{p})
12584 7ef7e20057fa Improve documentation strings in Linear Algebra chapter. Rik <octave@nomad.inbox5.com> parents: 11587 diff changeset	22 ## Compute the @var{p}-norm condition number of a matrix.
12642 f96b9b9f141b doc: Periodic grammarcheck and spellcheck of documentation. Rik <octave@nomad.inbox5.com> parents: 12584 diff changeset	23 ##
16957 9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	24 ## @code{cond (@var{A})} is defined as
10602 38eae0c3a003 Add TeX equation to cond.m documentation Rik <octave@nomad.inbox5.com> parents: 9307 diff changeset	25 ## @tex
11471 994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	26 ## $ {\parallel A \parallel_p * \parallel A^{-1} \parallel_p .} $
10602 38eae0c3a003 Add TeX equation to cond.m documentation Rik <octave@nomad.inbox5.com> parents: 9307 diff changeset	27 ## @end tex
38eae0c3a003 Add TeX equation to cond.m documentation Rik <octave@nomad.inbox5.com> parents: 9307 diff changeset	28 ## @ifnottex
11471 994e2a93a8e2 Use uppercase 'A' to refer to matrix inputs in m-files. Rik <octave@nomad.inbox5.com> parents: 10793 diff changeset	29 ## @code{norm (@var{A}, @var{p}) * norm (inv (@var{A}), @var{p})}.
10602 38eae0c3a003 Add TeX equation to cond.m documentation Rik <octave@nomad.inbox5.com> parents: 9307 diff changeset	30 ## @end ifnottex
38eae0c3a003 Add TeX equation to cond.m documentation Rik <octave@nomad.inbox5.com> parents: 9307 diff changeset	31 ##
16957 9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	32 ## By default, @code{@var{p} = 2} is used which implies a (relatively slow)
11587 c792872f8942 all script files: untabify and strip trailing whitespace John W. Eaton <jwe@octave.org> parents: 11563 diff changeset	33 ## singular value decomposition. Other possible selections are
20160 03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	34 ## @code{@var{p} = 1, Inf, "fro"} which are generally faster. See @code{norm}
03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	35 ## for a full discussion of possible @var{p} values.
16957 9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	36 ##
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	37 ## The condition number of a matrix quantifies the sensitivity of the matrix
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	38 ## inversion operation when small changes are made to matrix elements. Ideally
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	39 ## the condition number will be close to 1. When the number is large this
17171 c3bd7314643c doc: Periodic spellcheck of documentation. Rik <rik@octave.org> parents: 16969 diff changeset	40 ## indicates small changes (such as underflow or round-off error) will produce
16957 9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	41 ## large changes in the resulting output. In such cases the solution results
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	42 ## from numerical computing are not likely to be accurate.
9307 c2923c27c877 Various documentation improvements Rik <rdrider0-list@yahoo.com> parents: 9051 diff changeset	43 ## @seealso{condest, rcond, norm, svd}
3372 f16c2ce14886 [project @ 1999-11-23 19:07:09 by jwe] jwe parents: 3265 diff changeset	44 ## @end deftypefn
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	45
2314 949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	46 ## Author: jwe
949ab8eba8bc [project @ 1996-07-12 03:58:02 by jwe] jwe parents: 2313 diff changeset	47
16957 9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	48 function retval = cond (A, p = 2)
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	49
16957 9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	50 if (nargin < 1 \|\| nargin > 2)
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	51 print_usage ();
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	52 endif
7484 e7485946272b new norm arg for cond John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	53
16957 9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	54 if (ndims (A) > 2)
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	55 error ("cond: A must be a 2-D matrix");
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	56 endif
4890 e7da90a1cc11 [project @ 2004-05-06 20:36:29 by jwe] jwe parents: 4478 diff changeset	57
16957 9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	58 if (p == 2)
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	59 if (isempty (A))
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	60 retval = 0.0;
16969 58188d5a2587 Use isfinite() to replace isinf() \| isnan() combination for 30% speed-up. Rik <rik@octave.org> parents: 16957 diff changeset	61 elseif (any (! isfinite (A(:))))
16957 9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	62 error ("cond: A must not contain Inf or NaN values");
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	63 else
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	64 sigma = svd (A);
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	65 sigma_1 = sigma(1);
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	66 sigma_n = sigma(end);
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	67 if (sigma_1 == 0 \|\| sigma_n == 0)
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	68 retval = Inf;
7484 e7485946272b new norm arg for cond John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	69 else
16957 9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	70 retval = sigma_1 / sigma_n;
7484 e7485946272b new norm arg for cond John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	71 endif
3250 ae3bdfd82f91 [project @ 1999-07-13 03:49:22 by jwe] jwe parents: 2847 diff changeset	72 endif
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	73 else
16957 9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	74 retval = norm (A, p) * norm (inv (A), p);
4 b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	75 endif
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	76
b4df021f796c [project @ 1993-08-08 01:26:08 by jwe] jwe parents: diff changeset	77 endfunction
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	78
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	79
7484 e7485946272b new norm arg for cond John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	80 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	81 %! y = [7, 2, 3; 1, 3, 4; 6, 4, 5];
7484 e7485946272b new norm arg for cond John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	82 %! tol = 1e-6;
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	83 %! type = {1, 2, "fro", "inf", inf};
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	84 %! for n = 1:numel (type)
7484 e7485946272b new norm arg for cond John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	85 %! rcondition(n) = 1 / cond (y, type{n});
e7485946272b new norm arg for cond John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	86 %! endfor
e7485946272b new norm arg for cond John W. Eaton <jwe@octave.org> parents: 7411 diff changeset	87 %! assert (rcondition, [0.017460, 0.019597, 0.018714, 0.012022, 0.012022], tol);
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	88
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	89 %!assert (cond ([1, 2; 2, 1]), 3, sqrt (eps))
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	90 %!assert (cond ([1, 2, 3; 4, 5, 6; 7, 8, 9]) > 1.0e+16)
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	91
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	92 %!error cond ()
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	93 %!error cond (1, 2, 3)
16957 9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	94 %!error <A must be a 2-D matrix> cond (ones (1,3,3))
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	95 %!error <A must not contain Inf or NaN value> cond ([1, 2;Inf 4])
9f50dd7ece60 cond.m: Update documentation and coding style. Rik <rik@octave.org> parents: 14363 diff changeset	96 %!error <A must not contain Inf or NaN value> cond ([1, 2;NaN 4])
7411 83a8781b529d [project @ 2008-01-22 21:52:25 by jwe] jwe parents: 7017 diff changeset	97

Mercurial > octave-antonio

annotate scripts/linear-algebra/cond.m @ 20160:03b9d17a2d95 stable