Add equality methods for ITime

Adds Base.(==) between ITime and DateTime and
between ITime and a number, which is assumed to represent seconds.

Throw error when comparing ITime to Number for ==

Apply formatting

Author: imreddyTeja

src/ITime.jl

@@ -279,6 +279,18 @@ function Base.:*(a::AbstractFloat, t::ITime)
     end
 end
 
+Base.:(==)(t1::ITime, t2::Number) = error("Cannot compare ITime with a Number")
+Base.:(==)(t1::Number, t2::ITime) = t2 == t1
+
+"""
+    Base.:(==)(t1::ITime, t2::Dates.DateTime)
+
+Converts `t1` to a `DateTime` and checks for equality with `t2`. `t1` must have an `epoch`
+`t1==t2` ⟺ `t2==t1`
+"""
+Base.:(==)(t1::ITime, t2::Dates.DateTime) = date(t1) == t2
+Base.:(==)(t1::Dates.DateTime, t2::ITime) = t2 == t1
+
 """
     Base.:(:)(start::ITime, step::ITime, stop::ITime)
 

src/OnlineLogging.jl

@@ -148,7 +148,8 @@ function report_walltime(wt, integrator)
 
     wall_time_ave_per_step = wt.∑Δt_wall[] / n_steps
     wall_time_ave_per_step_str = _time_and_units_str(wall_time_ave_per_step)
-    percent_complete = round((t - t_start) / (t_end - t_start) * 100; digits = 1)
+    percent_complete =
+        round((t - t_start) / (t_end - t_start) * 100; digits = 1)
     n_steps_remaining = n_steps_total - n_steps
     wall_time_remaining = wall_time_ave_per_step * n_steps_remaining
     wall_time_remaining_str = _time_and_units_str(wall_time_remaining)

test/itime.jl

@@ -215,6 +215,20 @@ using Test, Dates
         @test t6 % t7 == ITime(1, period = Second(2))
     end
 
+    @testset "Base.:(==)" begin
+        @test ITime(0; period = Day(1), epoch = DateTime(2010)) ==
+              DateTime(2010)
+        @test DateTime(2011) ==
+              ITime(365; period = Day(1), epoch = DateTime(2010))
+        @test ITime(365; period = Day(1), epoch = DateTime(2010)) !=
+              DateTime(2010)
+        @test_throws "Cannot compare ITime with a Number" ITime(
+            1;
+            period = Day(1),
+        ) == 60 * 60 * 24
+        @test_throws "Cannot compare ITime with a Number" Inf == ITime(1.0;)
+    end
+
     @testset "iszero" begin
         t1 = ITime(0, period = Hour(1))
         t2 = ITime(1, period = Second(1))