fix: scope upper bounds

4 files changed, 182 insertions, 3 deletions

diff --git a/subprojects/store-reasoning-scope/src/main/java/tools/refinery/store/reasoning/scope/LowerTypeScopePropagator.java b/subprojects/store-reasoning-scope/src/main/java/tools/refinery/store/reasoning/scope/LowerTypeScopePropagator.java
index 2be92464..86401b7e 100644
--- a/subprojects/store-reasoning-scope/src/main/java/tools/refinery/store/reasoning/scope/LowerTypeScopePropagator.java
+++ b/subprojects/store-reasoning-scope/src/main/java/tools/refinery/store/reasoning/scope/LowerTypeScopePropagator.java
@@ -39,7 +39,7 @@ class LowerTypeScopePropagator extends TypeScopePropagator {
                 constraint.setLb((lowerBound - getSingleCount()));
         }
 
-        public static class Factory extends TypeScopePropagator.Factory {
+        static class Factory extends TypeScopePropagator.Factory {
                 private final PartialRelation type;
                 private final int lowerBound;
                 private final RelationalQuery allMay;
diff --git a/subprojects/store-reasoning-scope/src/main/java/tools/refinery/store/reasoning/scope/TypeScopePropagator.java b/subprojects/store-reasoning-scope/src/main/java/tools/refinery/store/reasoning/scope/TypeScopePropagator.java
index bb50656b..193c132c 100644
--- a/subprojects/store-reasoning-scope/src/main/java/tools/refinery/store/reasoning/scope/TypeScopePropagator.java
+++ b/subprojects/store-reasoning-scope/src/main/java/tools/refinery/store/reasoning/scope/TypeScopePropagator.java
@@ -59,7 +59,7 @@ abstract class TypeScopePropagator {
                 adapter.markAsChanged();
         }
 
-        public abstract static class Factory {
+        abstract static class Factory {
                 public abstract TypeScopePropagator createPropagator(BoundScopePropagator adapter);
 
                 protected abstract Collection<AnyQuery> getQueries();
diff --git a/subprojects/store-reasoning-scope/src/main/java/tools/refinery/store/reasoning/scope/UpperTypeScopePropagator.java b/subprojects/store-reasoning-scope/src/main/java/tools/refinery/store/reasoning/scope/UpperTypeScopePropagator.java
index 4aba5aac..634e93bc 100644
--- a/subprojects/store-reasoning-scope/src/main/java/tools/refinery/store/reasoning/scope/UpperTypeScopePropagator.java
+++ b/subprojects/store-reasoning-scope/src/main/java/tools/refinery/store/reasoning/scope/UpperTypeScopePropagator.java
@@ -5,14 +5,22 @@
  */
 package tools.refinery.store.reasoning.scope;
 
+import tools.refinery.store.dse.transition.DesignSpaceExplorationBuilder;
+import tools.refinery.store.dse.transition.objectives.Criteria;
+import tools.refinery.store.model.ModelStoreBuilder;
 import tools.refinery.store.query.dnf.AnyQuery;
 import tools.refinery.store.query.dnf.Query;
 import tools.refinery.store.query.dnf.RelationalQuery;
+import tools.refinery.store.query.term.Variable;
+import tools.refinery.store.reasoning.literal.CountCandidateUpperBoundLiteral;
 import tools.refinery.store.reasoning.representation.PartialRelation;
 
 import java.util.Collection;
 import java.util.List;
 
+import static tools.refinery.store.query.literal.Literals.check;
+import static tools.refinery.store.query.term.int_.IntTerms.constant;
+import static tools.refinery.store.query.term.int_.IntTerms.greater;
 import static tools.refinery.store.reasoning.literal.PartialLiterals.must;
 import static tools.refinery.store.reasoning.translator.multiobject.MultiObjectTranslator.MULTI_VIEW;
 
@@ -30,12 +38,14 @@ class UpperTypeScopePropagator extends TypeScopePropagator {
                 constraint.setUb((upperBound - getSingleCount()));
         }
 
-        public static class Factory extends TypeScopePropagator.Factory {
+        static class Factory extends TypeScopePropagator.Factory {
+                private final PartialRelation type;
                 private final int upperBound;
                 private final RelationalQuery allMust;
                 private final RelationalQuery multiMust;
 
                 public Factory(PartialRelation type, int upperBound) {
+                        this.type = type;
                         this.upperBound = upperBound;
                         allMust = Query.of(type.name() + "#must", (builder, instance) -> builder.clause(
                                         must(type.call(instance))
@@ -55,5 +65,19 @@ class UpperTypeScopePropagator extends TypeScopePropagator {
                 protected Collection<AnyQuery> getQueries() {
                         return List.of(allMust, multiMust);
                 }
+
+                @Override
+                public void configure(ModelStoreBuilder storeBuilder) {
+                        super.configure(storeBuilder);
+
+                        var tooManyObjects = Query.of(type.name() + "#tooMany", builder -> builder
+                                        .clause(Integer.class, candidateUpperBound -> List.of(
+                                                        new CountCandidateUpperBoundLiteral(candidateUpperBound, type, List.of(Variable.of())),
+                                                        check(greater(candidateUpperBound, constant(upperBound)))
+                                        )));
+
+                        storeBuilder.tryGetAdapter(DesignSpaceExplorationBuilder.class).ifPresent(dseBuilder ->
+                                        dseBuilder.accept(Criteria.whenNoMatch(tooManyObjects)));
+                }
         }
 }
diff --git a/subprojects/store-reasoning-scope/src/test/java/tools/refinery/store/reasoning/scope/PredicateScopeTest.java b/subprojects/store-reasoning-scope/src/test/java/tools/refinery/store/reasoning/scope/PredicateScopeTest.java
new file mode 100644
index 00000000..d21bd12e
--- /dev/null
+++ b/subprojects/store-reasoning-scope/src/test/java/tools/refinery/store/reasoning/scope/PredicateScopeTest.java
@@ -0,0 +1,155 @@
+/*
+ * SPDX-FileCopyrightText: 2023 The Refinery Authors <https://refinery.tools/>
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package tools.refinery.store.reasoning.scope;
+
+import org.junit.jupiter.api.Tag;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
+import tools.refinery.store.dse.propagation.PropagationAdapter;
+import tools.refinery.store.dse.strategy.BestFirstStoreManager;
+import tools.refinery.store.dse.transition.DesignSpaceExplorationAdapter;
+import tools.refinery.store.model.ModelStore;
+import tools.refinery.store.query.dnf.Query;
+import tools.refinery.store.query.interpreter.QueryInterpreterAdapter;
+import tools.refinery.store.query.term.Variable;
+import tools.refinery.store.reasoning.ReasoningAdapter;
+import tools.refinery.store.reasoning.ReasoningStoreAdapter;
+import tools.refinery.store.reasoning.interpretation.PartialInterpretation;
+import tools.refinery.store.reasoning.literal.Concreteness;
+import tools.refinery.store.reasoning.representation.PartialRelation;
+import tools.refinery.store.reasoning.seed.ModelSeed;
+import tools.refinery.store.reasoning.translator.PartialRelationTranslator;
+import tools.refinery.store.reasoning.translator.containment.ContainmentHierarchyTranslator;
+import tools.refinery.store.reasoning.translator.metamodel.Metamodel;
+import tools.refinery.store.reasoning.translator.metamodel.MetamodelTranslator;
+import tools.refinery.store.reasoning.translator.multiobject.MultiObjectTranslator;
+import tools.refinery.store.reasoning.translator.multiplicity.ConstrainedMultiplicity;
+import tools.refinery.store.representation.TruthValue;
+import tools.refinery.store.representation.cardinality.CardinalityIntervals;
+import tools.refinery.store.statecoding.StateCoderAdapter;
+import tools.refinery.store.tuple.Tuple;
+
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.is;
+import static tools.refinery.store.query.literal.Literals.not;
+
+class PredicateScopeTest {
+        private static final PartialRelation index = new PartialRelation("Index", 1);
+        private static final PartialRelation next = new PartialRelation("next", 2);
+        private static final PartialRelation nextInvalidMultiplicity = new PartialRelation("next::invalidMultiplicity", 1);
+        private static final PartialRelation prev = new PartialRelation("prev", 2);
+        private static final PartialRelation prevInvalidMultiplicity = new PartialRelation("prev::invalidMultiplicity", 1);
+        private static final PartialRelation loop = new PartialRelation("loop", 1);
+        private static final PartialRelation first = new PartialRelation("first", 1);
+        private static final PartialRelation last = new PartialRelation("last", 1);
+
+        @Tag("slow")
+        @ParameterizedTest
+        @ValueSource(ints = {1, 2, 3, 4, 5})
+        void generateTest(int randomSeed) {
+                var store = createStore();
+                var newIndex = Tuple.of(0);
+                var modelSeed = ModelSeed.builder(1)
+                                .seed(MultiObjectTranslator.COUNT_SYMBOL, builder -> builder
+                                                .reducedValue(CardinalityIntervals.ONE)
+                                                .put(newIndex, CardinalityIntervals.SET))
+                                .seed(ContainmentHierarchyTranslator.CONTAINED_SYMBOL,
+                                                builder -> builder.reducedValue(TruthValue.UNKNOWN))
+                                .seed(index, builder -> builder
+                                                .reducedValue(TruthValue.UNKNOWN)
+                                                .put(newIndex, TruthValue.TRUE))
+                                .seed(next, builder -> builder.reducedValue(TruthValue.UNKNOWN))
+                                .seed(prev, builder -> builder.reducedValue(TruthValue.UNKNOWN))
+                                .build();
+                var model = store.getAdapter(ReasoningStoreAdapter.class).createInitialModel(modelSeed);
+                var initialVersion = model.commit();
+                var bestFistSearch = new BestFirstStoreManager(store, 1);
+                bestFistSearch.startExploration(initialVersion, randomSeed);
+                model.restore(bestFistSearch.getSolutionStore().getSolutions().get(0).version());
+                var reasoningAdapter = model.getAdapter(ReasoningAdapter.class);
+                var firstInterpretation = reasoningAdapter.getPartialInterpretation(Concreteness.CANDIDATE, first);
+                assertSize(firstInterpretation, 1);
+                var lastInterpretation = reasoningAdapter.getPartialInterpretation(Concreteness.CANDIDATE, last);
+                assertSize(lastInterpretation, 1);
+        }
+
+        @Test
+        void invalidResultTest() {
+                var store = createStore();
+                var modelSeed = ModelSeed.builder(8)
+                                .seed(MultiObjectTranslator.COUNT_SYMBOL, builder -> builder.reducedValue(CardinalityIntervals.ONE))
+                                .seed(ContainmentHierarchyTranslator.CONTAINED_SYMBOL,
+                                                builder -> builder.reducedValue(TruthValue.UNKNOWN))
+                                .seed(index, builder -> builder.reducedValue(TruthValue.TRUE))
+                                .seed(next, builder -> builder
+                                                .reducedValue(TruthValue.UNKNOWN)
+                                                .put(Tuple.of(1, 2), TruthValue.TRUE)
+                                                .put(Tuple.of(2, 3), TruthValue.TRUE)
+                                                .put(Tuple.of(3, 4), TruthValue.TRUE)
+                                                .put(Tuple.of(4, 5), TruthValue.TRUE)
+                                                .put(Tuple.of(6, 1), TruthValue.TRUE))
+                                .seed(prev, builder -> builder.reducedValue(TruthValue.UNKNOWN))
+                                .build();
+                var model = store.getAdapter(ReasoningStoreAdapter.class).createInitialModel(modelSeed);
+                var reasoningAdapter = model.getAdapter(ReasoningAdapter.class);
+                var firstInterpretation = reasoningAdapter.getPartialInterpretation(Concreteness.CANDIDATE, first);
+                assertSize(firstInterpretation, 3);
+                var lastInterpretation = reasoningAdapter.getPartialInterpretation(Concreteness.CANDIDATE, last);
+                assertSize(lastInterpretation, 3);
+                var designSpaceAdapter = model.getAdapter(DesignSpaceExplorationAdapter.class);
+                assertThat(designSpaceAdapter.checkAccept(), is(false));
+        }
+
+        private ModelStore createStore() {
+                var metamodel = Metamodel.builder()
+                                .type(index)
+                                .reference(next, index, false,
+                                                ConstrainedMultiplicity.of(CardinalityIntervals.LONE, nextInvalidMultiplicity), index, prev)
+                                .reference(prev, index, false,
+                                                ConstrainedMultiplicity.of(CardinalityIntervals.LONE, prevInvalidMultiplicity), index, next)
+                                .build();
+                return ModelStore.builder()
+                                .with(QueryInterpreterAdapter.builder())
+                                .with(StateCoderAdapter.builder())
+                                .with(PropagationAdapter.builder())
+                                .with(DesignSpaceExplorationAdapter.builder())
+                                .with(ReasoningAdapter.builder())
+                                .with(new MultiObjectTranslator())
+                                .with(new MetamodelTranslator(metamodel))
+                                .with(PartialRelationTranslator.of(loop)
+                                                .query(Query.of("loop", (builder, p1) -> builder.clause(
+                                                                index.call(p1),
+                                                                next.callTransitive(p1, p1)
+                                                )))
+                                                .mayNever())
+                                .with(PartialRelationTranslator.of(first)
+                                                .query(Query.of("first", (builder, p1) -> builder.clause(
+                                                                index.call(p1),
+                                                                not(prev.call(p1, Variable.of()))
+                                                ))))
+                                .with(PartialRelationTranslator.of(last)
+                                                .query(Query.of("last", (builder, p1) -> builder.clause(
+                                                                index.call(p1),
+                                                                not(next.call(p1, Variable.of()))
+                                                ))))
+                                .with(new ScopePropagator()
+                                                .scope(index, CardinalityIntervals.exactly(8))
+                                                .scope(first, CardinalityIntervals.ONE)
+                                                .scope(last, CardinalityIntervals.ONE))
+                                .build();
+        }
+
+        private void assertSize(PartialInterpretation<TruthValue, Boolean> partialInterpretation, int expected) {
+                int size = 0;
+                var cursor = partialInterpretation.getAll();
+                while (cursor.move()) {
+                        assertThat(cursor.getValue(), is(TruthValue.TRUE));
+                        size++;
+                }
+                assertThat(size, is(expected));
+        }
+}