flamapy-z3 2.6.0.dev4__tar.gz → 2.6.0.dev5__tar.gz

{flamapy_z3-2.6.0.dev4 → flamapy_z3-2.6.0.dev5}/PKG-INFO

@@ -1,14 +1,14 @@
 Metadata-Version: 2.4
 Name: flamapy-z3
-Version: 2.6.0.dev4
+Version: 2.6.0.dev5
 Summary: z3-plugin for the automated analysis of feature models
 Author-email: Flamapy <flamapy@us.es>
 License-Expression: GPL-3.0-or-later
 Project-URL: Homepage, https://github.com/flamapy/z3_metamodel
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
-Requires-Dist: flamapy-fw~=2.6.0.dev4
-Requires-Dist: flamapy-fm~=2.6.0.dev4
+Requires-Dist: flamapy-fw~=2.6.0.dev5
+Requires-Dist: flamapy-fm~=2.6.0.dev5
 Requires-Dist: z3-solver~=4.14.1.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"

{flamapy_z3-2.6.0.dev4 → flamapy_z3-2.6.0.dev5}/flamapy/metamodels/z3_metamodel/models/z3_model.py

@@ -35,6 +35,9 @@ class Z3Model(VariabilityModel):
         self.attributes: dict[str, list[Any]] = {}  # attr_name -> [z3var]
         self.attributes_types: dict[str, AttributeType] = {}  # attr_name -> AttributeType
         self.constraints: list[Any] = []  # list of z3 expressions
+        # Auxiliary (Tseytin) boolean variables. Kept out of ``features`` so that feature
+        # enumeration/counting/bounds operations ignore them.
+        self.auxiliary_variables: list[Any] = []
         self.original_model: Optional[VariabilityModel] = None
 
     def create_const(self, ftype: FeatureType | AttributeType, value: Any) -> Any:

flamapy_z3-2.6.0.dev5/flamapy/metamodels/z3_metamodel/operations/interfaces/attribute_optimization.py

@@ -0,0 +1,12 @@
+"""Backward-compatible re-export.
+
+``AttributeOptimization`` and ``OptimizationGoal`` now live in the core framework so
+that every backend shares one interface. This module keeps the historical import path
+``flamapy.metamodels.z3_metamodel.operations.interfaces.attribute_optimization`` working.
+"""
+from flamapy.core.operations.attribute_optimization import (
+    AttributeOptimization,
+    OptimizationGoal,
+)
+
+__all__ = ["AttributeOptimization", "OptimizationGoal"]

{flamapy_z3-2.6.0.dev4 → flamapy_z3-2.6.0.dev5}/flamapy/metamodels/z3_metamodel/operations/z3_false_optional_features.py

@@ -10,7 +10,7 @@ from flamapy.metamodels.fm_metamodel.models import FeatureModel
 from flamapy.metamodels.z3_metamodel.models import Z3Model
 
 
-LOGGER = logging.getLogger('PySATFalseOptionalFeatures')
+LOGGER = logging.getLogger('Z3FalseOptionalFeatures')
 
 
 class Z3FalseOptionalFeatures(FalseOptionalFeatures):
@@ -26,11 +26,11 @@ class Z3FalseOptionalFeatures(FalseOptionalFeatures):
 
     def execute(self, model: VariabilityModel) -> 'Z3FalseOptionalFeatures':
         z3_model = cast(Z3Model, model)
-        try:
-            feature_model = cast(FeatureModel, model.original_model)
-        except FlamaException:
-            LOGGER.exception("The transformation didn't attach the source model, "
-                             "which is required for this operation.")
+        original_model = getattr(model, 'original_model', None)
+        if original_model is None:
+            raise FlamaException("The transformation didn't attach the source model, "
+                                 "which is required for this operation.")
+        feature_model = cast(FeatureModel, original_model)
         self._result = get_false_optional_features(z3_model, feature_model)
         return self
 

{flamapy_z3-2.6.0.dev4 → flamapy_z3-2.6.0.dev5}/flamapy/metamodels/z3_metamodel/transformations/fm_to_z3.py

@@ -61,10 +61,16 @@ class FmToZ3(ModelToModel):
     def get_destination_extension() -> str:
         return "z3"
 
-    def __init__(self, source_model: FeatureModel) -> None:
+    def __init__(self, source_model: FeatureModel, cnf_method: str = 'direct') -> None:
         self.source_model = source_model
         self.destination_model: Z3Model = Z3Model()
         self._counter: int = 0
+        # 'direct' (default) builds Z3 boolean expressions straight from the AST. 'tseytin'
+        # applies the Tseytin CNF encoding to purely propositional boolean constraints
+        # (others fall back to 'direct'). Framework-only opt-in; Z3 already clausifies
+        # internally, so this exists for cross-backend uniformity/experimentation, not speed.
+        self.cnf_method = cnf_method
+        self._aux_counter: int = 0
 
     def transform(self) -> Z3Model:
         self.destination_model = Z3Model()
@@ -258,9 +264,54 @@ class FmToZ3(ModelToModel):
         self._add_inactive_parent_constraints(parent, children)
 
     def _add_constraint_formula(self, ctc: Constraint) -> None:
+        if self.cnf_method == 'tseytin' and self._is_propositional_boolean(ctc):
+            self._add_tseytin_constraint(ctc)
+            return
         expr = self._get_expression(ctc.ast.root, None)
         self.destination_model.add_constraint(expr)
 
+    def _is_propositional_boolean(self, ctc: Constraint) -> bool:
+        """Whether a constraint is purely propositional over boolean features, i.e. safe
+        for the Tseytin CNF encoding. Arithmetic/aggregation/typed constraints are not."""
+        if any(op not in LOGICAL_OPERATORS for op in ctc.ast.get_operators()):
+            return False
+        for operand in ctc.ast.get_operands():
+            if not isinstance(operand, str):
+                return False
+            info = self.destination_model.get_variable(operand)
+            if info is None or info.ftype != FeatureType.BOOLEAN:
+                return False
+        return True
+
+    def _add_tseytin_constraint(self, ctc: Constraint) -> None:
+        clauses, aux_names = ctc.ast.get_clauses_with_aux(method='tseytin')
+        ctx = self.destination_model.ctx
+        # Fresh, globally-unique Z3 Bool per auxiliary name (same-named Bools in one Z3
+        # context are the same variable, so per-constraint names must not collide).
+        local: dict[str, Any] = {}
+        for name in aux_names:
+            self._aux_counter += 1
+            aux_var = z3.Bool(f'__tseytin_aux_{self._aux_counter}', ctx=ctx)
+            local[name] = aux_var
+            self.destination_model.auxiliary_variables.append(aux_var)
+
+        def literal_expr(term: str) -> Any:
+            negated = term.startswith('-')
+            name = term[1:] if negated else term
+            if name in local:
+                expr = local[name]
+            else:
+                info = self.destination_model.get_variable(name)
+                if info is None:
+                    raise FlamaException(f'Unsupported feature: {name}')
+                expr = info.sel
+            return z3.Not(expr) if negated else expr
+
+        for clause in clauses:
+            literals = [literal_expr(term) for term in clause]
+            formula = literals[0] if len(literals) == 1 else z3.Or(*literals)
+            self.destination_model.add_constraint(formula)
+
     def _get_expression(self, node: Node, parent: Optional[Node]) -> z3.ExprRef:
         if node.is_term():
             return self._get_term_expression(node, parent)

{flamapy_z3-2.6.0.dev4 → flamapy_z3-2.6.0.dev5}/flamapy_z3.egg-info/PKG-INFO

@@ -1,14 +1,14 @@
 Metadata-Version: 2.4
 Name: flamapy-z3
-Version: 2.6.0.dev4
+Version: 2.6.0.dev5
 Summary: z3-plugin for the automated analysis of feature models
 Author-email: Flamapy <flamapy@us.es>
 License-Expression: GPL-3.0-or-later
 Project-URL: Homepage, https://github.com/flamapy/z3_metamodel
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
-Requires-Dist: flamapy-fw~=2.6.0.dev4
-Requires-Dist: flamapy-fm~=2.6.0.dev4
+Requires-Dist: flamapy-fw~=2.6.0.dev5
+Requires-Dist: flamapy-fm~=2.6.0.dev5
 Requires-Dist: z3-solver~=4.14.1.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"

{flamapy_z3-2.6.0.dev4 → flamapy_z3-2.6.0.dev5}/flamapy_z3.egg-info/SOURCES.txt

@@ -26,4 +26,5 @@ flamapy_z3.egg-info/SOURCES.txt
 flamapy_z3.egg-info/dependency_links.txt
 flamapy_z3.egg-info/requires.txt
 flamapy_z3.egg-info/top_level.txt
+tests/test_tseytin.py
 tests/test_z3_metamodel.py

{flamapy_z3-2.6.0.dev4 → flamapy_z3-2.6.0.dev5}/flamapy_z3.egg-info/requires.txt

@@ -1,5 +1,5 @@
-flamapy-fw~=2.6.0.dev4
-flamapy-fm~=2.6.0.dev4
+flamapy-fw~=2.6.0.dev5
+flamapy-fm~=2.6.0.dev5
 z3-solver~=4.14.1.0
 
 [dev]

{flamapy_z3-2.6.0.dev4 → flamapy_z3-2.6.0.dev5}/pyproject.toml

@@ -4,15 +4,15 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "flamapy-z3"
-version = "2.6.0.dev4"
+version = "2.6.0.dev5"
 description = "z3-plugin for the automated analysis of feature models"
 readme = "README.md"
 license = "GPL-3.0-or-later"
 authors = [{ name = "Flamapy", email = "flamapy@us.es" }]
 requires-python = ">=3.11"
 dependencies = [
-    "flamapy-fw~=2.6.0.dev4",
-    "flamapy-fm~=2.6.0.dev4",
+    "flamapy-fw~=2.6.0.dev5",
+    "flamapy-fm~=2.6.0.dev5",
     "z3-solver~=4.14.1.0",
 ]
 

flamapy_z3-2.6.0.dev5/tests/test_tseytin.py

@@ -0,0 +1,69 @@
+"""The opt-in Tseytin CNF encoding must yield the same Z3 analysis results as the
+default direct translation, and must fall back to the direct translation for any
+constraint that is not purely propositional over boolean features."""
+import os
+import tempfile
+
+from flamapy.metamodels.fm_metamodel.transformations import UVLReader
+from flamapy.metamodels.z3_metamodel.transformations import FmToZ3
+from flamapy.metamodels.z3_metamodel.operations.z3_satisfiable import Z3Satisfiable
+from flamapy.metamodels.z3_metamodel.operations.z3_configurations import Z3Configurations
+from flamapy.metamodels.z3_metamodel.operations.z3_configurations_number import (
+    Z3ConfigurationsNumber,
+)
+
+
+# Purely propositional model: every cross-tree constraint is boolean.
+_PROP_UVL = """features
+    Root {abstract}
+        optional
+            A
+            B
+            C
+            D
+constraints
+    (A | B) => (C <=> D)
+    A => !B
+"""
+
+# All-arithmetic constraints; the Tseytin path must fall back to direct translation.
+_ARITH_MODEL = 'resources/models/uvl_models/fm03_integer_conditional_bounded.uvl'
+
+
+def _build_from_uvl_text(text, cnf_method):
+    handle, path = tempfile.mkstemp(suffix='.uvl')
+    try:
+        with os.fdopen(handle, 'w') as file:
+            file.write(text)
+        return FmToZ3(UVLReader(path).transform(), cnf_method=cnf_method).transform()
+    finally:
+        os.remove(path)
+
+
+def _projected(model):
+    configs = Z3Configurations().execute(model).get_result()
+    return {frozenset(k for k, v in c.elements.items() if v is True) for c in configs}
+
+
+def test_tseytin_matches_direct_on_propositional_model() -> None:
+    direct = _build_from_uvl_text(_PROP_UVL, 'direct')
+    tseytin = _build_from_uvl_text(_PROP_UVL, 'tseytin')
+
+    assert Z3ConfigurationsNumber().execute(direct).get_result() == \
+        Z3ConfigurationsNumber().execute(tseytin).get_result()
+    assert _projected(direct) == _projected(tseytin)
+    assert tseytin.auxiliary_variables  # gates were introduced
+    # Auxiliary variables must not have been registered as features.
+    assert not set(str(a) for a in tseytin.auxiliary_variables) & set(tseytin.features.keys())
+
+
+def test_tseytin_falls_back_for_arithmetic_constraints() -> None:
+    direct = FmToZ3(UVLReader(_ARITH_MODEL).transform(), cnf_method='direct').transform()
+    tseytin = FmToZ3(UVLReader(_ARITH_MODEL).transform(), cnf_method='tseytin').transform()
+
+    # Nothing was propositional, so no auxiliary variables were created.
+    assert tseytin.auxiliary_variables == []
+    assert Z3Satisfiable().execute(direct).get_result() == \
+        Z3Satisfiable().execute(tseytin).get_result()
+    assert Z3ConfigurationsNumber().execute(direct).get_result() == \
+        Z3ConfigurationsNumber().execute(tseytin).get_result()

flamapy_z3-2.6.0.dev4/flamapy/metamodels/z3_metamodel/operations/interfaces/attribute_optimization.py

@@ -1,27 +0,0 @@
-from abc import abstractmethod
-from enum import Enum
-
-from flamapy.core.operations import Operation
-from flamapy.metamodels.configuration_metamodel.models import Configuration
-from flamapy.metamodels.fm_metamodel.models import Attribute
-
-
-class OptimizationGoal(Enum):
-    MAXIMIZE = 'Maximize'
-    MINIMIZE = 'Minimize'
-
-
-class AttributeOptimization(Operation):
-    """This operation returns the configurations that optimize the given attribute(s)."""
-
-    @abstractmethod
-    def __init__(self) -> None:
-        pass
-
-    @abstractmethod
-    def set_attributes(self, attributes: dict[Attribute, OptimizationGoal]) -> None:
-        pass
-
-    @abstractmethod
-    def optimize(self) -> list[Configuration]:
-        pass