]> Creatis software - CreaPhase.git/blob - octave_packages/general-1.3.1/@dict/join.m
Add a useful package (from Source forge) for octave
[CreaPhase.git] / octave_packages / general-1.3.1 / @dict / join.m
1 ## Copyright (C) 2009 VZLU Prague, a.s., Czech Republic
2 ##
3 ## This program is free software; you can redistribute it and/or modify it under
4 ## the terms of the GNU General Public License as published by the Free Software
5 ## Foundation; either version 3 of the License, or (at your option) any later
6 ## version.
7 ##
8 ## This program is distributed in the hope that it will be useful, but WITHOUT
9 ## ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 ## FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
11 ## details.
12 ##
13 ## You should have received a copy of the GNU General Public License along with
14 ## this program; if not, see <http://www.gnu.org/licenses/>.
15
16 ## -*- texinfo -*-
17 ## @deftypefn{Function File} {} join (d1, d2, joinop)
18 ## Merges two given dictionaries. For common keys, the function @var{joinop} is
19 ## called to combine the two values. If not supplied, values from d2 are taken.
20 ## @end deftypefn
21
22 ## Author: Jaroslav Hajek <highegg@gmail.com>
23
24 function d = join (d1, d2, jop)
25   if (nargin < 2 || nargin > 3 || ! (isa (d1, "dict") && isa (d2, "dict")))
26     print_usage ();
27   endif
28
29   keys1 = d1.keys;
30   keys2 = d2.keys;
31
32   [keys, idx] = sort ([keys1; keys2]);
33   values = [d1.values; d2.values](idx);
34   n = numel (keys);
35
36   if (n > 1)
37     idx = find (strcmp (keys(1:n-1), keys(2:n)));
38     keys(idx) = [];
39     if (nargin == 3)
40       values(idx+1) = cellfun (jop, values(idx), values(idx+1), "UniformOutput", false);
41     endif
42     values(idx) = [];
43   endif
44
45   d = dict;
46   d.keys = keys;
47   d.values = values;
48
49 endfunction
50