Mercurial > octave

comparison scripts/linear-algebra/issymmetric.m @ 25228:581d3a13d7e2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
ishermitian.m, issymmetric.m: Use @tcode macro in docstring (bug #53556). * ishermitian.m, issymmetric.m: Use @tcode macro in docstring for code sequences that end with a transpose operator.
author Rik <rik@octave.org>
date Thu, 12 Apr 2018 09:10:33 -0700
parents a937ffe7dfd9
children 0d755097d73f
comparison
equal deleted inserted replaced
25227:a937ffe7dfd9 25228:581d3a13d7e2
30 ## The type of symmetry to check may be specified with the additional input 30 ## The type of symmetry to check may be specified with the additional input
31 ## @qcode{"nonskew"} (default) for regular symmetry or @qcode{"skew"} for 31 ## @qcode{"nonskew"} (default) for regular symmetry or @qcode{"skew"} for
32 ## skew-symmetry. 32 ## skew-symmetry.
33 ## 33 ##
34 ## Background: A matrix is symmetric if the transpose of the matrix is equal 34 ## Background: A matrix is symmetric if the transpose of the matrix is equal
35 ## to the original matrix: @w{@code{@var{A} == @var{A}.'}}. If a tolerance 35 ## to the original matrix: @w{@tcode{@var{A} == @var{A}.'}}. If a tolerance
36 ## is given then symmetry is determined by 36 ## is given then symmetry is determined by
37 ## @code{norm (@var{A} - @var{A}.', Inf) / norm (@var{A}, Inf) < @var{tol}}. 37 ## @code{norm (@var{A} - @var{A}.', Inf) / norm (@var{A}, Inf) < @var{tol}}.
38 ## 38 ##
39 ## A matrix is skew-symmetric if the transpose of the matrix is equal to the 39 ## A matrix is skew-symmetric if the transpose of the matrix is equal to the
40 ## negative of the original matrix: @w{@code{@var{A} == -@var{A}.'}}. If a 40 ## negative of the original matrix: @w{@tcode{@var{A} == -@var{A}.'}}. If a
41 ## tolerance is given then skew-symmetry is determined by 41 ## tolerance is given then skew-symmetry is determined by
42 ## @code{norm (@var{A} + @var{A}.', Inf) / norm (@var{A}, Inf) < @var{tol}}. 42 ## @code{norm (@var{A} + @var{A}.', Inf) / norm (@var{A}, Inf) < @var{tol}}.
43 ## @seealso{ishermitian, isdefinite} 43 ## @seealso{ishermitian, isdefinite}
44 ## @end deftypefn 44 ## @end deftypefn
45 45