Mercurial > octave-nkf

annotate scripts/miscellaneous/getfield.m @ 18533:ea0d4dea1a17 stable

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Update documentation for functions in octave-value dir. * ov-bool-mat.cc (Flogical): Document that input must be numeric. Document incompatibility with Matlab regarding complex inputs. * ov-cell.cc (Fcell): Add seealso references. * ov-cell.cc (Fcellstr): Document that trailing spaces are trimmed. Add seealso references. * ov-cell.cc (Fstruct2cell): Use lowercase names in @var references. * ov-class.cc (Fismethod): Add seealso reference to isprop. * ov-class.cc (Fsuperiorto): Add seealso reference to inferiorto. * ov-class.cc (Finferiorto): Add seealso reference to superiorto. * ov-fcn-handle.cc (Ffunctions): Add table to documentation describing return values. * ov-fcn-handle.cc (Ffunc2str): Add seealso links to str2func, functions. * ov-fcn-handle.cc (Fstr2func): Add seealso links to func2str, inline. * ov-fcn-handle.cc (Fis_function_handle): Add seealso links to functions. * ov-fcn-inline.cc (Finline): Add note that the use of inline is discouraged. Add seealso link to str2func. * ov-int16.cc (Fint16): Add seealso links to docstring. * ov-int32.cc (Fint32): Add seealso links to docstring. * ov-int64.cc (Fint64): Add seealso links to docstring. * ov-int8.cc (Fint8): Add seealso links to docstring. * ov-oncleanup.cc (FonCleanup): clarify docstring by using "function" rather than "action" for what gets called when onCleanup object is destroyed. * ov-struct.cc (Fstruct): Add additional calling forms. Add seealso links. * ov-struct.cc (Fisfield): Add additional calling forms. Add seealso link. * ov-struct.cc (Fnfields): Add seealso link. * ov-struct.cc (Fcell2struct): Add additional calling forms. Add seealso link. * ov-struct.cc (Frmfield): Emphasize that a copy of the struct is returned. Add seealso link. * ov-struct.cc (Fstruct_levels_to_print): Add seealso link to print_struct_array_contents. * ov-struct.cc (Fprint_struct_array_contents): Add seealso link to struct_levels_to_print. * ov-typeinfo.cc (Ftypeinfo): Add seealso links to class, isa. * ov-uint16.cc (Fuint16): Add seealso links to docstring. * ov-uint32.cc (Fuint32): Add seealso links to docstring. * ov-uint64.cc (Fuint64): Add seealso links to docstring. * ov-uint8.cc (Fuint8): Add seealso links to docstring. * ov-usr-fcn.cc (Fnargin): Add example based on 'union' function. * ov-usr-fcn.cc (Fnargout): Add example based on 'imread' function. * ov-usr-fcn.cc (Foptimize_subsasgn_calls): Improve docstring. * ov.cc (Fsubsref): Rephrase one sentence. * fieldnames.m: Add more functions to seealso links. * getfield.m: Re-order seealso links. * setfield.m: Re-order seealso links. * isprop.m Add ismethod, isobject to seealso links.
author Rik <rik@octave.org>
date Sat, 01 Mar 2014 21:50:13 -0800
parents d63878346099
children 1fa328da03ef
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 16816
diff changeset
1 ## Copyright (C) 2000-2013 Etienne Grossmann
9849
87fd803c583b rewrite getfield and setfield
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
2 ## Copyright (C) 2009 VZLU Prague
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
3 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
4 ## This file is part of Octave.
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
5 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
6 ## Octave is free software; you can redistribute it and/or modify it
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
7 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6713
diff changeset
8 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6713
diff changeset
9 ## your option) any later version.
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
10 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
11 ## Octave is distributed in the hope that it will be useful, but
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
14 ## General Public License for more details.
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
15 ##
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
16 ## 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: 6713
diff changeset
17 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6713
diff changeset
18 ## <http://www.gnu.org/licenses/>.
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
19
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
16816
12005245b645 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 15615
diff changeset
21 ## @deftypefn {Function File} {[@var{val}] =} getfield (@var{s}, @var{field})
15615
808e4f13e220 doc: Update struct documentation to match new indexing rules
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14363
diff changeset
22 ## @deftypefnx {Function File} {[@var{val}] =} getfield (@var{s}, @var{idx1}, @var{field1}, @var{idx2}, @var{field2}, @dots{})
16816
12005245b645 doc: Periodic grammarcheck of documentation.
Rik <rik@octave.org>
parents: 15615
diff changeset
23 ## Extract a field from a structure (or a nested structure). The syntax
15615
808e4f13e220 doc: Update struct documentation to match new indexing rules
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14363
diff changeset
24 ## is the same as @code{setfield}, except it omits the final @var{val}
808e4f13e220 doc: Update struct documentation to match new indexing rules
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14363
diff changeset
25 ## argument, returning this value instead of setting it.
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
26 ##
18533
ea0d4dea1a17 doc: Update documentation for functions in octave-value dir.
Rik <rik@octave.org>
parents: 17744
diff changeset
27 ## @seealso{setfield, rmfield, isfield, fieldnames, isstruct, struct}
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
28 ## @end deftypefn
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
29
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
30 ## Author: Etienne Grossmann <etienne@cs.uky.edu>
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
31
9849
87fd803c583b rewrite getfield and setfield
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
32 function obj = getfield (s, varargin)
87fd803c583b rewrite getfield and setfield
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
33 if (nargin < 2)
87fd803c583b rewrite getfield and setfield
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
34 print_usage ();
87fd803c583b rewrite getfield and setfield
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
35 endif
87fd803c583b rewrite getfield and setfield
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
36 subs = varargin;
12931
cefd568ea073 Replace function handles with function names in cellfun calls for 15% speedup.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
37 flds = cellfun ("isclass", subs, "char");
cefd568ea073 Replace function handles with function names in cellfun calls for 15% speedup.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
38 idxs = cellfun ("isclass", subs, "cell");
9849
87fd803c583b rewrite getfield and setfield
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
39 if (all (flds | idxs))
87fd803c583b rewrite getfield and setfield
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
40 typs = merge (flds, {"."}, {"()"});
87fd803c583b rewrite getfield and setfield
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
41 obj = subsref (s, struct ("type", typs, "subs", subs));
87fd803c583b rewrite getfield and setfield
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
42 else
87fd803c583b rewrite getfield and setfield
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
43 error ("getfield: invalid index");
87fd803c583b rewrite getfield and setfield
Jaroslav Hajek <highegg@gmail.com>
parents: 9051
diff changeset
44 endif
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
45 endfunction
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
46
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
47
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
48 %!test
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
49 %! x.a = "hello";
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
50 %! assert (getfield (x, "a"), "hello");
5820
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
51 %!test
27c966e4b2dc [project @ 2006-05-17 21:00:54 by jwe]
jwe
parents:
diff changeset
52 %! ss(1,2).fd(3).b = 5;
14363
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
53 %! assert (getfield (ss,{1,2},"fd",{3},"b"), 5);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks
Rik <octave@nomad.inbox5.com>
parents: 14327
diff changeset
54