Move EndpointBddTrait to traits, address PR issues

Author: mtdowling

docs/source-2.0/additional-specs/rules-engine/specification.rst

@@ -94,8 +94,8 @@ on the scenario.
     This trait is experimental and subject to change.
 
 Summary
-    A Binary Decision Diagram (BDD) <https://en.wikipedia.org/wiki/Binary_decision_diagram>_ representation of endpoint
-    rules that is more compact and efficient at runtime than the decision-tree-based EndpointRuleSet trait.
+    A Binary `Decision Diagram (BDD) <https://en.wikipedia.org/wiki/Binary_decision_diagram>`_ representation of
+    endpoint rules that is more compact and efficient at runtime than the decision-tree-based EndpointRuleSet trait.
 Trait selector
     ``service``
 Value type

smithy-aws-endpoints/src/main/java/software/amazon/smithy/rulesengine/aws/validators/RuleSetAwsBuiltInValidator.java

@@ -14,7 +14,7 @@
 import software.amazon.smithy.model.validation.ValidationEvent;
 import software.amazon.smithy.rulesengine.aws.language.functions.AwsBuiltIns;
 import software.amazon.smithy.rulesengine.language.syntax.parameters.Parameter;
-import software.amazon.smithy.rulesengine.logic.bdd.EndpointBddTrait;
+import software.amazon.smithy.rulesengine.traits.EndpointBddTrait;
 import software.amazon.smithy.rulesengine.traits.EndpointRuleSetTrait;
 import software.amazon.smithy.utils.SetUtils;
 

smithy-rules-engine/src/main/java/software/amazon/smithy/rulesengine/analysis/BddCoverageChecker.java

@@ -20,7 +20,7 @@
 import software.amazon.smithy.rulesengine.language.syntax.rule.Rule;
 import software.amazon.smithy.rulesengine.logic.ConditionEvaluator;
 import software.amazon.smithy.rulesengine.logic.bdd.Bdd;
-import software.amazon.smithy.rulesengine.logic.bdd.EndpointBddTrait;
+import software.amazon.smithy.rulesengine.traits.EndpointBddTrait;
 import software.amazon.smithy.rulesengine.traits.EndpointTestCase;
 
 /**

smithy-rules-engine/src/main/java/software/amazon/smithy/rulesengine/language/evaluation/RuleEvaluator.java

@@ -27,7 +27,7 @@
 import software.amazon.smithy.rulesengine.language.syntax.rule.RuleValueVisitor;
 import software.amazon.smithy.rulesengine.logic.RuleBasedConditionEvaluator;
 import software.amazon.smithy.rulesengine.logic.bdd.Bdd;
-import software.amazon.smithy.rulesengine.logic.bdd.EndpointBddTrait;
+import software.amazon.smithy.rulesengine.traits.EndpointBddTrait;
 import software.amazon.smithy.utils.SmithyUnstableApi;
 
 /**

smithy-rules-engine/src/main/java/software/amazon/smithy/rulesengine/language/evaluation/TestEvaluator.java

@@ -13,7 +13,7 @@
 import software.amazon.smithy.rulesengine.language.evaluation.value.EndpointValue;
 import software.amazon.smithy.rulesengine.language.evaluation.value.Value;
 import software.amazon.smithy.rulesengine.language.syntax.Identifier;
-import software.amazon.smithy.rulesengine.logic.bdd.EndpointBddTrait;
+import software.amazon.smithy.rulesengine.traits.EndpointBddTrait;
 import software.amazon.smithy.rulesengine.traits.EndpointTestCase;
 import software.amazon.smithy.rulesengine.traits.EndpointTestExpectation;
 import software.amazon.smithy.rulesengine.traits.ExpectedEndpoint;

smithy-rules-engine/src/main/java/software/amazon/smithy/rulesengine/language/syntax/expressions/functions/Coalesce.java

@@ -20,7 +20,7 @@
 /**
  * A coalesce function that returns the first non-empty value.
  *
- * <p>This variadic function requires two or more arguments. At runtime, returns the first arguments that returns a
+ * <p>This variadic function requires two or more arguments. At runtime, returns the first argument that contains a
  * non-EmptyValue, otherwise returns the result of the last argument.
  *
  * <p>Type checking rules:

smithy-rules-engine/src/main/java/software/amazon/smithy/rulesengine/logic/bdd/Bdd.java

@@ -71,9 +71,15 @@ public Bdd(int rootRef, int conditionCount, int resultCount, int nodeCount, Cons
     }
 
     /**
-     * Package-private constructor for direct array initialization (used by BddTrait).
+     * Creates a BDD by streaming nodes directly into the structure.
+     *
+     * @param rootRef the root reference
+     * @param conditionCount the number of conditions
+     * @param resultCount the number of results
+     * @param nodeCount the exact number of nodes
+     * @param nodes BDD nodes array where the condition, high, and low are all in succession.
      */
-    Bdd(int rootRef, int conditionCount, int resultCount, int nodeCount, int[] nodes) {
+    public Bdd(int rootRef, int conditionCount, int resultCount, int nodeCount, int[] nodes) {
         validateCounts(conditionCount, resultCount, nodeCount);
         validateRootReference(rootRef, nodeCount);
 

smithy-rules-engine/src/main/java/software/amazon/smithy/rulesengine/logic/bdd/BddCompiler.java

@@ -19,11 +19,13 @@
 import software.amazon.smithy.rulesengine.logic.cfg.CfgNode;
 import software.amazon.smithy.rulesengine.logic.cfg.ConditionNode;
 import software.amazon.smithy.rulesengine.logic.cfg.ResultNode;
+import software.amazon.smithy.utils.SmithyInternalApi;
 
 /**
- * BDD compiler that builds an unreduced BDD from CFG.
+ * BDD compiler that builds a BDD from a CFG.
  */
-final class BddCompiler {
+@SmithyInternalApi
+public final class BddCompiler {
     private static final Logger LOGGER = Logger.getLogger(BddCompiler.class.getName());
 
     private final Cfg cfg;
@@ -43,6 +45,13 @@ final class BddCompiler {
     // Simple cache to avoid recomputing identical subgraphs
     private final Map<CfgNode, Integer> nodeCache = new HashMap<>();
 
+    /**
+     * @param cfg CFG to convert to a BDD.
+     */
+    public BddCompiler(Cfg cfg) {
+        this(cfg, new BddBuilder());
+    }
+
     BddCompiler(Cfg cfg, BddBuilder bddBuilder) {
         this(cfg, OrderingStrategy.initialOrdering(cfg), bddBuilder);
     }
@@ -53,7 +62,12 @@ final class BddCompiler {
         this.bddBuilder = Objects.requireNonNull(bddBuilder, "BDD builder cannot be null");
     }
 
-    Bdd compile() {
+    /**
+     * Compile the CFG into a BDD.
+     *
+     * @return the compiled BDD.
+     */
+    public Bdd compile() {
         long start = System.currentTimeMillis();
         extractAndOrderConditions();
 
@@ -77,11 +91,21 @@ Bdd compile() {
         return bdd;
     }
 
-    List<Rule> getIndexedResults() {
+    /**
+     * The ordered result rules after BDD compilation.
+     *
+     * @return ordered BDD result rules.
+     */
+    public List<Rule> getIndexedResults() {
         return indexedResults;
     }
 
-    List<Condition> getOrderedConditions() {
+    /**
+     * Get the ordered conditions referenced in the compiled BDD.
+     *
+     * @return the ordered BDD conditions.
+     */
+    public List<Condition> getOrderedConditions() {
         return orderedConditions;
     }
 

smithy-rules-engine/src/main/java/software/amazon/smithy/rulesengine/logic/bdd/NodeReversal.java

@@ -6,6 +6,7 @@
 
 import java.util.function.Function;
 import java.util.logging.Logger;
+import software.amazon.smithy.rulesengine.traits.EndpointBddTrait;
 
 /**
  * Reverses the node ordering in a BDD from bottom-up to top-down for better cache locality.

smithy-rules-engine/src/main/java/software/amazon/smithy/rulesengine/logic/bdd/SiftingOptimization.java

@@ -18,6 +18,7 @@
 import software.amazon.smithy.rulesengine.language.syntax.rule.Rule;
 import software.amazon.smithy.rulesengine.logic.cfg.Cfg;
 import software.amazon.smithy.rulesengine.logic.cfg.ConditionDependencyGraph;
+import software.amazon.smithy.rulesengine.traits.EndpointBddTrait;
 import software.amazon.smithy.utils.SmithyBuilder;
 
 /**