Mercurial > octave-nkf
view scripts/general/issymmetric.m @ 8828:8463d1a2e544
Doc fixes.
* 2]$$. => 2].$$
* @var{extrapval} => @var{extrapval}.
* call helloworld.oct => called @file{helloworld.oct}
* @itemize => @table @code
* shows. => shows:
* save => @code{save}
* @ref{Breakpoints} => @pxref{Breakpoints}
* add @noindent following example
* which is computed => and compute it
* clarify wording
* remove comma
* good => well
* set => number
* by writing => with the command
* has the option of directly calling => can call
* [-like-] {+of the right size,+}
* solvers => routines
* handle => test for
* add introductory section
* add following
* {+the+} [0..bitmax] => [0,bitmax]
* of the => with
* number => value
* add usual
* Besides when doing comparisons, logical => Logical {+also+}
* array comparison => array, comparisons
* param => parameter
* works very similar => is similar
* strings, => strings
* most simple => simplest
* easier => more easily
* like => as
* called => called,
* clarify wording
* you should simply type => use
* clarify wording
* means => way
* equally => also
* [-way much-] {+way+}
* add with mean value parameter given by the first argument, @var{l}
* add Functions described as @dfn{mapping functions} apply the given
operation to each element when given a matrix argument.
* in this brief introduction => here
* It is worth noticing => Note
* add following
* means => ways
author | Brian Gough <bjg@network-theory.co.uk> |
---|---|
date | Fri, 20 Feb 2009 11:17:01 -0500 |
parents | 6f2d95255911 |
children | eb63fbe60fab |
line wrap: on
line source
## Copyright (C) 1996, 1997, 2002, 2003, 2004, 2005, 2006, 2007 ## John W. Eaton ## ## This file is part of Octave. ## ## Octave is free software; you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation; either version 3 of the License, or (at ## your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU ## General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <http://www.gnu.org/licenses/>. ## -*- texinfo -*- ## @deftypefn {Function File} {} issymmetric (@var{x}, @var{tol}) ## If @var{x} is symmetric within the tolerance specified by @var{tol}, ## then return the dimension of @var{x}. Otherwise, return 0. If ## @var{tol} is omitted, use a tolerance equal to the machine precision. ## Matrix @var{x} is considered symmetric if ## @code{norm (@var{x} - @var{x}.', inf) / norm (@var{x}, inf) < @var{tol}}. ## @seealso{size, rows, columns, length, ismatrix, isscalar, ## issquare, isvector} ## @end deftypefn ## Author: A. S. Hodel <scotte@eng.auburn.edu> ## Created: August 1993 ## Adapted-By: jwe function retval = issymmetric (x, tol) if (nargin == 1 || nargin == 2) retval = issquare (x); if (retval != 0) if (nargin == 1) if (isa (x, "single")) tol = eps("single"); else tol = eps; endif endif norm_x = norm (x, inf); if (norm_x != 0 && norm (x - x', inf) / norm_x > tol) retval = 0; endif endif else print_usage (); endif endfunction %!assert(issymmetric (1)); %!assert(!(issymmetric ([1, 2]))); %!assert(!(issymmetric ([]))); %!assert(issymmetric ([1, 2; 2, 1]) == 2); %!assert(!(issymmetric ("test"))); %!assert(issymmetric ([1, 2.1; 2, 1.1], 0.2) == 2); %!assert(issymmetric ([1, 2i; -2i, 1])); %!assert(!(issymmetric ("t"))); %!assert(!(issymmetric (["te"; "et"]))); %!error issymmetric ([1, 2; 2, 1], 0, 0); %!error issymmetric (); %!test %! s.a = 1; %! assert(!(issymmetric (s)));