module TimeIt

Overview

i don't really know what kind of documentation this needs because it just feels so painfully straightforward...

Extended Modules

TimeIt

Defined in:

time_it.cr

Constant Summary

VERSION = "0.1.2"

Instance Method Summary

#format_times(times : Array(Float64)) : String
#format_times is simply a helper function that formats the times in #time_it's all_times array into a nice, numbered, and line-broken string for presentation to the user and placement in the log file
#time_it(exe : String, args : Array(String) | Nil = nil, runs : Int32 = 10) : Tuple(String, String)
#time_it is the function that actually times the program.

Instance Method Detail

def format_times(times : Array(Float64)) : String #

#format_times is simply a helper function that formats the times in #time_it's all_times array into a nice, numbered, and line-broken string for presentation to the user and placement in the log file

def time_it(exe : String, args : Array(String) | Nil = nil, runs : Int32 = 10) : Tuple(String, String) #

#time_it is the function that actually times the program. it does this by taking a String exe and (optionally) an Array(String) | Nil args, then feeding it to Process.run runs number of times, timing each run and placing it into an array for later formatting.