Home > freetb4matlab > plot > compass.m

compass

PURPOSE ^

%

SYNOPSIS ^

function retval = compass (varargin)

DESCRIPTION ^

% -*- texinfo -*-
% @deftypefn {Function File} {} compass (@var{u}, @var{v})
% @deftypefnx {Function File} {} compass (@var{z})
% @deftypefnx {Function File} {} compass (@dots{}, @var{style})
% @deftypefnx {Function File} {} compass (@var{h}, @dots{})
% @deftypefnx {Function File} {@var{h} =} compass (@dots{})
%
% Plot the @code{(@var{u}, @var{v})} components of a vector field emanating
% from the origin of a polar plot.  If a single complex argument @var{z} is 
% given, then @code{@var{u} = real (@var{z})} and @code{@var{v} = imag 
% (@var{z})}.
%
% The style to use for the plot can be defined with a line style @var{style}
% in a similar manner to the line styles used with the @code{plot} command.
%
% The optional return value @var{h} provides a list of handles to the 
% the parts of the vector field (body, arrow and marker).
%
% @example
% @group
% a = toeplitz([1;randn(9,1)],[1,randn(1,9)]);
% compass (eig (a))
% @end group
% @end example
%
% @seealso{plot, polar, quiver, feather}
% @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