Pretty printing (#35)

* Add a pretty print function for parameters used by a collection of constraints

* Add pretty printing for parameters and descriptions.

* New version

Author: Azzaare

Project.toml

@@ -1,7 +1,7 @@
 name = "Constraints"
 uuid = "30f324ab-b02d-43f0-b619-e131c61659f7"
 authors = ["Jean-François Baffier"]
-version = "0.5.1"
+version = "0.5.2"
 
 [deps]
 CompositionalNetworks = "4b67e4b5-442d-4ef5-b760-3f5df3a57537"

src/Constraints.jl

@@ -10,7 +10,7 @@ using PrettyTables
 using TestItemRunner
 using TestItems
 
-import ConstraintCommons: extract_parameters
+import ConstraintCommons: extract_parameters, USUAL_CONSTRAINT_PARAMETERS
 
 # Exports
 export Constraint
@@ -20,6 +20,8 @@ export USUAL_SYMMETRIES
 
 export args
 export concept
+export constraints_parameters
+export constraints_descriptions
 export describe
 export error_f
 export extract_parameters

src/constraints/all_equal.jl

@@ -6,6 +6,7 @@ concept_all_equal(x, val) = all(y -> y == val, x)
 
 xcsp_all_equal(; list) = concept_all_equal(list; val=first(list))
 
-@usual concept_all_equal(x; val=nothing) = concept_all_equal(x, val)
-
+@usual function concept_all_equal(x; val=nothing, pair_vars=zero(x))
+    return concept_all_equal(x+pair_vars, val)
+end
 concept_all_equal(x, ::Nothing) = xcsp_all_equal(list=x)

src/constraints/extension.jl

@@ -1,5 +1,7 @@
 ##!NOTE - constraints of type extension represent a list of supported or conflicted tuples
 
+# TODO - Better input for conflicts and supports (cf XCSP3-core)
+
 xcsp_extension(list, ::Nothing, conflicts) = list ∉ conflicts
 xcsp_extension(list, supports, _) = list ∈ supports
 
@@ -8,16 +10,16 @@ function xcsp_extension(; list, supports=nothing, conflicts=nothing)
 end
 
 function concept_extension(x, pair_vars::Vector{T}) where {T <: Number}
-    return xcsp_extension(list = x, supports = pair_vars[1], conflicts = nothing)
+    return xcsp_extension(list = x, supports = pair_vars)
 end
 
 function concept_extension(x, pair_vars)
     supports = pair_vars[1]
     conflicts = pair_vars[2]
-    return xcsp_extension(; list = x, supports, conflicts)
+    return xcsp_extension(; list = x, supports) || xcsp_extension(; list = x, conflicts)
 end
 
-const description_extension = """Global constraint ensuring that all ...`"""
+const description_extension = """Global constraint ensuring that `x` is in the set of configurations given by `pair_vars[1]` and not in the set given by `pair_vars[2]`: `x ∈ pair_vars[1] || x ∉ pair_vars[2]`"""
 
 @usual concept_extension(x; pair_vars) = concept_extension(x, pair_vars)
 

src/constraints/intention.jl

@@ -1,5 +1,7 @@
 #!NOTE - constraints of type intension represent general predicate over a set of variables
 
+# TODO - Add a DSL for intension (cf XCSP3-core)
+
 const description_dist_different = """Local constraint ensuring that `concept(dist_different, x) = |x[1] - x[2]| ≠ |x[3] - x[4]|`"""
 
 """

src/constraints/sum.jl

@@ -1,6 +1,6 @@
 xcsp_sum(; list, coeffs, condition) = condition[1](sum(coeffs .* list), condition[2])
 
-const description_sum = """Global constraint ensuring that ..."""
+const description_sum = """Global constraint ensuring that `op(sum(x *. pair_vars), val)` is true. Defaults to `op = ==` and `pair_vars = ones(eltype(x), length(x))`"""
 
 @usual function concept_sum(x; op = ==, pair_vars = ones(eltype(x), length(x)), val)
     return xcsp_sum(list = x, coeffs = pair_vars, condition = (op, val))

src/usual_constraints.jl

@@ -79,6 +79,64 @@ macro usual(ex::Expr)
     return nothing
 end
 
+function constraints_parameters(C=USUAL_CONSTRAINTS)
+    df = DataFrame(Constraint=Symbol[], bool=String[], dim=String[], id=String[], language=String[], op=String[], pair_vars=String[], val=String[], vals=String[])
+
+    for (s,c) in C
+        base = vcat([s], fill("", length(USUAL_CONSTRAINT_PARAMETERS)))
+        for P in c.params
+            push!(df, base)
+            for (p, b) in P
+                df[end, p] = b == 1 ? "o" : "×"
+            end
+        end
+    end
+
+    sort!(df)
+
+    hl_odd = Highlighter(
+        f = (data, i, j) -> i % 2 == 0,
+        crayon = Crayon(background = :light_blue),
+    )
+
+    return pretty_table(
+        df;
+        highlighters = hl_odd,
+        header_crayon = crayon"yellow bold",
+        title = "Available parameters per constraint (× -> required, o -> optional)",
+        show_subheader=false,
+        crop=:none,
+    )
+end
+
+function constraints_descriptions(C=USUAL_CONSTRAINTS)
+    df = DataFrame(Constraint=Symbol[], Description=String[])
+
+    for (s,c) in C
+        push!(df, [s, c.description])
+    end
+
+    sort!(df)
+
+    hl_odd = Highlighter(
+        f = (data, i, j) -> i % 2 == 0,
+        crayon = Crayon(background = :light_blue),
+    )
+
+    return pretty_table(
+        df;
+        # highlighters = hl_odd,
+        header_crayon = crayon"yellow bold",
+        autowrap = true,
+        linebreaks = true,
+        columns_width = [0,80],
+        hlines = :all,
+        alignment=:l,
+        show_subheader=false,
+        crop=:none,
+    )
+end
+
 ## SECTION - Test Items
 @testitem "Usual constraints" tags = [:usual, :constraints] default_imports=false begin
     using ConstraintDomains