Mercurial > octave
view scripts/miscellaneous/setfield.m @ 27978:a4268efb7334
maint: Eliminate single "Author:" lines from code base.
* color-picker.cc, color-picker.h, octave-qscintilla.cc, octave-qscintilla.h,
octave-txt-lexer.cc, octave-txt-lexer.h, balance.cc, kron.cc, lookup.cc,
ls-hdf5.cc, ls-mat5.cc, ls-oct-text.cc, sylvester.cc, tsearch.cc, jit-ir.cc,
jit-ir.h, jit-typeinfo.cc, jit-typeinfo.h, jit-util.cc, jit-util.h, pt-jit.cc,
pt-jit.h, Array-jit.cc, bsxfun.h, url-transfer.cc, url-transfer.h, acosd.m,
acotd.m, acscd.m, asecd.m, asind.m, atand.m, cosd.m, cotd.m, cscd.m, secd.m,
sind.m, tand.m, cart2pol.m, cart2sph.m, curl.m, del2.m, divergence.m, flip.m,
pol2cart.m, randi.m, sortrows.m, sph2cart.m, griddata3.m, griddatan.m,
rectint.m, voronoi.m, dialog.m, guidata.m, guihandles.m, __file_filter__.m,
__fltk_file_filter__.m, __get_funcname__.m, __is_function__.m,
__uigetdir_fltk__.m, __uigetfile_fltk__.m, __uiobject_split_args__.m,
__uiputfile_fltk__.m, uibuttongroup.m, uicontextmenu.m, uicontrol.m,
uigetdir.m, uigetfile.m, uimenu.m, uipanel.m, uipushtool.m, uiputfile.m,
uiresume.m, uitoggletool.m, uitoolbar.m, uiwait.m, doc.m, autumn.m, bone.m,
cmpermute.m, cmunique.m, cool.m, copper.m, cubehelix.m, flag.m, frame2im.m,
hot.m, hsv.m, hsv2rgb.m, im2frame.m, imfinfo.m, imformats.m, iscolormap.m,
jet.m, pink.m, prism.m, __imfinfo__.m, rainbow.m, rgb2hsv.m, spinmap.m,
spring.m, viridis.m, white.m, winter.m, importdata.m, strmatch.m, bandwidth.m,
isbanded.m, isdiag.m, istril.m, istriu.m, krylov.m, linsolve.m, logm.m,
lscov.m, subspace.m, bunzip2.m, compare_versions.m, edit.m, fullfile.m,
getfield.m, gunzip.m, inputParser.m, license.m, nargchk.m, narginchk.m,
nthargout.m, python.m, setfield.m, tar.m, unpack.m, ver.m, zip.m, odeplot.m,
fminbnd.m, fminunc.m, fsolve.m, fzero.m, glpk.m, humps.m, pathdef.m,
savepath.m, diffuse.m, lighting.m, material.m, shading.m, specular.m,
contour.m, ellipsoid.m, isocaps.m, isocolors.m, isonormals.m, isosurface.m,
light.m, pcolor.m, __interp_cube__.m, __marching_cube__.m, __patch__.m,
__stem__.m, reducepatch.m, reducevolume.m, ribbon.m, shrinkfaces.m, slice.m,
stem.m, surf.m, surfl.m, tetramesh.m, waterfall.m, __actual_axis_position__.m,
__next_line_color__.m, allchild.m, figure.m, findall.m, findobj.m, gcf.m,
hggroup.m, isprop.m, ndgrid.m, __add_default_menu__.m, saveas.m,
__splinefit__.m, prefdir.m, preferences.m, profexplore.m, profexport.m,
profile.m, profshow.m, setdiff.m, freqz.m, freqz_plot.m, sinc.m, unwrap.m,
pcr.m, qmr.m, sprandn.m, betaincinv.m, cosint.m, ellipke.m, factor.m,
gammaincinv.m, legendre.m, nchoosek.m, primes.m, invhilb.m, toeplitz.m,
erase.m, mat2str.m, strtrim.m, validatestring.m, fail.m, compare_plot_demos.m,
dump_demos.m, html_compare_plot_demos.m, addtodate.m, datenum.m, jit.tst:
Eliminate single "Author:" lines from code base.
author | Rik <rik@octave.org> |
---|---|
date | Tue, 21 Jan 2020 12:53:13 -0800 |
parents | bd51beb6205e |
children | 90fea9cc9caa 0a5b15007766 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2000-2020 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## This file is part of Octave. ## ## Octave is free software: you can redistribute it and/or modify it ## under the terms of the GNU General Public License as published by ## the Free Software Foundation, either version 3 of the License, or ## (at your option) any later version. ## ## Octave is distributed in the hope that it will be useful, but ## WITHOUT ANY WARRANTY; without even the implied warranty of ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the ## GNU General Public License for more details. ## ## You should have received a copy of the GNU General Public License ## along with Octave; see the file COPYING. If not, see ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{sout} =} setfield (@var{s}, @var{field}, @var{val}) ## @deftypefnx {} {@var{sout} =} setfield (@var{s}, @var{sidx1}, @var{field1}, @var{fidx1}, @var{sidx2}, @var{field2}, @var{fidx2}, @dots{}, @var{val}) ## ## Return a @emph{copy} of the structure @var{s} with the field member ## @var{field} set to the value @var{val}. ## ## For example: ## ## @example ## @group ## @var{s} = struct (); ## @var{s} = setfield (@var{s}, "foo bar", 42); ## @end group ## @end example ## ## @noindent ## This is equivalent to ## ## @example ## @var{s}.("foo bar") = 42; ## @end example ## ## @noindent ## Note that ordinary structure syntax @code{@var{s}.foo bar = 42} cannot be ## used here, as the field name is not a valid Octave identifier because of ## the space character. Using arbitrary strings for field names is ## incompatible with @sc{matlab}, and this usage will emit a warning if the ## warning ID @code{Octave:language-extension} is enabled. ## @xref{XREFwarning_ids,,warning_ids}. ## ## With the second calling form, set a field of a structure array. The ## input @var{sidx} selects an element of the structure array, @var{field} ## specifies the field name of the selected element, and @var{fidx} selects ## which element of the field (in the case of an array or cell array). ## The @var{sidx}, @var{field}, and @var{fidx} inputs can be repeated to ## address nested structure array elements. The structure array index and ## field element index must be cell arrays while the field name must be a ## string. ## ## For example: ## ## @example ## @group ## @var{s} = struct ("baz", 42); ## setfield (@var{s}, @{1@}, "foo", @{1@}, "bar", 54) ## @result{} ## ans = ## scalar structure containing the fields: ## baz = 42 ## foo = ## scalar structure containing the fields: ## bar = 54 ## @end group ## @end example ## ## The example begins with an ordinary scalar structure to which a nested ## scalar structure is added. In all cases, if the structure index @var{sidx} ## is not specified it defaults to 1 (scalar structure). Thus, the example ## above could be written more concisely as ## @code{setfield (@var{s}, "foo", "bar", 54)} ## ## Finally, an example with nested structure arrays: ## ## @example ## @group ## @var{sa}.foo = 1; ## @var{sa} = setfield (@var{sa}, @{2@}, "bar", @{3@}, "baz", @{1, 4@}, 5); ## @var{sa}(2).bar(3) ## @result{} ## ans = ## scalar structure containing the fields: ## baz = 0 0 0 5 ## @end group ## @end example ## ## Here @var{sa} is a structure array whose field at elements 1 and 2 is in ## turn another structure array whose third element is a simple scalar ## structure. The terminal scalar structure has a field which contains a ## matrix value. ## ## Note that the same result as in the above example could be achieved by: ## ## @example ## @group ## @var{sa}.foo = 1; ## @var{sa}(2).bar(3).baz(1,4) = 5 ## @end group ## @end example ## @seealso{getfield, rmfield, orderfields, isfield, fieldnames, isstruct, struct} ## @end deftypefn function sout = setfield (s, varargin) if (nargin < 3) print_usage (); endif subs = varargin(1:end-1); val = varargin{end}; flds = cellfun ("isclass", subs, "char"); idxs = cellfun ("isclass", subs, "cell"); if (! all (flds | idxs)) error ("setfield: invalid index"); endif typs = ifelse (flds, {"."}, {"()"}); sout = subsasgn (s, struct ("type", typs, "subs", subs), val); endfunction %!test %! x.a = "hello"; %! x = setfield (x, "b", "world"); %! y = struct ("a", "hello", "b", "world"); %! assert (x, y); %!test %! oo(1,1).f0 = 1; %! oo = setfield (oo,{1,2},"fd",{3},"b", {1,4}, 6); %! assert (oo(1,2).fd(3).b(1,4), 6); ## Test input validation %!error setfield () %!error setfield (1) %!error setfield (1,2) %!error <invalid index> setfield (1,2,3)