Feature table logger (#277)

* use TableLogger.jl
* removed previous tablelogger
* Only Julia v1.6 and v0.1 of TableLogger not double CI

Author: Wikunia

.github/workflows/ci.yml

@@ -1,7 +1,10 @@
 name: CI
 on:
-  - push
-  - pull_request
+  push:
+    branches:
+      - master
+    tags: '*'
+  pull_request:
 jobs:
   test:
     name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
@@ -10,7 +13,7 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.2'
+          - '1.6'
           - '1'
         os:
           - ubuntu-latest

CHANGELOG.md

@@ -1,5 +1,8 @@
 # ConstrainSolver.jl - Changelog
 
+## v0.8.0 (not yet released)
+- Using [TableLogger.jl](https://github.com/Wikunia/TableLogger.jl)
+- Only support Julia v1.6 and above
 ## v0.7.1 (1st of November 2021)
 - Using priority queue also for `BFS` problems [PR #274](https://github.com/Wikunia/ConstraintSolver.jl/pull/274)
 

Project.toml

@@ -16,6 +16,7 @@ Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
 StatsFuns = "4c63d2b9-4356-54db-8cca-17b64c39e42c"
+TableLogger = "72b659bb-f61b-4d0d-9dbb-0f81f57d8545"
 
 [compat]
 ConstraintProgrammingExtensions = "^0.3"
@@ -28,4 +29,5 @@ MathOptInterface = "^0.9.11"
 MatrixNetworks = "^1"
 StatsBase = "^0.33"
 StatsFuns = "^0.9.5"
-julia = "^1.2"
+TableLogger = "^0.1"
+julia = "^1.6"

src/ConstraintSolver.jl

@@ -28,6 +28,7 @@ using Random
 using Statistics
 using StatsBase
 using StatsFuns
+using TableLogger
 
 const CPE = ConstraintProgrammingExtensions
 
@@ -51,7 +52,6 @@ const VAR_TYPES = Union{MOI.ZeroOne,MOI.Integer}
 include("types.jl")
 const CoM = ConstraintSolverModel
 
-include("tablelogger.jl")
 include("options.jl")
 
 
@@ -409,7 +409,7 @@ function add_new_solution!(
         new_sol_obj = Solution(new_sol, CS.value.(com.search_space), backtrack_obj.idx)
         push!(com.solutions, new_sol_obj)
         com.best_sol = new_sol
-        log_table && (last_table_row = update_table_log(com, backtrack_vec; force = true))
+        log_table && update_table_log(com, backtrack_vec)
         if com.best_sol == com.best_bound && !find_more_solutions
             return true
         end
@@ -429,7 +429,7 @@ function add_new_solution!(
             end
         end
     else # if new solution was found but it's worse
-        log_table && (last_table_row = update_table_log(com, backtrack_vec; force = true))
+        log_table && update_table_log(com, backtrack_vec)
         if com.options.all_solutions
             new_sol_obj = Solution(new_sol, CS.value.(com.search_space), backtrack_obj.idx)
             push!(com.solutions, new_sol_obj)
@@ -547,7 +547,7 @@ function backtrack!(
 
     find_more_solutions = com.options.all_solutions || com.options.all_optimal_solutions
 
-    log_table && println(get_header(com.options.table))
+    log_table && print_header(com.options.table)
 
     backtrack_vec = com.backtrack_vec
 
@@ -626,7 +626,7 @@ function backtrack!(
         cb_finished_pruning(com)
 
         if log_table
-            last_table_row = update_table_log(com, backtrack_vec)
+            update_table_log(com, backtrack_vec)
         end
 
         branch_var = get_next_branch_variable(com)

src/options.jl

@@ -31,15 +31,14 @@ const POSSIBLE_OPTIONS = Dict(
 
 function SolverOptions()
     logging = [:Info, :Table]
-    table = TableSetup(
-        [
-            CS.TableCol(:open_nodes, "#Open", Int, 10, :center),
-            CS.TableCol(:closed_nodes, "#Closed", Int, 10, :center),
-            CS.TableCol(:incumbent, "Incumbent", Float64, 20, :center),
-            CS.TableCol(:best_bound, "Best Bound", Float64, 20, :center),
-            CS.TableCol(:duration, "Time [s]", Float64, 10, :center),
-        ],
-        Dict(:min_diff_duration => 5.0),
+
+    table = init_log_table(
+            (id=:open_nodes, name="#Open", width=10),
+            (id=:closed_nodes, name="#Closed", width=10),
+            (id=:incumbent, name="Incumbent", width=20),
+            (id=:best_bound, name="Best Bound", width=20),
+            (id=:duration, name="Time [s]", width=10);
+            alignment=:center
     )
     seed = 1
     traverse_strategy = :Auto

src/tablelogger.jl

@@ -1,27 +1,3 @@
-# TableLogger
-
-mutable struct TableCol
-    id::Symbol
-    name::String
-    type::DataType
-    width::Int
-    alignment::Symbol # :left, :center, :right
-    b_format::Bool
-end
-
-mutable struct TableEntry{T}
-    col_id::Symbol
-    value::T
-end
-
-mutable struct TableSetup
-    cols::Vector{TableCol}
-    col_idx::Dict{Symbol,Int}
-    new_row_criteria::Bool
-    diff_criteria::Dict{Symbol,Any}
-    last_row::Vector{TableEntry}
-end
-
 # SolverOptions
 mutable struct ActivityOptions
     decay::Float64
@@ -31,7 +7,7 @@ end
 
 mutable struct SolverOptions
     logging::Vector{Symbol}
-    table::TableSetup
+    table::TableLogger.Table
     time_limit::Float64 # time limit in backtracking in seconds
     seed::Int
     traverse_strategy::Symbol

src/types.jl

@@ -70,23 +70,21 @@ end
 
 Push the new information to the TableLogger and if `force` produce a new line otherwise the TableLogger decides
 """
-function update_table_log(com::CS.CoM, backtrack_vec; force = false)
+function update_table_log(com::CS.CoM, backtrack_vec)
     table = com.options.table
     open_nodes = count(n -> n.status == :Open, backtrack_vec)
     # -1 for dummy node
     closed_nodes = length(backtrack_vec) - open_nodes - 1
     best_bound = com.best_bound
     incumbent = length(com.solutions) == 0 ? "-" : com.best_sol
     duration = time() - com.start_time
-    push_to_table!(
-        table;
-        force = force,
-        open_nodes = open_nodes,
-        closed_nodes = closed_nodes,
-        incumbent = incumbent,
-        best_bound = best_bound,
-        duration = duration,
-    )
+
+    set_value!(table, :open_nodes, Diff10(open_nodes))
+    set_value!(table, :closed_nodes, Diff10(closed_nodes))
+    set_value!(table, :incumbent, incumbent)
+    set_value!(table, :best_bound, best_bound)
+    set_value!(table, :duration, Diff5(duration))
+    print_line(table; force=false)
 end
 
 """