Merge pull request #7 from JuliaArrays/time

Add `btime` options

.github/workflows/ci.yml

@@ -1,6 +1,8 @@
 name: CI
 on:
   push:
+    branches:
+      - main
     paths-ignore:
       - '*/*.md'
       - 'docs/**'
@@ -17,7 +19,9 @@ jobs:
       fail-fast: false
       matrix:
         version:
+          - '1.6'
           - '1'
+          - 'nightly'
         os:
           - ubuntu-latest
           - macOS-latest

Project.toml

@@ -1,7 +1,7 @@
 name = "LazyGrids"
 uuid = "7031d0ef-c40d-4431-b2f8-61a8d2f650db"
 authors = ["Sheehan Olver <[email protected]>", "Jeff Fessler <[email protected]>"]
-version = "0.2.0"
+version = "0.2.1"
 
 [deps]
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"

src/timer.jl

@@ -38,12 +38,14 @@ end
 
 
 """
-    btime()
+    btime(t ; unit::Symbol, digits::Int)
 Pretty-print the @benchmark output for non-interactive use with Literate.
 Returns a string so that Literate will capture the output.
+* `unit` is `:ms` by default, for reporting in ms.  Or use `μs`.
+* `digits` is 1 by default.
 """
-btime(t) = string(
-    "time=", round(median(t.times)/10^6, digits=1), # median time in ms
-    "ms mem=", t.memory,
-    " alloc=", t.allocs,
-)
+function btime(t ; unit::Symbol = :ms, digits::Int = 1)
+    scale = unit == :ms ? 10^6 : unit == :μs ? 10^3 : throw("unit $unit")
+    time = round(median(t.times)/scale; digits) # median time in units
+    string("time=", time, unit, " mem=", t.memory, " alloc=", t.allocs)
+end

test/timer.jl

@@ -5,9 +5,9 @@ using BenchmarkTools: @benchmark
 using Test: @test, @testset, @test_throws, @inferred
 
 @testset "timer" begin
-	t = @benchmark sum(1:7)
-	@inferred btime(t)
-	@test btime(t) isa String
+    t = @benchmark sum(1:7)
+    @inferred btime(t)
+    @test btime(t) isa String
 
-	@test (@timeo sum(1:7)) isa String
+    @test (@timeo sum(1:7)) isa String
 end