Mercurial > octave-antonio
diff scripts/linear-algebra/null.m @ 3372:f16c2ce14886
[project @ 1999-11-23 19:07:09 by jwe]
author | jwe |
---|---|
date | Tue, 23 Nov 1999 19:07:18 +0000 |
parents | 8b262e771614 |
children | f8dde1807dee |
line wrap: on
line diff
--- a/scripts/linear-algebra/null.m Sun Nov 21 17:31:10 1999 +0000 +++ b/scripts/linear-algebra/null.m Tue Nov 23 19:07:18 1999 +0000 @@ -17,15 +17,18 @@ ## Software Foundation, 59 Temple Place - Suite 330, Boston, MA ## 02111-1307, USA. -## usage: null (A, tol) -## null (A) -## -## Returns an orthonormal basis of the null space of A. -## +## -*- texinfo -*- +## @deftypefn {Function File} {} null (@var{a}, @var{tol}) +## Return an orthonormal basis of the null space of @var{a}. +## ## The dimension of the null space is taken as the number of singular -## values of A not greater than tol; the default for tol is -## max (size (A)) * sigma_max (A) * eps, where sigma_max (A) is the -## maximal singular value of A. +## values of @var{a} not greater than @var{tol}. If the argument @var{tol} +## is missing, it is computed as +## +## @example +## max (size (@var{a})) * max (svd (@var{a})) * eps +## @end example +## @end deftypefn ## Author: KH <Kurt.Hornik@ci.tuwien.ac.at> ## Created: 24 December 1993.