comparison scripts/linear-algebra/null.m @ 11470:eb9e0b597d61

Use common names for variables in documentation and code for a few more m-script files.
author Rik <octave@nomad.inbox5.com>
date Sun, 09 Jan 2011 13:44:15 -0800
parents a8ce6bdecce5
children fd0a3ac60b0e
comparison
equal deleted inserted replaced
11469:c776f063fefe 11470:eb9e0b597d61
16 ## You should have received a copy of the GNU General Public License 16 ## You should have received a copy of the GNU General Public License
17 ## along with Octave; see the file COPYING. If not, see 17 ## along with Octave; see the file COPYING. If not, see
18 ## <http://www.gnu.org/licenses/>. 18 ## <http://www.gnu.org/licenses/>.
19 19
20 ## -*- texinfo -*- 20 ## -*- texinfo -*-
21 ## @deftypefn {Function File} {} null (@var{a}, @var{tol}) 21 ## @deftypefn {Function File} {} null (@var{A}, @var{tol})
22 ## Return an orthonormal basis of the null space of @var{a}. 22 ## Return an orthonormal basis of the null space of @var{A}.
23 ## 23 ##
24 ## The dimension of the null space is taken as the number of singular 24 ## The dimension of the null space is taken as the number of singular
25 ## values of @var{a} not greater than @var{tol}. If the argument @var{tol} 25 ## values of @var{A} not greater than @var{tol}. If the argument @var{tol}
26 ## is missing, it is computed as 26 ## is missing, it is computed as
27 ## 27 ##
28 ## @example 28 ## @example
29 ## max (size (@var{a})) * max (svd (@var{a})) * eps 29 ## max (size (@var{A})) * max (svd (@var{A})) * eps
30 ## @end example 30 ## @end example
31 ## @seealso{orth} 31 ## @seealso{orth}
32 ## @end deftypefn 32 ## @end deftypefn
33 33
34 ## Author: KH <Kurt.Hornik@wu-wien.ac.at> 34 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>