Mercurial > hg > octave-thorsten
comparison scripts/linear-algebra/ishermitian.m @ 10793:be55736a0783
Grammarcheck the documentation from m-files.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sun, 18 Jul 2010 20:35:16 -0700 |
parents | fbd7843974fa |
children | 0d9640d755b1 |
comparison
equal
deleted
inserted
replaced
10792:91342260063e | 10793:be55736a0783 |
---|---|
18 ## along with Octave; see the file COPYING. If not, see | 18 ## along with Octave; see the file COPYING. If not, see |
19 ## <http://www.gnu.org/licenses/>. | 19 ## <http://www.gnu.org/licenses/>. |
20 | 20 |
21 ## -*- texinfo -*- | 21 ## -*- texinfo -*- |
22 ## @deftypefn {Function File} {} ishermitian (@var{x}, @var{tol}) | 22 ## @deftypefn {Function File} {} ishermitian (@var{x}, @var{tol}) |
23 ## Return true if @var{x} is symmetric within the tolerance specified by @var{tol}, | 23 ## Return true if @var{x} is symmetric within the tolerance specified by |
24 ## @var{tol}, | |
24 ## otherwise return false. The default tolerance is zero (uses faster code). | 25 ## otherwise return false. The default tolerance is zero (uses faster code). |
25 ## Matrix @var{x} is considered symmetric if | 26 ## Matrix @var{x} is considered symmetric if |
26 ## @code{norm (@var{x} - @var{x}.', inf) / norm (@var{x}, inf) < @var{tol}}. | 27 ## @code{norm (@var{x} - @var{x}.', inf) / norm (@var{x}, inf) < @var{tol}}. |
27 ## @seealso{size, rows, columns, length, ismatrix, isscalar, | 28 ## @seealso{size, rows, columns, length, ismatrix, isscalar, |
28 ## issquare, isvector} | 29 ## issquare, isvector} |