Mercurial > octave

comparison scripts/linear-algebra/ishermitian.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 5cef57130cb9
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 Hermitian or @qcode{"skew"} for 31 ## @qcode{"nonskew"} (default) for regular Hermitian or @qcode{"skew"} for
32 ## skew-Hermitian. 32 ## skew-Hermitian.
33 ## 33 ##
34 ## Background: A matrix is Hermitian if the complex conjugate transpose of the 34 ## Background: A matrix is Hermitian if the complex conjugate transpose of the
35 ## matrix is equal to the original matrix: @w{@code{@var{A} == @var{A}'}}. If 35 ## matrix is equal to the original matrix: @w{@tcode{@var{A} == @var{A}'}}. If
36 ## a tolerance is given then the calculation is 36 ## a tolerance is given then the calculation is
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-hermitian if the complex conjugate transpose of the matrix 39 ## A matrix is skew-hermitian if the complex conjugate transpose of the matrix
40 ## is equal to the negative of the original matrix: 40 ## is equal to the negative of the original matrix:
41 ## @w{@code{@var{A} == -@var{A}'}}. If a 41 ## @w{@tcode{@var{A} == -@var{A}'}}. If a
42 ## tolerance is given then the calculation is 42 ## tolerance is given then the calculation is
43 ## @code{norm (@var{A} + @var{A}', Inf) / norm (@var{A}, Inf) < @var{tol}}. 43 ## @code{norm (@var{A} + @var{A}', Inf) / norm (@var{A}, Inf) < @var{tol}}.
44 ## @seealso{issymmetric, isdefinite} 44 ## @seealso{issymmetric, isdefinite}
45 ## @end deftypefn 45 ## @end deftypefn
46 46