Merge pull request #55 from Herb-AI/fix/enforce-constraint-domain

Fix/enforce constraint domain

Author: pwochner

Project.toml

@@ -1,7 +1,7 @@
 name = "HerbCore"
 uuid = "2b23ba43-8213-43cb-b5ea-38c12b45bd45"
 authors = ["Jaap de Jong <jaapdejong15@gmail.com>", "Nicolae Filat <N.Filat@student.tudelft.nl>", "Tilman Hinnerichs <t.r.hinnerichs@tudelft.nl>", "Sebastijan Dumancic <s.dumancic@tudelft.nl>"]
-version = "0.3.10"
+version = "0.3.11"
 
 [deps]
 AbstractTrees = "1520ce14-60c1-5f80-bbc7-55ef81b5835c"

src/HerbCore.jl

@@ -35,6 +35,7 @@ export
        have_same_shape, AbstractConstraint,
        AbstractGrammar,
        print_tree,
-       update_rule_indices!
+       update_rule_indices!,
+       is_domain_valid
 
 end # module HerbCore

src/indexing.jl

@@ -4,3 +4,15 @@
 Updates the rule indices of the given rule node, hole or grammar constraint when the grammar changes. 
 """
 function update_rule_indices! end
+
+"""
+    is_domain_valid(x, n_rules::Integer)
+    is_domain_valid(x, grammar::AbstractGrammar)
+
+Check if the domain for the given object `x` (ex: [`RuleNode`](@ref),
+[`Hole`](@ref) or [`AbstractConstraint`](@ref)) is valid given the provided
+grammar or number of rules.
+
+If [`isfilled`](@ref)`(x)` and `x` has children, it checks if all children are valid.
+"""
+function is_domain_valid end

src/rulenode.jl

@@ -90,6 +90,18 @@ function update_rule_indices!(
     end
 end
 
+"""
+    is_domain_valid(node::RuleNode, n_rules::Integer)
+
+Check whether the `node`'s rule index exceeds the number of rules `n_rules.`
+"""
+function is_domain_valid(node::RuleNode, n_rules::Integer)
+    if get_rule(node) > n_rules
+        return false
+    end
+    all(child -> is_domain_valid(child, n_rules), get_children(node))
+end
+
 """
 	AbstractHole <: AbstractRuleNode
 
@@ -120,6 +132,18 @@ end
 
 UniformHole(domain) = UniformHole(domain, AbstractRuleNode[])
 
+"""
+    is_domain_valid(hole::AbstractHole, n_rules::Integer)
+
+Check if `hole`'s domain length matches `n_rules`.
+"""
+function is_domain_valid(hole::AbstractHole, n_rules::Integer)
+    if length(hole.domain) != n_rules
+        return false
+    end
+    all(child -> is_domain_valid(child, n_rules), get_children(hole))
+end
+
 """
 	update_rule_indices!(node::AbstractHole, n_rules::Integer)
 

test/test_rulenode.jl

@@ -503,4 +503,14 @@
             end
         end
     end
+    @testset "is_domain_valid" begin
+        node = @rulenode 1{2, 3, 4{5{7}, 6{9{10}}}}
+        n_rules = 10
+        @test is_domain_valid(node, n_rules) == true
+        @test is_domain_valid(node, 9) == false
+
+        hole = UniformHole(BitVector((1, 1, 0, 0)), [RuleNode(3), RuleNode(4)])
+        @test is_domain_valid(hole, 9) == false
+        @test is_domain_valid(hole, 4) == true
+    end
 end