annotate scripts/plot/gcbo.m @ 17211:87ba70043bfc

Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations. * scripts/plot/area.m, scripts/plot/axis.m, scripts/plot/caxis.m, scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m, scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourf.m, scripts/plot/cylinder.m, scripts/plot/ellipsoid.m, scripts/plot/errorbar.m, scripts/plot/feather.m, scripts/plot/fill.m, scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m, scripts/plot/pcolor.m, scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m, scripts/plot/plot3.m, scripts/plot/polar.m, scripts/plot/private/__bar__.m, scripts/plot/private/__ezplot__.m, scripts/plot/private/__stem__.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/ribbon.m, scripts/plot/rose.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/slice.m, scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m, scripts/plot/surfnorm.m, scripts/time/datetick.m: Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
author Rik <rik@octave.org>
date Fri, 09 Aug 2013 19:26:55 -0700
parents eaab03308c0b
children bc924baa2c4e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 13123
diff changeset
1 ## Copyright (C) 2008-2012 Michael Goffioul
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
2 ##
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
3 ## This file is part of Octave.
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
4 ##
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
8 ## your option) any later version.
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
9 ##
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
13 ## General Public License for more details.
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
14 ##
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
18
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
20 ## @deftypefn {Function File} {@var{h} =} gcbo ()
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
21 ## @deftypefnx {Function File} {[@var{h}, @var{fig}] =} gcbo ()
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
22 ## Return a handle to the object whose callback is currently executing.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
23 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
24 ## If no callback is executing, this function returns the empty matrix. This
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
25 ## handle is obtained from the root object property "CallbackObject".
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
26 ##
16808
772f51539af8 doc: Add gco() to documentation.
Rik <rik@octave.org>
parents: 14363
diff changeset
27 ## When called with a second output argument, return the handle of the figure
772f51539af8 doc: Add gco() to documentation.
Rik <rik@octave.org>
parents: 14363
diff changeset
28 ## containing the object whose callback is currently executing. If no callback
772f51539af8 doc: Add gco() to documentation.
Rik <rik@octave.org>
parents: 14363
diff changeset
29 ## is executing the second output is also set to the empty matrix.
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
30 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
31 ## @seealso{gcbf, gco, gca, gcf, get, set}
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 16808
diff changeset
32 ## @end deftypefn
7935
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
33
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
34 function [h, fig] = gcbo ()
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
35
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
36 h = get (0, "callbackobject");
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
37 fig = [];
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
38
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
39 if (! isempty (h) && nargout > 1)
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
40 fig = ancestor (h, "figure");
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
41 endif
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
42
85d6296d51e1 Add gcbo/gcbf functions.
John W. Eaton <jwe@octave.org>
parents:
diff changeset
43 endfunction
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
44
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
45
13123
6efa1a691713 Add further tests for scripts/plot.
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
46 %!test
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
47 %! assert (isempty (gcbo));
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
48