hitimes 0.2.0

data/ext/hitimes_interval.h

@@ -0,0 +1,73 @@
+/**
+ * Copyright (c) 2008 Jeremy Hinegardner
+ * All rights reserved.  See LICENSE and/or COPYING for details.
+ *
+ * vim: shiftwidth=4 
+ */ 
+
+#ifndef __HITIMES_INTERVAL_H__
+#define __HITIMES_INTERVAL_H__
+
+#include <ruby.h>
+
+#define NANOSECONDS_PER_SECOND  1e9
+
+#ifdef USE_INSTANT_CLOCK_GETTIME
+#    define HITIMES_U64INT unsigned long long int
+#    define HITIMES_INSTANT_CONVERSION_FACTOR 1e9
+#elif USE_INSTANT_OSX
+#    define HITIMES_U64INT unsigned long long int
+#    define HITIMES_INSTANT_CONVERSION_FACTOR 1e9
+#elif USE_INSTANT_WINDOWS
+#    define HITIMES_U64INT unsigned __int64
+#    define HITIMES_INSTANT_CONVERSION_FACTOR hitimes_instant_conversion_factor()
+#else
+#    error "Unable to build hitimes, no Instance backend available"
+#endif
+
+
+/* an alias for a 64bit unsigned integer.  The various sytem dependenent
+ * files must define hitimes_u64int_t 
+ */
+typedef HITIMES_U64INT hitimes_instant_t;
+
+typedef struct hitimes_interval {
+    hitimes_instant_t start_instant;
+    hitimes_instant_t stop_instant;
+    VALUE             duration;
+} hitimes_interval_t;
+
+/* all the backends must define this method */
+hitimes_instant_t hitimes_get_current_instant( );
+double hitimes_instant_conversion_factor( );
+
+/* init methods */
+void Init_hitimes_stats();
+void Init_hitimes_interval();
+
+
+/* Module and Classes -- defined at the top level */
+extern VALUE mH;           /* module Hitimes            */
+extern VALUE eH_Error;     /* class  Hitimes::Error     */
+extern VALUE cH_Interval;  /* class  Hitimes::Interval  */
+
+
+/**
+ * Methods for Interval
+ */
+
+VALUE hitimes_interval_free(hitimes_interval_t* i) ;
+VALUE hitimes_interval_alloc(VALUE klass);
+VALUE hitimes_interval_now( VALUE self );
+VALUE hitimes_interval_measure( VALUE self );
+VALUE hitimes_interval_split( VALUE self );
+VALUE hitimes_interval_start( VALUE self );
+VALUE hitimes_interval_stop( VALUE self );
+VALUE hitimes_interval_started( VALUE self );
+VALUE hitimes_interval_stopped( VALUE self );
+VALUE hitimes_interval_running( VALUE self );
+VALUE hitimes_interval_start_instant( VALUE self );
+VALUE hitimes_interval_stop_instant( VALUE self );
+VALUE hitimes_interval_duration ( VALUE self );
+
+#endif

data/ext/hitimes_stats.c

@@ -0,0 +1,217 @@
+/**
+ * Copyright (c) 2008 Jeremy Hinegardner
+ * All rights reserved.  See LICENSE and/or COPYING for details.
+ *
+ * vim: shiftwidth=4 
+ */ 
+
+#include "hitimes_stats.h"
+
+/* classes defined here */
+VALUE cH_Stats;         /* Hitimes::Stats */
+
+/**
+ * Allocator and Deallocator for Stats classes
+ */
+
+VALUE hitimes_stats_free(hitimes_stats_t* s) 
+{
+    xfree( s );
+    return Qnil;
+}
+
+VALUE hitimes_stats_alloc(VALUE klass)
+{
+    VALUE obj;
+    hitimes_stats_t* s = xmalloc( sizeof( hitimes_stats_t ) );
+
+    s->min = 0.0;
+    s->max = 0.0;
+    s->count = 0;
+    s->sum = 0.0;
+    s->sumsq = 0.0;
+
+    obj = Data_Wrap_Struct(klass, NULL, hitimes_stats_free, s);
+
+    return obj;
+}
+
+
+/**
+ * call-seq:
+ *    stat.update( val ) -> nil
+ * 
+ * Update the running stats with the new value.
+ */
+VALUE hitimes_stats_update( VALUE self, VALUE v )
+{
+    double           new_v = NUM2DBL( v );
+    hitimes_stats_t *stats;
+
+    Data_Get_Struct( self, hitimes_stats_t, stats );
+
+    if ( 0 == stats->count ) {
+      stats->min = new_v;
+      stats->max = new_v;
+    } else {
+      stats->min = ( new_v < stats->min) ? ( new_v ) : ( stats->min );
+      stats->max = ( new_v > stats->max) ? ( new_v ) : ( stats->max );
+    }
+
+    stats->count += 1;
+    stats->sum   += new_v;
+    stats->sumsq += ( new_v * new_v );
+
+    return Qnil;
+}
+
+/**
+ * call-seq:
+ *    stat.mean -> Float
+ * 
+ * Return the arithmetic mean of the values put into the Stats object.  If no
+ * values have passed through the stats object then 0.0 is returned;
+ */
+VALUE hitimes_stats_mean( VALUE self )
+{
+    hitimes_stats_t *stats;
+    double           mean = 0.0;
+
+    Data_Get_Struct( self, hitimes_stats_t, stats );
+
+    if ( stats->count > 0 ) {
+      mean = stats->sum / stats->count ;
+    }
+
+    return rb_float_new( mean );
+}
+
+/**
+ * call-seq:
+ *    stat.max -> Float
+ * 
+ * Return the maximum value that has passed through the Stats object
+ */
+VALUE hitimes_stats_max( VALUE self )
+{
+    hitimes_stats_t *stats;
+
+    Data_Get_Struct( self, hitimes_stats_t, stats );
+
+    return rb_float_new( stats->max );
+}
+
+
+
+/**
+ * call-seq:
+ *    stat.min  -> Float
+ * 
+ * Return the minimum value that has passed through the Stats object
+ */
+VALUE hitimes_stats_min( VALUE self )
+{
+    hitimes_stats_t *stats;
+
+    Data_Get_Struct( self, hitimes_stats_t, stats );
+
+    return rb_float_new( stats->min );
+}
+
+
+/**
+ * call-seq:
+ *    stat.count -> Integer
+ * 
+ * Return the number of values that have passed through the Stats object.
+ */
+VALUE hitimes_stats_count( VALUE self )
+{
+    hitimes_stats_t *stats;
+
+    Data_Get_Struct( self, hitimes_stats_t, stats );
+
+    return LONG2NUM( stats->count );
+}
+
+
+/**
+ * call-seq:
+ *    stat.sum -> Float
+ * 
+ * Return the sum of all the values that have passed through the Stats object.
+ */
+VALUE hitimes_stats_sum( VALUE self )
+{
+    hitimes_stats_t *stats;
+
+    Data_Get_Struct( self, hitimes_stats_t, stats );
+
+    return rb_float_new( stats->sum );
+}
+
+
+/**
+ * call-seq:
+ *    stat.stddev -> Float
+ * 
+ * Return the standard deviation of all the values that have passed through the
+ * Stats object.  The standard deviation has no meaning unless the count is > 1,
+ * therefore if the current _stat.count_ is < 1 then 0.0 will be returned;
+ */
+VALUE hitimes_stats_stddev ( VALUE self )
+{
+    hitimes_stats_t *stats;
+    double          stddev = 0.0;
+
+    Data_Get_Struct( self, hitimes_stats_t, stats );
+    if ( stats->count > 1 ) {
+      stddev = sqrt( ( stats->sumsq - ( stats->sum * stats->sum  / stats->count ) ) / ( stats->count - 1 ) );
+    }
+
+    return rb_float_new( stddev );
+}
+
+
+/**
+ * Document-class: Hitimes::Stats
+ *
+ * The Stats class encapulsates capturing and reporting statistics.  It is
+ * modeled after the RFuzz::Sampler class, but implemented in C.  For general use
+ * you allocate a new Stats object, and then update it with new values.  The
+ * Stats object will keep track of the _min_, _max_, _count_ and _sum_ and when
+ * you want you may also retrieve the _mean_ and _stddev_.
+ *
+ * this contrived example shows getting a list of all the files in a directory
+ * and running stats on file sizes.
+ *
+ *     s = Hitimes::Stats.new
+ *     dir = ARGV.shift || Dir.pwd
+ *     Dir.entries( dir ).each do |entry|
+ *       fs = File.stat( entry )
+ *       if fs.file? then
+ *         s.update( fs.size )
+ *        end
+ *     end
+ *
+ *     %w[ count min max mean sum stddev ].each do |m|
+ *       puts "#{m.rjust(6)} : #{s.send( m ) }"
+ *     end
+ */
+void Init_hitimes_stats()
+{
+
+    mH = rb_define_module("Hitimes"); 
+
+    cH_Stats = rb_define_class_under( mH, "Stats", rb_cObject ); /* in hitimes_stats.c */
+    rb_define_alloc_func( cH_Stats, hitimes_stats_alloc );
+
+    rb_define_method( cH_Stats, "update", hitimes_stats_update, 1 ); /* in hitimes_stats.c */
+    rb_define_method( cH_Stats, "mean", hitimes_stats_mean, 0 ); /* in hitimes_stats.c */
+    rb_define_method( cH_Stats, "max", hitimes_stats_max, 0 ); /* in hitimes_stats.c */
+    rb_define_method( cH_Stats, "min", hitimes_stats_min, 0 ); /* in hitimes_stats.c */
+    rb_define_method( cH_Stats, "count", hitimes_stats_count, 0 ); /* in hitimes_stats.c */
+    rb_define_method( cH_Stats, "sum", hitimes_stats_sum, 0 ); /* in hitimes_stats.c */
+    rb_define_method( cH_Stats, "stddev", hitimes_stats_stddev, 0 ); /* in hitimes_stats.c */
+}
+ 

data/ext/hitimes_stats.h

@@ -0,0 +1,30 @@
+/**
+ * Copyright (c) 2008 Jeremy Hinegardner
+ * All rights reserved.  See LICENSE and/or COPYING for details.
+ *
+ * vim: shiftwidth=4 
+ */ 
+
+#ifndef __HITIMES_STATS_H__
+#define __HITIMES_STATS_H__
+
+#include <ruby.h>
+#include <math.h>
+
+/* classes and modules defined elswhere */
+extern VALUE mH;        /* Hitimes */
+extern VALUE eH_Error;  /* Hitimes::Error */
+extern VALUE cH_Stats;  /* Hitimes::Stats */
+
+
+typedef struct hitimes_stats {
+    double min;
+    double max;
+    double sum;
+    double sumsq;
+    long   count;
+} hitimes_stats_t;
+
+#endif
+
+

data/ext/mkrf_conf.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'mkrf'
+require 'rbconfig'
+
+Mkrf::Generator.new('hitimes_ext') do |g|
+    g.logger.level = Logger::WARN
+
+    if Config::CONFIG['host_os'] =~ /darwin/ then
+      g.add_define "USE_INSTANT_OSX=1"
+      g.additional_code  = "LIBS.concat(' -framework CoreServices')"
+    elsif Config::CONFIG['host_os'] =~ /win32/ then
+      g.add_define "USE_INSTANT_WINDOWS=1"
+    else
+      g.include_library("rt")
+      if g.has_function?( 'clock_gettime' ) then
+        g.add_define "USE_INSTANT_CLOCK_GETTIME=1"
+      end
+    end
+
+end

data/gemspec.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'hitimes/version'
+require 'tasks/config'
+
+Hitimes::GEM_SPEC = Gem::Specification.new do |spec|
+  proj = Configuration.for('project')
+  spec.name         = proj.name
+  spec.version      = Hitimes::VERSION
+  
+  spec.author       = proj.author
+  spec.email        = proj.email
+  spec.homepage     = proj.homepage
+  spec.summary      = proj.summary
+  spec.description  = proj.description
+  spec.platform     = Gem::Platform::RUBY
+
+  
+  pkg = Configuration.for('packaging')
+  spec.files        = pkg.files.all
+  spec.executables  = pkg.files.bin.collect { |b| File.basename(b) }
+
+  # add dependencies here
+  spec.add_dependency("rake", ">= 0.8.1")
+  spec.add_dependency("configuration", ">= 0.0.5")
+  spec.add_dependency("mkrf", ">= 0.2.3")
+
+  if ext_conf = Configuration.for_if_exist?("extension") then
+    spec.extensions <<  ext_conf.configs
+    spec.require_paths << 'ext'
+    spec.extensions.flatten!
+  end   
+
+  if rdoc = Configuration.for_if_exist?('rdoc') then
+    spec.has_rdoc         = true
+    spec.extra_rdoc_files = pkg.files.rdoc
+    spec.rdoc_options     = rdoc.options + [ "--main" , rdoc.main_page ]
+  else
+    spec.has_rdoc         = false
+  end 
+
+  if test = Configuration.for_if_exist?('testing') then
+    spec.test_files       = test.files
+  end 
+
+  if rf = Configuration.for_if_exist?('rubyforge') then
+    spec.rubyforge_project  = rf.project
+  end 
+
+end

data/lib/hitimes.rb

@@ -0,0 +1,21 @@
+#--
+# Copyright (c) 2008 Jeremy Hinegardner
+# All rights reserved.  See LICENSE and/or COPYING for details.
+#++
+
+#
+# The top level module containing the contents of the hitimes library
+#
+# use the library with:
+#
+#   require 'hitimes'
+#
+module Hitimes
+  #
+  # Base class of all errors in Hitimes
+  #
+  class Error < ::StandardError; end
+end
+require 'hitimes/paths'
+require 'hitimes/version'
+require 'hitimes/timer'

data/lib/hitimes/paths.rb

@@ -0,0 +1,54 @@
+#--
+# Copyright (c) 2008 Jeremy Hinegardner
+# All rights reserved.  See LICENSE and/or COPYING for details.
+#++
+#
+module Hitimes
+  #
+  # Access to various paths inside the project programatically
+  #
+  module Paths
+    #   
+    # :call-seq:
+    #    Hitimes::Paths.root_dir -> String
+    #
+    # Returns The full expanded path of the parent directory of +lib+
+    # going up the path from the current file.  A trailing File::SEPARATOR 
+    # is guaranteed.
+    #   
+    def self.root_dir
+      unless @root_dir
+        path_parts = ::File.expand_path(__FILE__).split(::File::SEPARATOR)
+        lib_index  = path_parts.rindex("lib")
+        @root_dir = path_parts[0...lib_index].join(::File::SEPARATOR) + ::File::SEPARATOR
+      end 
+      return @root_dir
+    end 
+
+    # 
+    # :call-seq:
+    #   Hitimes::Paths.lib_path( *args ) -> String
+    #
+    # Returns The full expanded path of the +lib+ directory below
+    # _root_dir_.  All parameters passed in are joined onto the 
+    # result. A trailing File::SEPARATOR is guaranteed if 
+    # _args_ are *not* present.
+    #   
+    def self.lib_path(*args)
+      self.sub_path("lib", *args)
+    end 
+
+    #
+    # :call-seq:
+    #   Hitimes::Paths.sub_path( sub, *args ) -> String
+    #
+    # Returns the full expanded path of the +sub+ directory below _root_dir.  All
+    # _arg_ parameters passed in are joined onto the result.  A trailing
+    # File::SEPARATOR is guaranteed if _args_ are *not* present.
+    #
+    def self.sub_path(sub,*args)
+      sp = ::File.join(root_dir, sub) + File::SEPARATOR
+      sp = ::File.join(sp, *args) if args
+    end
+  end
+end