Mercurial > octave
view scripts/plot/ezplot.m @ 14327:4d917a6a858b stable
doc: Use Octave coding conventions in @example blocks of docstrings.
* accumarray.m, accumdim.m, bar.m, base2dec.m, bincoeff.m, bitcmp.m, bitset.m,
celldisp.m, chop.m, clabel.m, cloglog.m, colon.m, compass.m, computer.m,
contour3.m, contourc.m, corr.m, cstrcat.m, ctime.m, cylinder.m, date.m,
dec2base.m, demo.m, dir.m, dlmwrite.m, expm.m, ezcontourf.m, ezcontour.m,
ezmeshc.m, ezmesh.m, ezplot.m, ezsurfc.m, ezsurf.m, feather.m, findobj.m,
flipdim.m, fplot.m, genvarname.m, getfield.m, hankel.m, hilb.m, hist.m,
idivide.m, index.m, int2str.m, interp1.m, is_leap_year.m, ismember.m,
isocolors.m, isonormals.m, isosurface.m, kurtosis.m, legendre.m, linkprop.m,
logit.m, logm.m, __makeinfo__.m, __marching_cube__.m, median.m, mkoctfile.m,
moment.m, mpoles.m, orderfields.m, pcg.m, pcr.m, plot3.m, plotmatrix.m,
polyaffine.m, polygcd.m, poly.m, polyout.m, print.m, qp.m, quadgk.m, qzhess.m,
randi.m, rat.m, refreshdata.m, residue.m, rose.m, rot90.m, saveas.m, saveobj.m,
shiftdim.m, skewness.m, spaugment.m, spdiags.m, sqp.m, stem.m, str2num.m,
strcat.m, strjust.m, strread.m, strsplit.m, structfun.m, subplot.m,
subsindex.m, substruct.m, surfl.m, surfnorm.m, svds.m, uimenu.m, union.m,
voronoi.m, warning_ids.m, wblpdf.m: Use Octave coding conventions in
@example blocks of docstrings.
author | Rik <octave@nomad.inbox5.com> |
---|---|
date | Sat, 04 Feb 2012 22:12:50 -0800 |
parents | 72c96de7a403 |
children | ce2b59a6d0e5 |
line wrap: on
line source
## Copyright (C) 2008-2012 David Bateman ## ## 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} {} ezplot (@var{f}) ## @deftypefnx {Function File} {} ezplot (@var{fx}, @var{fy}) ## @deftypefnx {Function File} {} ezplot (@dots{}, @var{dom}) ## @deftypefnx {Function File} {} ezplot (@dots{}, @var{n}) ## @deftypefnx {Function File} {} ezplot (@var{h}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} ezplot (@dots{}) ## ## Plot the curve defined by @var{f} in two dimensions. The function ## @var{f} may be a string, inline function or function handle and can ## have either one or two variables. If @var{f} has one variable, then ## the function is plotted over the domain @code{-2*pi < @var{x} < 2*pi} ## with 500 points. ## ## If @var{f} has two variables then @code{@var{f}(@var{x},@var{y}) = 0} ## is calculated over the meshed domain @code{-2*pi < @var{x} | @var{y} ## < 2*pi} with 60 by 60 in the mesh. For example: ## ## @example ## ezplot (@@(@var{x}, @var{y}) @var{x}.^2 - @var{y}.^2 - 1) ## @end example ## ## If two functions are passed as strings, inline functions or function ## handles, then the parametric function ## ## @example ## @group ## @var{x} = @var{fx} (@var{t}) ## @var{y} = @var{fy} (@var{t}) ## @end group ## @end example ## ## @noindent ## is plotted over the domain @code{-2*pi < @var{t} < 2*pi} with 500 ## points. ## ## If @var{dom} is a two element vector, it represents the minimum and maximum ## value of @var{x}, @var{y} and @var{t}. If it is a four element ## vector, then the minimum and maximum values of @var{x} and @var{t} ## are determined by the first two elements and the minimum and maximum ## of @var{y} by the second pair of elements. ## ## @var{n} is a scalar defining the number of points to use in plotting ## the function. ## ## The optional return value @var{h} is a graphics handle to the created plot. ## ## @seealso{plot, ezplot3} ## @end deftypefn function retval = ezplot (varargin) [h, needusage] = __ezplot__ ("plot", varargin{:}); if (needusage) print_usage (); endif if (nargout > 0) retval = h; endif endfunction %!demo %! clf %! ezplot (@cos, @sin) %!demo %! clf %! ezplot ("1/x") %!demo %! clf %! ezplot (inline ("x^2 - y^2 = 1"))