Mercurial > octave-antonio

comparison scripts/linear-algebra/issymmetric.m @ 20160:03b9d17a2d95 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
20159:597991b19e40 20160:03b9d17a2d95
22 ## @deftypefnx {Function File} {} issymmetric (@var{A}, @var{tol}) 22 ## @deftypefnx {Function File} {} issymmetric (@var{A}, @var{tol})
23 ## Return true if @var{A} is a symmetric matrix within the tolerance specified 23 ## Return true if @var{A} is a symmetric matrix within the tolerance specified
24 ## by @var{tol}. 24 ## by @var{tol}.
25 ## 25 ##
26 ## The default tolerance is zero (uses faster code). 26 ## The default tolerance is zero (uses faster code).
27 ##
27 ## Matrix @var{A} is considered symmetric if 28 ## Matrix @var{A} is considered symmetric if
28 ## @code{norm (@var{A} - @var{A}.', Inf) / norm (@var{A}, Inf) < @var{tol}}. 29 ## @code{norm (@var{A} - @var{A}.', Inf) / norm (@var{A}, Inf) < @var{tol}}.
29 ## @seealso{ishermitian, isdefinite} 30 ## @seealso{ishermitian, isdefinite}
30 ## @end deftypefn 31 ## @end deftypefn
31 32