Mercurial > hg > octave-lyh
annotate scripts/plot/zlabel.m @ 16950:b34202b24212
fplot.m: Overhaul function for Matlab compatibility and performance (bug #38961).
* scripts/plot/fplot.m: Add ability to specify n,tol,fmt in any order and
simultaneously. Return data rather than plotting it if asked. Use
additional test on progress of algorithm to decide whether to quit. Add
%!demo and %!tests.
author | Rik <rik@octave.org> |
---|---|
date | Thu, 11 Jul 2013 09:25:54 -0700 |
parents | 72c96de7a403 |
children | 3f99d7d22bd0 |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
14001
diff
changeset
|
1 ## Copyright (C) 1995-2012 John W. Eaton |
2313 | 2 ## |
3 ## This file is part of Octave. | |
4 ## | |
5 ## Octave is free software; you can redistribute it and/or modify it | |
6 ## under the terms of the GNU General Public License as published by | |
7016 | 7 ## the Free Software Foundation; either version 3 of the License, or (at |
8 ## your option) any later version. | |
2313 | 9 ## |
10 ## Octave is distributed in the hope that it will be useful, but | |
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 ## General Public License for more details. | |
14 ## | |
15 ## You should have received a copy of the GNU General Public License | |
7016 | 16 ## along with Octave; see the file COPYING. If not, see |
17 ## <http://www.gnu.org/licenses/>. | |
1540 | 18 |
3458 | 19 ## -*- texinfo -*- |
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
8920
diff
changeset
|
20 ## @deftypefn {Function File} {} zlabel (@var{string}) |
7194 | 21 ## @deftypefnx {Function File} {} zlabel (@var{h}, @var{string}) |
11315
c715816f4539
Add additional calling form to docstring for [xyz]label functions.
Rik <octave@nomad.inbox5.com>
parents:
11152
diff
changeset
|
22 ## @deftypefnx {Function File} {@var{h} =} zlabel (@dots{}) |
11152
39ae406df598
Improve docstrings for functions found in undocumented list.
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
23 ## @seealso{xlabel} |
3458 | 24 ## @end deftypefn |
3368 | 25 |
6257 | 26 ## Author: jwe |
1540 | 27 |
7215 | 28 function retval = zlabel (varargin) |
4529 | 29 |
7215 | 30 [h, varargin, nargin] = __plt_get_axis_arg__ ("zlabel", varargin{:}); |
31 | |
32 if (rem (nargin, 2) != 1) | |
33 print_usage (); | |
7194 | 34 endif |
35 | |
13800
5acb5c25e4ae
allow axes handle to be passed to title function
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
36 tmp = __axis_label__ (h, "zlabel", varargin{:}, |
5acb5c25e4ae
allow axes handle to be passed to title function
John W. Eaton <jwe@octave.org>
parents:
13141
diff
changeset
|
37 "color", get (h, "zcolor")); |
7215 | 38 |
7194 | 39 if (nargout > 0) |
7425 | 40 retval = tmp; |
4529 | 41 endif |
1540 | 42 |
43 endfunction | |
13136
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
44 |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13800
diff
changeset
|
45 |
13136
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
46 %!test |
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
47 %! hf = figure ("visible", "off"); |
13141
e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
13136
diff
changeset
|
48 %! unwind_protect |
13136
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
49 %! z = zlabel ("zlabel_string"); |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13800
diff
changeset
|
50 %! assert (get (gca, "zlabel"), z); |
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13800
diff
changeset
|
51 %! assert (get (z, "type"), "text"); |
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13800
diff
changeset
|
52 %! assert (get (z, "visible"), "off"); |
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13800
diff
changeset
|
53 %! assert (get (z, "string"), "zlabel_string"); |
13136
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
54 %! unwind_protect_cleanup |
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
55 %! close (hf); |
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
56 %! end_unwind_protect |
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
57 |
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
58 %!test |
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
59 %! hf = figure ("visible", "off"); |
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
60 %! plot3 (0, 0, 0); |
13141
e81ddf9cacd5
maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents:
13136
diff
changeset
|
61 %! unwind_protect |
13136
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
62 %! z = zlabel ("zlabel_string"); |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13800
diff
changeset
|
63 %! assert (get (gca, "zlabel"), z); |
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13800
diff
changeset
|
64 %! assert (get (z, "type"), "text"); |
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13800
diff
changeset
|
65 %! assert (get (z, "visible"), "off"); |
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13800
diff
changeset
|
66 %! assert (get (z, "string"), "zlabel_string"); |
13136
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
67 %! unwind_protect_cleanup |
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
68 %! close (hf); |
79b9a7669bb8
Tests added for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents:
11598
diff
changeset
|
69 %! end_unwind_protect |
14001
5f0bb45e615c
doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents:
13800
diff
changeset
|
70 |