Support configurable comparison operations in the default comparison type

Author: BenChung

src/test/discrete/compare.jl

@@ -1,7 +1,28 @@
+struct DefaultComparison
+    field_cmp::Dict{Symbol, Function}
+    function DefaultComparison(field_cmp::Dict{Symbol, Function}=Dict{Symbol, Function}(); use_defaults=true) 
+        if use_defaults
+            merge!(field_cmp, Dict{Symbol, Function}([
+                :L∞ => (delta, t) -> norm.(delta, Inf), 
+                :L1 => (delta, t) -> norm.(delta, 1), 
+                :L2 => (delta, t) -> norm.(delta, 2), 
+                :rms => (delta, t) -> sqrt.(1/length(t) .* sum.(map(d-> d .^ 2, delta)))]))
+        end
+        return new(field_cmp)
+    end
+end
+function (d::DefaultComparison)(c, b, t, n, r) 
+    delta = map((o, re) -> o .- re, n, r)
+    cmps = [name => cmper(delta, t) for (name, cmper) in d.field_cmp]
+    return DataFrame([:var => b, cmps...,
+        :observed => SymbolicIndexingInterface.is_observed.(c, b)])
+end
+
+
 function compare(
     new_sol::SciMLBase.AbstractTimeseriesSolution, basis::Vector, 
     reference::DataFrame, reference_basis::Vector,
-    cmp::Function; warn_observed=true)
+    cmp; warn_observed=true)
     @assert "timestamp" ∈ names(reference) "The dataset must contain a column named `timestamp`"
     new_container = SymbolicIndexingInterface.symbolic_container(new_sol)
     @assert all(SymbolicIndexingInterface.is_observed.((new_container, ), basis) .| SymbolicIndexingInterface.is_variable.((new_container, ), basis)) "All basis symbols must be observed in the new system"
@@ -10,7 +31,7 @@ function compare(
         dat = new_sol(reference[:, :timestamp], idxs=basis)
         obs = [[dat[j][i] for j=1:nrow(reference)] for i in eachindex(basis)]
         ref = collect.(eachcol(reference[:, Not(:timestamp)]))
-        cmp(basis, reference[:, :timestamp], obs, ref)
+        cmp(new_container, basis, reference[:, :timestamp], obs, ref)
     else 
         foldl(red, cmp(row[:timestamp], new_sol[row[:timestamp], basis], row[reference_basis]) for row in eachrow(reference); init=isnothing(init) ? nothing : init(basis))
     end
@@ -19,7 +40,7 @@ end
 function compare(
     new_sol::SciMLBase.AbstractTimeseriesSolution,
     reference::DataFrame,
-    cmp::Function; to_name=string, warn_observed=true)
+    cmp=DefaultComparison(); to_name=string, warn_observed=true)
     @assert "timestamp" ∈ names(reference) "The dataset must contain a column named `timestamp`"
 
     new_container = SymbolicIndexingInterface.symbolic_container(new_sol)
@@ -35,22 +56,4 @@ function compare(
     end for ref_name in setdiff(names(reference), ["timestamp"])] 
     return compare(new_sol, eval_syms, reference, setdiff(names(reference), ["timestamp"]), cmp)
 end
-
-function compare(
-    new_sol::SciMLBase.AbstractTimeseriesSolution,
-    reference::DataFrame; warn_observed=true)
-    @assert "timestamp" ∈ names(reference) "The dataset must contain a column named `timestamp`"
-    new_container = SymbolicIndexingInterface.symbolic_container(new_sol)
-    return compare(new_sol, reference, 
-        (b, t, n, r) -> begin
-            delta = map((o, re) -> o .- re, n, r)
-            return DataFrame(:var => b, 
-                :L∞ => norm.(delta, Inf), 
-                :L1 => norm.(delta, 1), 
-                :L2 => norm.(delta, 2), 
-                :rms => sqrt.(1/length(t) .* sum.(map(d-> d .^ 2, delta))),
-                :observed => SymbolicIndexingInterface.is_observed.(new_container, b))
-        end,
-        warn_observed=warn_observed)
-end
 export compare