Model and model store interfaces and implementations

5 files changed, 257 insertions, 110 deletions

diff --git a/model-data/src/main/java/org/eclipse/viatra/solver/data/model/Model.java b/model-data/src/main/java/org/eclipse/viatra/solver/data/model/Model.java
index 18fab2bf..a19e4d5f 100644
--- a/model-data/src/main/java/org/eclipse/viatra/solver/data/model/Model.java
+++ b/model-data/src/main/java/org/eclipse/viatra/solver/data/model/Model.java
@@ -1,60 +1,20 @@
 package org.eclipse.viatra.solver.data.model;
 
-import java.util.Map;
 import java.util.Set;
 
+import org.eclipse.viatra.solver.data.map.Cursor;
 import org.eclipse.viatra.solver.data.map.Versioned;
-import org.eclipse.viatra.solver.data.map.VersionedMap;
-import org.eclipse.viatra.solver.data.model.symbols.Symbol;
-
-public class Model implements Versioned {
-        private final ModelStore store;
-        private final Map<Symbol, VersionedMap<Tuple,Object>> maps;
-
-        public Model(ModelStore store, Map<Symbol, VersionedMap<Tuple, Object>> maps) {
-                this.store = store;
-                this.maps = maps;
-        }
-
-        public Set<Symbol> getSymbols() {
-                return store.getSymbols();
-        }
-
-        public Object get(Symbol symbol, int... key) {
-                if (maps.containsKey(symbol)) {
-                        if (key.length == symbol.getArity()) {
-                                return maps.get(symbol).get(Tuple.of(key));
-                        } else {
-                                throw new IllegalArgumentException("The arity of symbol " + symbol.getName() + "is " + symbol.getArity()
-                                                + " and not " + key.length);
-                        }
-                } else {
-                        throw new IllegalArgumentException("Model does define symbol " + symbol.getName());
-                }
-        }
-
-        public void put(Symbol symbol, Object value, int... key) {
-                if (maps.containsKey(symbol)) {
-                        if (key.length == symbol.getArity()) {
-                                maps.get(symbol).put(Tuple.of(key),value);
-                        } else {
-                                throw new IllegalArgumentException("The arity of symbol " + symbol.getName() + "is " + symbol.getArity()
-                                                + " and not " + key.length);
-                        }
-                } else {
-                        throw new IllegalArgumentException("Model does define symbol " + symbol.getName());
-                }
-        }
-
-        @Override
-        public long commit() {
-                // TODO Auto-generated method stub
-                return 0;
-        }
-
-        @Override
-        public void restore(long state) {
-                // TODO Auto-generated method stub
-
-        }
+import org.eclipse.viatra.solver.data.model.representation.DataRepresentation;
+
+public interface Model extends Versioned{
+        @SuppressWarnings("squid:S1452")
+        Set<DataRepresentation<?, ?>> getDataRepresentations();
+        
+        <K,V> V get(DataRepresentation<K,V> representation, K key);
+        <K,V> Cursor<K,V> getAll(DataRepresentation<K,V> representation);
+        <K,V> void put(DataRepresentation<K,V> representation, K key, V value);
+        <K,V> void putAll(DataRepresentation<K,V> representation, Cursor<K,V> cursor);
+        <K,V> long getSize(DataRepresentation<K,V> representation);
+        
+        ModelDiffCursor getDiffCursor(long to);
 }
diff --git a/model-data/src/main/java/org/eclipse/viatra/solver/data/model/ModelStore.java b/model-data/src/main/java/org/eclipse/viatra/solver/data/model/ModelStore.java
index 53d69dc8..35ac72b5 100644
--- a/model-data/src/main/java/org/eclipse/viatra/solver/data/model/ModelStore.java
+++ b/model-data/src/main/java/org/eclipse/viatra/solver/data/model/ModelStore.java
@@ -2,13 +2,15 @@ package org.eclipse.viatra.solver.data.model;
 
 import java.util.Set;
 
-import org.eclipse.viatra.solver.data.model.symbols.Symbol;
+import org.eclipse.viatra.solver.data.model.representation.DataRepresentation;
 
 public interface ModelStore {
-
-        Set<Symbol> getSymbols();
+        @SuppressWarnings("squid:S1452")
+        Set<DataRepresentation<?, ?>> getDataRepresentations();
+        
         Model createModel();
         Model createModel(long state);
+        
         Set<Long> getStates();
-
+        ModelDiffCursor getDiffCursor(long from, long to);
 }
\ No newline at end of file
diff --git a/model-data/src/main/java/org/eclipse/viatra/solver/data/model/ModelStoreImpl.java b/model-data/src/main/java/org/eclipse/viatra/solver/data/model/ModelStoreImpl.java
index 81fe40f2..38aaccc1 100644
--- a/model-data/src/main/java/org/eclipse/viatra/solver/data/model/ModelStoreImpl.java
+++ b/model-data/src/main/java/org/eclipse/viatra/solver/data/model/ModelStoreImpl.java
@@ -1,7 +1,5 @@
 package org.eclipse.viatra.solver.data.model;
 
-import java.util.Collection;
-import java.util.Comparator;
 import java.util.HashMap;
 import java.util.HashSet;
 import java.util.LinkedList;
@@ -9,57 +7,63 @@ import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Set;
-import java.util.TreeMap;
 
+import org.eclipse.viatra.solver.data.map.ContinousHashProvider;
+import org.eclipse.viatra.solver.data.map.DiffCursor;
 import org.eclipse.viatra.solver.data.map.VersionedMap;
 import org.eclipse.viatra.solver.data.map.VersionedMapStore;
 import org.eclipse.viatra.solver.data.map.VersionedMapStoreImpl;
-import org.eclipse.viatra.solver.data.model.symbols.IntegerSymbol;
-import org.eclipse.viatra.solver.data.model.symbols.PredicateSymbol;
-import org.eclipse.viatra.solver.data.model.symbols.RealSymbol;
-import org.eclipse.viatra.solver.data.model.symbols.Symbol;
-import org.eclipse.viatra.solver.data.model.values.TruthValue;
+import org.eclipse.viatra.solver.data.model.internal.ModelImpl;
+import org.eclipse.viatra.solver.data.model.internal.SymbolRepresentationEquivalenceClass;
+import org.eclipse.viatra.solver.data.model.representation.AuxilaryDataRepresentation;
+import org.eclipse.viatra.solver.data.model.representation.DataRepresentation;
+import org.eclipse.viatra.solver.data.model.representation.SymbolRepresentation;
 
 public class ModelStoreImpl implements ModelStore {
-        
-        private final Map<Symbol, VersionedMapStore<Tuple, Object>> stores;
-        private final Set<Long> states = new HashSet<>();
 
-        public ModelStoreImpl(Set<Symbol> symbols) {
-                stores = initStores(symbols);
+        private final Map<DataRepresentation<?, ?>, VersionedMapStore<?, ?>> stores;
+
+        public ModelStoreImpl(Set<DataRepresentation<?, ?>> dataRepresentations) {
+                stores = initStores(dataRepresentations);
         }
 
-        private Map<Symbol, VersionedMapStore<Tuple, Object>> initStores(Set<Symbol> symbols) {
-                Map<Symbol, VersionedMapStore<Tuple, Object>> result = new TreeMap<>(Symbol.symbolComparator);
-                
-                Map<Integer, List<PredicateSymbol>> predicateSymbols = new HashMap<>();
-                Map<Integer, List<IntegerSymbol>> integerSymbols = new HashMap<>();
-                Map<Integer, List<RealSymbol>> realSymbols = new HashMap<>();
-                for (Symbol symbol : symbols) {
-                        if (symbol instanceof PredicateSymbol) {
-                                ModelStoreImpl.addOrCreate(predicateSymbols, symbol.getArity(), (PredicateSymbol) symbol);
-                        } else if (symbol instanceof IntegerSymbol) {
-                                ModelStoreImpl.addOrCreate(integerSymbols, symbol.getArity(), (IntegerSymbol) symbol);
-                        } else if (symbol instanceof RealSymbol) {
-                                ModelStoreImpl.addOrCreate(realSymbols, symbol.getArity(), (RealSymbol) symbol);
+        private Map<DataRepresentation<?, ?>, VersionedMapStore<?, ?>> initStores(
+                        Set<DataRepresentation<?, ?>> dataRepresentations) {
+                Map<DataRepresentation<?, ?>, VersionedMapStore<?, ?>> result = new HashMap<>();
+
+                Map<SymbolRepresentationEquivalenceClass, List<SymbolRepresentation<?>>> symbolRepresentationsPerHashPerArity = new HashMap<>();
+
+                for (DataRepresentation<?, ?> dataRepresentation : dataRepresentations) {
+                        if (dataRepresentation instanceof SymbolRepresentation<?>) {
+                                SymbolRepresentation<?> symbolRepresentation = (SymbolRepresentation<?>) dataRepresentation;
+                                addOrCreate(symbolRepresentationsPerHashPerArity,
+                                                new SymbolRepresentationEquivalenceClass(symbolRepresentation), symbolRepresentation);
+                        } else if (dataRepresentation instanceof AuxilaryDataRepresentation<?, ?>) {
+                                VersionedMapStoreImpl<?, ?> store = new VersionedMapStoreImpl<>(dataRepresentation.getHashProvider(),
+                                                dataRepresentation.getDefaultValue());
+                                result.put(dataRepresentation, store);
+                        } else {
+                                throw new UnsupportedOperationException(
+                                                "Model store does not have strategy to use " + dataRepresentation.getClass() + "!");
                         }
                 }
-                
-                initPredicateGroup(result, predicateSymbols.values(),TruthValue.False);
-                initPredicateGroup(result, integerSymbols.values(), null);
-                initPredicateGroup(result, realSymbols.values(), null);
-                
+                for (List<SymbolRepresentation<?>> symbolGroup : symbolRepresentationsPerHashPerArity.values()) {
+                        initRepresentationGroup(result, symbolGroup);
+                }
+
                 return result;
         }
 
-        private <V> void initPredicateGroup(Map<Symbol, VersionedMapStore<Tuple, Object>> result,
-                        Collection<? extends List<? extends Symbol>> symbolGroups, V defaultValue) {
-                for (List<? extends Symbol> similarSymbols : symbolGroups) {
-                        List<VersionedMapStore<Tuple, Object>> maps = VersionedMapStoreImpl.createSharedVersionedMapStores(
-                                        similarSymbols.size(), TupleHashProvider.instance, defaultValue);
-                        for (int i = 0; i < similarSymbols.size(); i++) {
-                                result.put(similarSymbols.get(i), maps.get(i));
-                        }
+        private void initRepresentationGroup(Map<DataRepresentation<?, ?>, VersionedMapStore<?, ?>> result,
+                        List<SymbolRepresentation<?>> symbolGroup) {
+                final ContinousHashProvider<Tuple> hashProvider = symbolGroup.get(0).getHashProvider();
+                final Object defaultValue = symbolGroup.get(0).getDefaultValue();
+                
+                List<VersionedMapStore<Tuple, Object>> maps = VersionedMapStoreImpl
+                                .createSharedVersionedMapStores(symbolGroup.size(), hashProvider, defaultValue);
+                
+                for (int i = 0; i < symbolGroup.size(); i++) {
+                        result.put(symbolGroup.get(i), maps.get(i));
                 }
         }
 
@@ -73,30 +77,51 @@ public class ModelStoreImpl implements ModelStore {
                 }
                 list.add(value);
         }
+
         @Override
-        public Set<Symbol> getSymbols() {
+        public Set<DataRepresentation<?, ?>> getDataRepresentations() {
                 return this.stores.keySet();
         }
+
         @Override
-        public Model createModel() {
-                Map<Symbol, VersionedMap<Tuple,Object>> maps = new TreeMap<>(Symbol.symbolComparator);
-                for(Entry<Symbol, VersionedMapStore<Tuple, Object>> entry : this.stores.entrySet()) {
-                        maps.put(entry.getKey(),entry.getValue().createMap());
+        public ModelImpl createModel() {
+                Map<DataRepresentation<?, ?>, VersionedMap<?, ?>> maps = new HashMap<>();
+                for (Entry<DataRepresentation<?, ?>, VersionedMapStore<?, ?>> entry : this.stores.entrySet()) {
+                        maps.put(entry.getKey(), entry.getValue().createMap());
                 }
-                return new Model(this, maps);
+                return new ModelImpl(this, maps);
         }
 
         @Override
-        public synchronized Model createModel(long state) {
-                Map<Symbol, VersionedMap<Tuple,Object>> maps = new TreeMap<>(Symbol.symbolComparator);
-                for(Entry<Symbol, VersionedMapStore<Tuple, Object>> entry : this.stores.entrySet()) {
-                        maps.put(entry.getKey(),entry.getValue().createMap(state));
+        public synchronized ModelImpl createModel(long state) {
+                Map<DataRepresentation<?, ?>, VersionedMap<?, ?>> maps = new HashMap<>();
+                for (Entry<DataRepresentation<?, ?>, VersionedMapStore<?, ?>> entry : this.stores.entrySet()) {
+                        maps.put(entry.getKey(), entry.getValue().createMap(state));
+                }
+                return new ModelImpl(this, maps);
+        }
+        
+        @Override
+        @SuppressWarnings("squid:S1751")
+        public synchronized Set<Long> getStates() {
+                // if not empty, return first
+                for(VersionedMapStore<?, ?> store : stores.values()) {
+                        return store.getStates();
                 }
-                return new Model(this, maps);
+                // if empty
+                Set<Long> result = new HashSet<>();
+                result.add(0l);
+                return result;
         }
 
         @Override
-        synchronized public Set<Long> getStates() {
-                return this.states;
+        public synchronized ModelDiffCursor getDiffCursor(long from, long to) {
+                Map<DataRepresentation<?, ?>,DiffCursor<?,?>> diffcursors = new HashMap<>();
+                for(Entry<DataRepresentation<?, ?>, VersionedMapStore<?, ?>> entry : stores.entrySet()) {
+                        DataRepresentation<?, ?> representation = entry.getKey();
+                        DiffCursor<?, ?> diffCursor = entry.getValue().getDiffCursor(from, to);
+                        diffcursors.put(representation, diffCursor);
+                }
+                return new ModelDiffCursor(diffcursors);
         }
 }
diff --git a/model-data/src/main/java/org/eclipse/viatra/solver/data/model/internal/ModelImpl.java b/model-data/src/main/java/org/eclipse/viatra/solver/data/model/internal/ModelImpl.java
new file mode 100644
index 00000000..49699933
--- /dev/null
+++ b/model-data/src/main/java/org/eclipse/viatra/solver/data/model/internal/ModelImpl.java
@@ -0,0 +1,124 @@
+package org.eclipse.viatra.solver.data.model.internal;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
+
+import org.eclipse.viatra.solver.data.map.ContinousHashProvider;
+import org.eclipse.viatra.solver.data.map.Cursor;
+import org.eclipse.viatra.solver.data.map.DiffCursor;
+import org.eclipse.viatra.solver.data.map.VersionedMap;
+import org.eclipse.viatra.solver.data.map.internal.MapDiffCursor;
+import org.eclipse.viatra.solver.data.model.Model;
+import org.eclipse.viatra.solver.data.model.ModelDiffCursor;
+import org.eclipse.viatra.solver.data.model.ModelStore;
+import org.eclipse.viatra.solver.data.model.representation.DataRepresentation;
+
+public class ModelImpl implements Model {
+        private final ModelStore store;
+        private final Map<DataRepresentation<?, ?>, VersionedMap<?, ?>> maps;
+
+        public ModelImpl(ModelStore store, Map<DataRepresentation<?, ?>, VersionedMap<?, ?>> maps) {
+                this.store = store;
+                this.maps = maps;
+        }
+
+        @Override
+        public Set<DataRepresentation<?, ?>> getDataRepresentations() {
+                return maps.keySet();
+        }
+
+        @SuppressWarnings("unchecked")
+        private <K, V> VersionedMap<K, V> getMap(DataRepresentation<K, V> representation) {
+                if (maps.containsKey(representation)) {
+                        return (VersionedMap<K, V>) maps.get(representation);
+                } else {
+                        throw new IllegalArgumentException("Model does have representation " + representation);
+                }
+        }
+
+        private <K, V> VersionedMap<K, V> getMapValidateKey(DataRepresentation<K, V> representation, K key) {
+                if (representation.isValidKey(key)) {
+                        return getMap(representation);
+                } else {
+                        throw new IllegalArgumentException(
+                                        "Key is not valid for representation! (representation=" + representation + ", key=" + key + ");");
+                }
+        }
+
+        @Override
+        public <K, V> V get(DataRepresentation<K, V> representation, K key) {
+                return getMapValidateKey(representation, key).get(key);
+        }
+
+        @Override
+        public <K, V> Cursor<K, V> getAll(DataRepresentation<K, V> representation) {
+                return getMap(representation).getCursor();
+        }
+
+        @Override
+        public <K, V> void put(DataRepresentation<K, V> representation, K key, V value) {
+                getMapValidateKey(representation, key).put(key, value);
+        }
+
+        @Override
+        public <K, V> void putAll(DataRepresentation<K, V> representation, Cursor<K, V> cursor) {
+                getMap(representation).putAll(cursor);
+        }
+
+        @Override
+        public <K, V> long getSize(DataRepresentation<K, V> representation) {
+                return getMap(representation).getSize();
+        }
+
+        @Override
+        public ModelDiffCursor getDiffCursor(long to) {
+                Model toModel = store.createModel(to);
+                Map<DataRepresentation<?, ?>, DiffCursor<?, ?>> diffCursors = new HashMap<>();
+                for (DataRepresentation<?, ?> representation : this.maps.keySet()) {
+                        MapDiffCursor<?, ?> diffCursor = constructDiffCursor(toModel, representation);
+                        diffCursors.put(representation, diffCursor);
+                }
+                return new ModelDiffCursor(diffCursors);
+        }
+
+        private <K, V> MapDiffCursor<K, V> constructDiffCursor(Model toModel, DataRepresentation<K, V> representation) {
+                @SuppressWarnings("unchecked")
+                Cursor<K, V> fromCursor = (Cursor<K, V>) this.maps.get(representation).getCursor();
+                Cursor<K, V> toCursor = toModel.getAll(representation);
+
+                ContinousHashProvider<K> hashProvider = representation.getHashProvider();
+                V defaultValue = representation.getDefaultValue();
+                return new MapDiffCursor<>(hashProvider, defaultValue, fromCursor, toCursor);
+        }
+
+        @Override
+        public long commit() {
+                long version = 0;
+                boolean versionSet = false;
+                for (VersionedMap<?, ?> map : maps.values()) {
+                        long newVersion = map.commit();
+                        if (versionSet) {
+                                if (version != newVersion) {
+                                        throw new IllegalStateException(
+                                                        "Maps in model have different versions! (" + version + " and" + newVersion + ")");
+                                }
+                        } else {
+                                version = newVersion;
+                                versionSet = true;
+                        }
+                }
+                return version;
+        }
+
+        @Override
+        public void restore(long state) {
+                if(store.getStates().contains(state)) {
+                        for (VersionedMap<?, ?> map : maps.values()) {
+                                map.restore(state);
+                        }
+                } else {
+                        throw new IllegalArgumentException("Map does not contain state "+state+"!");
+                }
+        }
+}
diff --git a/model-data/src/main/java/org/eclipse/viatra/solver/data/model/internal/SymbolRepresentationEquivalenceClass.java b/model-data/src/main/java/org/eclipse/viatra/solver/data/model/internal/SymbolRepresentationEquivalenceClass.java
new file mode 100644
index 00000000..b87b7c13
--- /dev/null
+++ b/model-data/src/main/java/org/eclipse/viatra/solver/data/model/internal/SymbolRepresentationEquivalenceClass.java
@@ -0,0 +1,36 @@
+package org.eclipse.viatra.solver.data.model.internal;
+
+import java.util.Objects;
+
+import org.eclipse.viatra.solver.data.map.ContinousHashProvider;
+import org.eclipse.viatra.solver.data.model.Tuple;
+import org.eclipse.viatra.solver.data.model.representation.SymbolRepresentation;
+
+public class SymbolRepresentationEquivalenceClass {
+        final ContinousHashProvider<Tuple> hashProvider;
+        final Class<?> domainClass;
+        final Object defaultValue;
+        final int arity;
+        public SymbolRepresentationEquivalenceClass(SymbolRepresentation<?> representation) {
+                this.hashProvider = representation.getHashProvider();
+                this.domainClass = representation.getValueClass();
+                this.defaultValue = representation.getDefaultValue();
+                this.arity = representation.getSymbol().getArity();
+        }
+        @Override
+        public int hashCode() {
+                return Objects.hash(arity, defaultValue, domainClass, hashProvider);
+        }
+        @Override
+        public boolean equals(Object obj) {
+                if (this == obj)
+                        return true;
+                if (obj == null)
+                        return false;
+                if (getClass() != obj.getClass())
+                        return false;
+                SymbolRepresentationEquivalenceClass other = (SymbolRepresentationEquivalenceClass) obj;
+                return arity == other.arity && Objects.equals(defaultValue, other.defaultValue)
+                                && Objects.equals(domainClass, other.domainClass) && Objects.equals(hashProvider, other.hashProvider);
+        }
+}