Mercurial > hg > octave-nkf
comparison scripts/plot/fplot.m @ 17122:eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
* doc/interpreter/plot.txi: Add @findex entries that were in xlim.m
* scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m,
scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m,
scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m,
scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m,
scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m,
scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m,
scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m,
scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m,
scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m,
scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m,
scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m,
scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m,
scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m,
scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m,
scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m,
scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m,
scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m,
scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m,
scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m,
scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m,
scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m,
scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m,
scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m,
scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m,
scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m,
scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m,
scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m,
scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m,
scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m,
scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m,
scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m,
scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m,
scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m,
scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m,
scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m,
scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m,
scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m,
scripts/plot/zlim.m: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 31 Jul 2013 13:53:30 -0700 |
parents | be52288f827b |
children | d74e2b5bdeb5 |
comparison
equal
deleted
inserted
replaced
17121:d4549655b92e | 17122:eaab03308c0b |
---|---|
31 ## @code{[@var{xlo}, @var{xhi}, @var{ylo}, @var{yhi}]}. | 31 ## @code{[@var{xlo}, @var{xhi}, @var{ylo}, @var{yhi}]}. |
32 ## The next three arguments are all optional and any number of them may be | 32 ## The next three arguments are all optional and any number of them may be |
33 ## given in any order. | 33 ## given in any order. |
34 ## @var{tol} is the relative tolerance to use for the plot and defaults | 34 ## @var{tol} is the relative tolerance to use for the plot and defaults |
35 ## to 2e-3 (.2%). | 35 ## to 2e-3 (.2%). |
36 ## @var{n} is the minimum number of of points to use. When @var{n} is | 36 ## @var{n} is the minimum number of points to use. When @var{n} is |
37 ## specified, the maximum stepsize will be | 37 ## specified, the maximum stepsize will be |
38 ## @code{@var{xhi} - @var{xlo} / @var{n}}. More than @var{n} points may still | 38 ## @code{@var{xhi} - @var{xlo} / @var{n}}. More than @var{n} points may still |
39 ## be used in order to meet the relative tolerance requirement. | 39 ## be used in order to meet the relative tolerance requirement. |
40 ## The @var{fmt} argument specifies the linestyle to be used by the plot | 40 ## The @var{fmt} argument specifies the linestyle to be used by the plot |
41 ## command. | 41 ## command. |
52 ## fplot ("[cos(x), sin(x)]", [0, 2*pi]) | 52 ## fplot ("[cos(x), sin(x)]", [0, 2*pi]) |
53 ## @end group | 53 ## @end group |
54 ## @end example | 54 ## @end example |
55 ## | 55 ## |
56 ## Note: @code{fplot} works best with continuous functions. Functions with | 56 ## Note: @code{fplot} works best with continuous functions. Functions with |
57 ## discontinuities are unlikely to plot well. This restriction may be | 57 ## discontinuities are unlikely to plot well. This restriction may be removed |
58 ## removed in the future. | 58 ## in the future. |
59 ## @seealso{plot} | 59 ## @seealso{ezplot, plot} |
60 ## @end deftypefn | 60 ## @end deftypefn |
61 | 61 |
62 ## Author: Paul Kienzle <pkienzle@users.sf.net> | 62 ## Author: Paul Kienzle <pkienzle@users.sf.net> |
63 | 63 |
64 function [X, Y] = fplot (fn, limits, varargin) | 64 function [X, Y] = fplot (fn, limits, varargin) |