Home > freetb4matlab > general > issymmetric.m

issymmetric

PURPOSE ^

% If @var{x} is symmetric within the tolerance specified by @var{tol},

SYNOPSIS ^

function retval = issymmetric (x, tol)

DESCRIPTION ^

% -*- 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

CROSS-REFERENCE INFORMATION ^

This function calls: This function is called by:
Generated on Sat 16-May-2009 00:04:49 by m2html © 2003