octave_packages/m/miscellaneous/setfield.m

   1 ## Copyright (C) 2000-2012 Etienne Grossmann
   2 ## Copyright (C) 2009 VZLU Prague
   3 ##
   4 ## This file is part of Octave.
   5 ##
   6 ## Octave is free software; you can redistribute it and/or modify it
   7 ## under the terms of the GNU General Public License as published by
   8 ## the Free Software Foundation; either version 3 of the License, or (at
   9 ## your option) any later version.
  10 ##
  11 ## Octave is distributed in the hope that it will be useful, but
  12 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 ## General Public License for more details.
  15 ##
  16 ## You should have received a copy of the GNU General Public License
  17 ## along with Octave; see the file COPYING.  If not, see
  18 ## <http://www.gnu.org/licenses/>.
  19
  20 ## -*- texinfo -*-
  21 ## @deftypefn {Function File} {[@var{k1}, @dots{}, @var{v1}] =} setfield (@var{s}, @var{k1}, @var{v1}, @dots{})
  22 ## Set a field member in a (nested) structure array.  For example:
  23 ##
  24 ## @example
  25 ## @group
  26 ## oo(1,1).f0 = 1;
  27 ## oo = setfield (oo, @{1,2@}, "fd", @{3@}, "b", 6);
  28 ## oo(1,2).fd(3).b == 6
  29 ##      @result{} ans = 1
  30 ## @end group
  31 ## @end example
  32 ##
  33 ## Note that the same result as in the above example could be achieved by:
  34 ##
  35 ## @example
  36 ## @group
  37 ## i1 = @{1,2@}; i2 = "fd"; i3 = @{3@}; i4 = "b";
  38 ## oo(i1@{:@}).(i2)(i3@{:@}).(i4) == 6
  39 ##      @result{} ans = 1
  40 ## @end group
  41 ## @end example
  42 ## @seealso{getfield, rmfield, isfield, isstruct, fieldnames, struct}
  43 ## @end deftypefn
  44
  45 ## Author:  Etienne Grossmann <etienne@cs.uky.edu>
  46
  47 function obj = setfield (obj, varargin)
  48   if (nargin < 3)
  49     print_usage ();
  50   endif
  51   subs = varargin(1:end-1);
  52   rhs = varargin{end};
  53   flds = cellfun ("isclass", subs, "char");
  54   idxs = cellfun ("isclass", subs, "cell");
  55   if (all (flds | idxs))
  56     typs = merge (flds, {"."}, {"()"});
  57     obj = subsasgn (obj, struct ("type", typs, "subs", subs), rhs);
  58   else
  59     error ("setfield: invalid index");
  60   endif
  61 endfunction
  62
  63 %!test
  64 %! x.a = "hello";
  65 %! x = setfield(x,"b","world");
  66 %! y = struct("a","hello","b","world");
  67 %! assert(x,y);
  68 %!test
  69 %! oo(1,1).f0= 1;
  70 %! oo = setfield(oo,{1,2},"fd",{3},"b", 6);
  71 %! assert (oo(1,2).fd(3).b, 6)