Merge branch 'remove_ref_sets' into 'master'

remove/modify symbols if referenced domain set is removed

Closes #19

See merge request devel/gams-transfer-matlab!35

Author: renkekuhlmann

CHANGELOG

@@ -46,6 +46,8 @@ GAMS Transfer Matlab v0.3.0
   defined by source order (e.g. symbol order in GDX file) rather than user
   supplied order. To establish a custom order after the read, use
   `reorderSymbols`.
+- Aliases are now removed if the aliased set is removed.
+- Domains are now set to `*` (universe) if the domain set is removed.
 - Deprecated `Symbol.getUELLabels`. Use `Symbol.getUELs` instead.
 - Deprecated `Symbol.initUELs`. Use `Symbol.setUELs` instead.
 - Deprecated `Container.getUniverseSet`. Use `Container.getUELs` instead.

src/Container.m

@@ -892,25 +892,46 @@ function removeSymbols(obj, names)
                 names = {names};
             end
 
+            removed_symbols = cell(1, numel(names));
+            j = 0;
+            % remove symbols from data
             for i = 1:numel(names)
                 if ~obj.hasSymbols(names{i})
                     continue;
                 end
-                symbol = obj.getSymbols(names{i});
+                j = j + 1;
+                removed_symbols{j} = obj.getSymbols(names{i});
 
                 % remove symbol
-                obj.data = rmfield(obj.data, symbol.name);
+                obj.data = rmfield(obj.data, removed_symbols{j}.name);
 
                 % force recheck of deleted symbol (it may still live within an
                 % alias, domain or in the user's program)
-                symbol.isValid(false, true);
+                removed_symbols{j}.isValid(false, true);
 
                 % unlink container
-                symbol.unsetContainer();
+                removed_symbols{j}.unsetContainer();
             end
+            removed_symbols = removed_symbols(1:j);
 
-            % force recheck of all remaining symbols in container
-            obj.isValid(false, true);
+            % remove symbols from domain references
+            symbols = fieldnames(obj.data);
+            remove_aliases = {};
+            for i = 1:numel(symbols)
+                symbol = obj.data.(symbols{i});
+                if isa(symbol, 'GAMSTransfer.Alias')
+                    for j = 1:numel(removed_symbols)
+                        if symbol.alias_with.name == removed_symbols{j}.name
+                            remove_aliases{end+1} = symbol.name;
+                        end
+                    end
+                else
+                    symbol.unsetDomain(removed_symbols);
+                end
+            end
+            if numel(remove_aliases) > 0
+                obj.removeSymbols(remove_aliases);
+            end
         end
 
         %> Reestablishes a valid GDX symbol order

src/Symbol.m

@@ -2214,6 +2214,19 @@ function unsetContainer(obj)
             obj.modified = true;
         end
 
+        function unsetDomain(obj, unset_domains)
+            for i = 1:obj.dimension_
+                if ~isa(obj.domain{i}, 'GAMSTransfer.Set') && ~isa(obj.domain{i}, 'GAMSTransfer.Alias')
+                    continue
+                end
+                for j = 1:numel(unset_domains)
+                    if obj.domain{i}.name == unset_domains{j}.name
+                        obj.domain{i} = '*';
+                    end
+                end
+            end
+        end
+
     end
 
     methods (Hidden, Access = protected)

test/test_container.m

@@ -1988,16 +1988,16 @@ function test_remove(t, cfg)
     t.assert(~a1.modified);
     t.assert(~x1.modified);
     gdx.removeSymbols('i1');
-    t.assert(numel(fieldnames(gdx.data)) == 2);
-    t.assert(isfield(gdx.data, 'a1'));
+    t.assert(numel(fieldnames(gdx.data)) == 1);
     t.assert(isfield(gdx.data, 'x1'));
     t.assert(~i1.isValid());
     t.assert(~a1.isValid());
-    t.assert(~x1.isValid());
+    t.assert(x1.isValid());
+    t.assertEquals(x1.domain{1}, '*');
     t.assert(gdx.modified);
     t.assert(i1.modified);
-    t.assert(~a1.modified);
-    t.assert(~x1.modified);
+    t.assert(a1.modified);
+    t.assert(x1.modified);
 
     t.add('remove_2');
     gdx.removeSymbols({'i1', 'a1', 'x1'});
@@ -2030,16 +2030,16 @@ function test_remove(t, cfg)
     t.assert(~a1.modified);
     t.assert(~x1.modified);
     gdx.removeSymbols('I1');
-    t.assert(numel(fieldnames(gdx.data)) == 2);
-    t.assert(isfield(gdx.data, 'a1'));
+    t.assert(numel(fieldnames(gdx.data)) == 1);
     t.assert(isfield(gdx.data, 'x1'));
     t.assert(~i1.isValid());
     t.assert(~a1.isValid());
-    t.assert(~x1.isValid());
+    t.assert(x1.isValid());
+    t.assertEquals(x1.domain{1}, '*');
     t.assert(gdx.modified);
     t.assert(i1.modified);
-    t.assert(~a1.modified);
-    t.assert(~x1.modified);
+    t.assert(a1.modified);
+    t.assert(x1.modified);
 
     t.add('remove_diffcase_2');
     gdx.removeSymbols({'I1', 'A1', 'X1'});