Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
a fast, high resolution timer library for recording performance metrics
Ruby C Java

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
examples
ext
lib
spec
tasks
.gitignore
HISTORY
LICENSE
README
Rakefile
TODO.taskpaper
gemspec.rb

README

== hitimes

* Homepage[http://copiousfreetime.rubyforge.org/hitimes] 
* {Rubyforge project}[http://rubyforge.org/projects/copiousfreetime/]
* email jeremy at copiousfreetime dot org
* git clone url git://github.com/copiousfreetime/hitimes.git

== INSTALL

* gem install hitimes

== DESCRIPTION

Hitimes is a fast, high resolution timer library for recording
performance metrics.  It uses the appropriate C method calls for each
system to get the highest granularity time increments possible.  

It currently supports any system with the POSIX call clock_gettime(),
Mac OS X and Windows.

Using Hitimes can be faster than using a series of Time.new calls, and
it will have a much higher granularity.   It is definitely faster than
using Process.times. 

== SYNOPSIS

Use Hitimes::Interval to calculate only the duration of a block of code

  duration = Hitimes::Interval.measure do
               # some operation ...
             end

  puts duration   

Use a Hitimes::Timer to calculate statistics about an iterative operation

  timer = Hitimes::Timer.new
  collection.each do |item|
    timer.start
    # .. do something with item
    timer.stop
  end

  puts timer.mean
  puts timer.median
  puts timer.max
  puts timer.min
  puts timer.stddev
  puts timer.rate


== CHANGES

Read the HISTORY file.

== CREDITS

* Bruce Williams for suggesting the idea

== ISC License

Copyright (c) 2008 Jeremy Hinegardner

Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
Something went wrong with that request. Please try again.