Add logger back

Author: abelsiqueira

src/logger.jl

@@ -0,0 +1,88 @@
+export log_header, log_row
+
+const formats = Dict{DataType, String}(Signed => "%6d",
+                                       AbstractFloat => "%8.1e",
+                                       AbstractString => "%15s",
+                                       Symbol => "%15s",
+                                       Missing => "%15s"
+                                      )
+
+const default_headers = Dict{Symbol, String}(:name => "Name",
+                                             :elapsed_time => "Time",
+                                             :objective => "f(x)",
+                                             :dual_feas => "Dual",
+                                             :primal_feas => "Primal")
+
+for (typ, fmt) in formats
+  hdr_fmt_foo = Symbol("header_formatter_$typ")
+  len = match(r"\%([0-9]*)", fmt)[1]
+  fmt2 = "%$(len)s"
+
+  @eval begin
+    row_formatter(x :: $typ) = @sprintf($fmt, x)
+    row_formatter(:: Type{<:$typ}) = @sprintf($fmt2, "-")
+
+    $hdr_fmt_foo(x) = @sprintf($fmt2, x)
+    header_formatter(x :: Union{Symbol,String}, :: Type{<:$typ}) = $hdr_fmt_foo(x)
+  end
+end
+
+"""
+    log_header(colnames, coltypes)
+
+Creates a header using the names in `colnames` formatted according to the types in `coltypes`.
+Uses internal formatting specification given by `SolverCore.formats` and default header
+translation given by `SolverCore.default_headers`.
+
+Input:
+- `colnames::Vector{Symbol}`: Column names.
+- `coltypes::Vector{DataType}`: Column types.
+
+Keyword arguments:
+- `hdr_override::Dict{Symbol,String}`: Overrides the default headers.
+- `colsep::Int`: Number of spaces between columns (Default: 2)
+
+See also [`log_row`](@ref).
+"""
+function log_header(colnames :: AbstractVector{Symbol}, coltypes :: AbstractVector{DataType};
+                    hdr_override :: Dict{Symbol,String} = Dict{Symbol,String}(),
+                    colsep :: Int = 2,
+                   )
+  out_vec = String[]
+  for (name, typ) in zip(colnames, coltypes)
+    x = if haskey(hdr_override, name)
+      hdr_override[name]
+    elseif haskey(default_headers, name)
+      default_headers[name]
+    else
+      string(name)
+    end
+    push!(out_vec, header_formatter(x, typ))
+  end
+  return join(out_vec,  " "^colsep)
+end
+
+"""
+    log_row(vals)
+
+Creates a table row from the values on `vals` according to their types. Pass the names
+and types of `vals` to [`log_header`](@ref) for a logging table. Uses internal formatting
+specification given by `SolverCore.formats`.
+
+To handle a missing value, add the type instead of the number:
+
+    @info log_row(Any[1.0, 1])
+    @info log_row(Any[Float64, Int])
+
+Prints
+
+    [ Info:  1.0e+00       1
+    [ Info:        -       -
+
+Keyword arguments:
+- `colsep::Int`: Number of spaces between columns (Default: 2)
+"""
+function log_row(vals; colsep :: Int = 2)
+  string_cols = (row_formatter(val) for val in vals)
+  return join(string_cols, " "^colsep)
+end

test/logger.jl

@@ -0,0 +1,9 @@
+@testset "Logger" begin
+  @info "Testing logger"
+  s = log_header([:col_real, :col_int, :col_symbol, :col_string], [Float64, Int, Symbol, String])
+  @test s == @sprintf("%8s  %6s  %15s  %15s", "col_real", "col_int", "col_symbol", "col_string")
+  s = log_row([1.0, 1, :one, "one"])
+  @test s == @sprintf("%8.1e  %6d  %15s  %15s", 1.0, 1, "one", "one")
+  s = log_row([Float64, Int, Symbol, String])
+  @test s == @sprintf("%8s  %6s  %15s  %15s", "-", "-", "-", "-")
+end