Mercurial > hg > octave-nkf

annotate scripts/plot/ancestor.m @ 15144:9cc337ced51a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
build: Update OCTAVE_UMFPACK_SEPARATE_SPLIT macro to look for SuiteSparse header file. * acinclude.m4: Update OCTAVE_UMFPACK_SEPARATE_SPLIT macro to look for SuiteSparse header file.
author Rik <rik@octave.org>
date Fri, 10 Aug 2012 12:56:15 -0700
parents 5d3a684236b0
children e0cd6299842c
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: 13141
diff changeset
1 ## Copyright (C) 2007-2012 Michael Goffioul
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
2 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
3 ## This file is part of Octave.
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
4 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
6 ## under the terms of the GNU General Public License as published by
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
13 ## General Public License for more details.
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
14 ##
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6851
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
18
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 10661
diff changeset
20 ## @deftypefn {Function File} {@var{parent} =} ancestor (@var{h}, @var{type})
14359
7277fe922e99 doc: Use Octave preference for double quote in docstrings in scripts/
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
21 ## @deftypefnx {Function File} {@var{parent} =} ancestor (@var{h}, @var{type}, "toplevel")
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
22 ## Return the first ancestor of handle object @var{h} whose type matches
9040
dbd0c77e575e Cleanup documentation file plot.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
23 ## @var{type}, where @var{type} is a character string. If @var{type} is a
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
24 ## cell array of strings, return the first parent whose type matches
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
25 ## any of the given type strings.
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
26 ##
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
27 ## If the handle object @var{h} is of type @var{type}, return @var{h}.
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
28 ##
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
29 ## If @code{"toplevel"} is given as a 3rd argument, return the highest
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
30 ## parent in the object hierarchy that matches the condition, instead
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
31 ## of the first (nearest) one.
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
32 ## @seealso{get, set}
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
33 ## @end deftypefn
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
34
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
35 function p = ancestor (h, type, toplevel)
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
36
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
37 if (nargin == 2 || nargin == 3)
10661
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
38 p = cell (numel (h), 1);
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
39 if (ischar (type))
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
40 type = { type };
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
41 endif
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
42 if (iscellstr (type))
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
43 look_first = true;
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
44 if (nargin == 3)
8190
73d6b71788c0 use case-insensitive comparison for graphics properties; misc style fixes
John W. Eaton <jwe@octave.org>
parents: 7016
diff changeset
45 if (ischar (toplevel) && strcmpi (toplevel, "toplevel"))
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
46 look_first = false;
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
47 else
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
48 error ("ancestor: third argument must be \"toplevel\"");
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
49 endif
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
50 endif
10661
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
51 h = num2cell (h);
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14363
diff changeset
52 for nh = 1:numel (h)
10661
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
53 while (true)
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
54 if (isempty (h{nh}) || ! ishandle (h{nh}))
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
55 break;
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
56 endif
10661
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
57 if (any (strcmpi (get (h{nh}, "type"), type)))
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
58 p{nh} = h{nh};
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
59 if (look_first)
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
60 break;
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
61 endif
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
62 endif
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
63 h{nh} = get (h{nh}, "Parent");
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
64 endwhile
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
65 endfor
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
66 if (nh == 1)
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
67 p = p{1};
3df114a44da3 ancestor.m: Support vectors of handles.
Ben Abbott <bpabbott@mac.com>
parents: 10549
diff changeset
68 endif
6851
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
69 else
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
70 error ("ancestor: second argument must be a string or cell array of strings");
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
71 endif
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
72 else
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
73 print_usage ();
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
74 endif
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
75
05f6f120a65f [project @ 2007-08-31 17:58:00 by jwe]
jwe
parents:
diff changeset
76 endfunction
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
77
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14359
diff changeset
78
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
79 %!test
13124
2ea1658ad049 Don't use explicit figure number for tests to avoid interference with any figures opened by user.
Kai Habel <kai.habel@gmx.de>
parents: 13096
diff changeset
80 %! hf = figure ("visible", "off");
13141
e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 13124
diff changeset
81 %! unwind_protect
13096
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
82 %! l = line;
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
83 %! assert (ancestor (l, "axes"), gca);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
84 %! assert (ancestor (l, "figure"), hf);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
85 %! unwind_protect_cleanup
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
86 %! close (hf);
5553412c6614 Tests for scripts/plot
Kai Habel <kai.habel@gmx.de>
parents: 11523
diff changeset
87 %! end_unwind_protect
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14359
diff changeset
88