Merge pull request #10 from EdoAlvarezR/master

Beautify display of OptimizationParameters

Author: tylercritchfield

Project.toml

@@ -1,7 +1,7 @@
 name = "OptimizationParameters"
 uuid = "7e4d55e1-29a6-451b-8e82-71170a6dda04"
 authors = ["Taylor McDonnell <taylor.golden.mcdonnell@gmail.com> and contributors"]
-version = "0.1.0"
+version = "0.1.1"
 
 [deps]
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"

src/OptimizationParameters.jl

@@ -22,6 +22,67 @@ end
 Base.size(::OptimizationParameter{S, TX, TF, TB, DV}) where {S, TX, TF, TB, DV} = S
 Base.eltype(::OptimizationParameter{S, TX, TF, TB, DV}) where {S, TX, TF, TB, DV} = TX
 
+function Base.show(io::IO, op::OptimizationParameter{S, TX, TF, TB, DV}
+                                                    ) where {S, TX, TF, TB, DV}
+
+    type = DV ? "Design variable" : "Constant"
+
+    println(io, "$(type) OptimizationParameter (type $(TX), size $(size(op)))")
+    println(io, "├─ description:\t$(op.description)")
+    if DV
+        println(io, "├─ value:\t$(op.x0)")
+        println(io, "├─ lower bound:\t$(op.lb)")
+        println(io, "├─ upper bound:\t$(op.ub)")
+        println(io,   "└─ scaling:\t$(op.scaling)")
+    else
+        println(io, "└─ value:\t$(op.x0)")
+    end
+
+end
+
+function Base.show(io::IO, ops::Union{NamedTuple{<:Any, <:Tuple{Vararg{OptimizationParameter}}}, AbstractDict{<:Any, <:OptimizationParameter}})
+
+    ndv = sum(count(op.dv) for op in ops)
+    nconst = sum(length(op.dv) - count(op.dv) for op in ops)
+
+    println(io, "$(typeof(ops).name.name) of $(length(ops)) OptimizationParameters")
+
+    # Print design variables
+    println(io, "│")
+    println(io, "├─ $(ndv) design variables")
+
+    count_ndv = 0
+    for (name, op) in pairs(ops)
+        this_ndv = count(op.dv)
+        if this_ndv >= 1
+
+            count_ndv += this_ndv
+
+            branch = count_ndv == ndv ? "└─" : "├─"
+
+            println(io, "│  $(branch) $(rpad(name, 15)):\t$(rpad(op.x0, 15))\t(between $(op.lb) and $(op.ub), scaled by $(op.scaling))")
+        end
+    end
+
+    # Print constants
+    println(io, "│")
+    println(io, "└─ $(nconst) constants")
+
+    count_nconst = 0
+    for (name, op) in pairs(ops)
+        this_nconst = length(op.dv) - count(op.dv)
+        if this_nconst >= 1
+
+            count_nconst += this_nconst
+
+            branch = count_nconst == nconst ? "└─" : "├─"
+
+            println(io, "   $(branch) $(rpad(name, 15)):\t$(op.x0)")
+        end
+    end
+
+end
+
 """
     OptimizationParameter(x0; lb=-Inf, ub=Inf, scaling=1.0, dv=false, description="")