hitimes 1.1.0-java

data/ext/hitimes/hitimes_ext.c

@@ -0,0 +1,21 @@
+#include <ruby.h>
+#include "hitimes_interval.h"
+
+/* Module and Classes */
+VALUE mH;           /* module Hitimes            */
+VALUE eH_Error;     /* class  Hitimes::Error     */
+
+/*
+ * Document-class: Hitimes::Error
+ *
+ * General error class for the Hitimes module
+ */
+void Init_hitimes_ext( )
+{
+    mH = rb_define_module("Hitimes");
+     
+    eH_Error = rb_define_class_under(mH, "Error", rb_eStandardError);
+
+    Init_hitimes_interval();
+    Init_hitimes_stats( );
+}

data/ext/hitimes/hitimes_instant_clock_gettime.c

@@ -0,0 +1,28 @@
+#ifdef USE_INSTANT_CLOCK_GETTIME
+
+#include "hitimes_interval.h"
+
+#include <time.h>
+#ifndef CLOCK_MONOTONIC
+#  include <sys/time.h>
+#  ifndef CLOCK_MONOTONIC
+#    ifdef __linux__
+#      include <linux/time.h>
+#    endif
+#  endif
+#endif
+
+hitimes_instant_t hitimes_get_current_instant( )
+{
+    struct timespec time;
+    int rc;
+
+    rc = clock_gettime( CLOCK_MONOTONIC, &time);
+    if ( 0 != rc )  {
+        char* e = strerror( rc );
+        rb_raise(eH_Error, "Unable to retrieve time for CLOCK_MONOTONIC :  %s", e );
+    }
+
+    return ( ( NANOSECONDS_PER_SECOND * (long)time.tv_sec ) + time.tv_nsec );
+}
+#endif

data/ext/hitimes/hitimes_instant_osx.c

@@ -0,0 +1,16 @@
+#ifdef USE_INSTANT_OSX
+
+#include "hitimes_interval.h"
+#include <CoreServices/CoreServices.h>
+
+/* 
+ * returns the number of nanoseconds since the machine was booted
+ */
+hitimes_instant_t hitimes_get_current_instant( )
+{
+    Nanoseconds  nano    = AbsoluteToNanoseconds( UpTime() );
+
+    return *( hitimes_instant_t *)&nano;
+}
+
+#endif

data/ext/hitimes/hitimes_instant_windows.c

@@ -0,0 +1,27 @@
+#ifdef USE_INSTANT_WINDOWS
+
+#include "hitimes_interval.h"
+
+
+/*
+ * returns the conversion factor, this value is used to convert
+ * the value from hitimes_get_current_instant() into seconds
+ */
+long double hitimes_instant_conversion_factor()
+{
+    LARGE_INTEGER ticks_per_second;
+    QueryPerformanceFrequency( &ticks_per_second );
+    return (double)ticks_per_second.QuadPart;
+}
+
+/*
+ * returns the number of ticks
+ */
+hitimes_instant_t hitimes_get_current_instant()
+{
+    LARGE_INTEGER tick;
+    QueryPerformanceCounter(&tick);
+    return (hitimes_instant_t)tick.QuadPart;
+}
+
+#endif

data/ext/hitimes/hitimes_interval.c

@@ -0,0 +1,362 @@
+/**
+ * Copyright (c) 2008 Jeremy Hinegardner
+ * All rights reserved.  See LICENSE and/or COPYING for details.
+ *
+ * vim: shiftwidth=4 
+ */ 
+
+#include "hitimes_interval.h"
+
+/* Modules and Classes -- defined here */
+VALUE cH_Interval;         /* class  Hitimes::Interval  */
+
+/**
+ * Allocator and Deallocator for Interval classes
+ */
+
+VALUE hitimes_interval_free(hitimes_interval_t* i) 
+{
+    xfree( i );
+    return Qnil;
+}
+
+VALUE hitimes_interval_alloc(VALUE klass)
+{
+    VALUE obj;
+    hitimes_interval_t* i = xmalloc( sizeof( hitimes_interval_t ) );
+
+    i->start_instant = 0L;
+    i->stop_instant  = 0L;
+    i->duration      = -1.0l;
+
+    obj = Data_Wrap_Struct(klass, NULL, hitimes_interval_free, i);
+    return obj;
+}
+
+/**
+ * call-seq:
+ *    Interval.now -> Interval
+ *
+ * Create an interval that has already started
+ */
+VALUE hitimes_interval_now( VALUE self )
+{
+    VALUE obj;
+    hitimes_interval_t *i = xmalloc( sizeof( hitimes_interval_t ) );
+
+    i->start_instant = hitimes_get_current_instant( );
+    i->stop_instant  = 0L;
+    i->duration      = -1.0l;
+
+    obj = Data_Wrap_Struct(cH_Interval, NULL, hitimes_interval_free, i);
+
+    return obj;
+}
+
+/**
+ * call-seq:
+ *    Interval.measure {  }  -> Float
+ *
+ * Times the execution of the block returning the number of seconds it took
+ */
+VALUE hitimes_interval_measure( VALUE self )
+{
+    hitimes_instant_t before;
+    hitimes_instant_t after;
+    long double       duration;
+
+    if ( !rb_block_given_p() ) {
+        rb_raise(eH_Error, "No block given to Interval.measure" );
+    }
+    
+    before = hitimes_get_current_instant( );
+    rb_yield( Qnil );
+    after  = hitimes_get_current_instant( );
+
+    duration = ( after - before ) / HITIMES_INSTANT_CONVERSION_FACTOR;
+    return rb_float_new( duration );
+}
+
+/**
+ * call-seq:
+ *    interval.split -> Interval
+ *
+ * Immediately stop the current interval and start a new interval that has a
+ * start_instant equivalent to the stop_interval of self.
+ */
+VALUE hitimes_interval_split( VALUE self )
+{
+    hitimes_interval_t *first;
+    hitimes_interval_t *second = xmalloc( sizeof( hitimes_interval_t ) );
+    VALUE              obj;
+
+    Data_Get_Struct( self, hitimes_interval_t, first );
+    first->stop_instant = hitimes_get_current_instant( );
+
+    second->start_instant = first->stop_instant;
+    second->stop_instant  = 0L;
+    second->duration      = -1.0l;
+
+    obj = Data_Wrap_Struct(cH_Interval, NULL, hitimes_interval_free, second);
+
+    return obj;
+}
+
+
+/**
+ * call-seq:
+ *    interval.start -> boolean 
+ *
+ * mark the start of the interval.  Calling start on an already started
+ * interval has no effect.  An interval can only be started once.  If the
+ * interval is truely started +true+ is returned otherwise +false+.
+ */
+VALUE hitimes_interval_start( VALUE self )
+{
+    hitimes_interval_t *i;
+    VALUE               rc = Qfalse;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+    if ( 0L == i->start_instant ) {
+      i->start_instant = hitimes_get_current_instant( );
+      i->stop_instant  = 0L;
+      i->duration      = -1.0l;
+
+      rc = Qtrue;
+    }
+
+    return rc;
+}
+
+
+/**
+ * call-seq:
+ *    interval.stop -> bool or Float
+ *
+ * mark the stop of the interval.  Calling stop on an already stopped interval
+ * has no effect.  An interval can only be stopped once.  If the interval is
+ * truely stopped then the duration is returned, otherwise +false+.
+ */
+VALUE hitimes_interval_stop( VALUE self )
+{
+    hitimes_interval_t *i;
+    VALUE               rc = Qfalse;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+    if ( 0L == i->start_instant )  {
+        rb_raise(eH_Error, "Attempt to stop an interval that has not started.\n" );
+    }
+
+    if ( 0L == i->stop_instant ) {
+      i->stop_instant = hitimes_get_current_instant( );
+      i->duration = ( i->stop_instant - i->start_instant ) / HITIMES_INSTANT_CONVERSION_FACTOR;
+      rc = rb_float_new( i->duration );
+    }
+
+    return rc;
+}
+
+/**
+ * call-seq:
+ *     interval.duration_so_far -> Float or false
+ *
+ * return how the duration so far.  This will return the duration from the time
+ * the Interval was started if the interval is running, otherwise it will return
+ * false.
+ */
+VALUE hitimes_interval_duration_so_far( VALUE self )
+{
+    hitimes_interval_t *i;
+    VALUE               rc = Qfalse;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+    if ( 0L == i->start_instant ) {
+        return rc;
+    }
+
+    if ( 0L == i->stop_instant ) {
+        long double         d;
+        hitimes_instant_t now = hitimes_get_current_instant( );
+        d = ( now - i->start_instant ) / HITIMES_INSTANT_CONVERSION_FACTOR;
+        rc = rb_float_new( d );
+    }
+    return rc;
+}
+
+
+/**
+ * call-seq:
+ *    interval.started? -> boolean
+ *
+ * returns whether or not the interval has been started
+ */
+VALUE hitimes_interval_started( VALUE self )
+{
+    hitimes_interval_t *i;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+
+    return ( 0L == i->start_instant ) ? Qfalse : Qtrue;
+}
+
+
+/**
+ * call-seq:
+ *    interval.stopped? -> boolean
+ *
+ * returns whether or not the interval has been stopped
+ */
+VALUE hitimes_interval_stopped( VALUE self )
+{
+    hitimes_interval_t *i;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+
+    return ( 0L == i->stop_instant ) ? Qfalse : Qtrue;
+}
+
+/**
+ * call-seq:
+ *    interval.running? -> boolean
+ *
+ * returns whether or not the interval is running or not.  This means that it
+ * has started, but not stopped.
+ */
+VALUE hitimes_interval_running( VALUE self )
+{
+    hitimes_interval_t *i;
+    VALUE              rc = Qfalse;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+    if ( ( 0L != i->start_instant ) && ( 0L == i->stop_instant ) ) {
+        rc = Qtrue;
+    }
+
+    return rc;
+}
+
+
+/** 
+ * call-seq:
+ *    interval.start_instant -> Integer
+ *
+ * The integer representing the start instant of the Interval.  This value
+ * is not useful on its own.  It is a platform dependent value.
+ */
+VALUE hitimes_interval_start_instant( VALUE self )
+{
+    hitimes_interval_t *i;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+   
+    return ULL2NUM( i->start_instant );
+}
+
+
+/** 
+ * call-seq:
+ *    interval.stop_instant -> Integer
+ *
+ * The integer representing the stop instant of the Interval.  This value
+ * is not useful on its own.  It is a platform dependent value.
+ */
+VALUE hitimes_interval_stop_instant( VALUE self )
+{
+    hitimes_interval_t *i;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+   
+    return ULL2NUM( i->stop_instant );
+}
+
+
+
+/**
+ * call-seq:
+ *    interval.duration -> Float
+ *    interval.to_f -> Float
+ *    interval.to_seconds -> Float
+ *    interval.length -> Float
+ *
+ * Returns the Float value of the interval, the value is in seconds.  If the
+ * interval has not had stop called yet, it will report the number of seconds
+ * in the interval up to the current point in time.
+ */
+VALUE hitimes_interval_duration ( VALUE self )
+{
+    hitimes_interval_t *i;
+
+    Data_Get_Struct( self, hitimes_interval_t, i );
+
+    /** 
+     * if stop has not yet been called, then return the amount of time so far
+     */
+    if ( 0L == i->stop_instant ) {
+        long double d;
+        hitimes_instant_t now = hitimes_get_current_instant( );
+        d = ( now - i->start_instant ) / HITIMES_INSTANT_CONVERSION_FACTOR;
+        return rb_float_new( d );
+    } 
+
+    /*
+     * stop has been called, calculate the duration and save the result
+     */
+    if ( i->duration < 0.0 ) {
+        i->duration = ( i->stop_instant - i->start_instant ) / HITIMES_INSTANT_CONVERSION_FACTOR;
+    }
+
+    return rb_float_new( i->duration );
+}
+
+
+/**
+ * Document-class: Hitimes::Interval
+ *
+ * This is the lowest level timing mechanism available.  It allows for easy
+ * measuring based upon a block:
+ *
+ *   duration = Interval.measure { ... }
+ *
+ * Or measuring something specifically
+ *
+ *   interval = Interval.new
+ *   interval.start
+ *   duration = interval.stop
+ *
+ * Allocating and starting an interval can be done in one method call with
+ *
+ *   interval = Interval.now
+ *
+ * Interval is useful when you only need to track a single interval of time, or
+ * if you do not want to track statistics about an operation.
+ *
+ */
+void Init_hitimes_interval()
+{
+    mH = rb_define_module("Hitimes"); 
+   
+    cH_Interval = rb_define_class_under( mH, "Interval", rb_cObject );
+    rb_define_alloc_func( cH_Interval, hitimes_interval_alloc );
+
+    rb_define_module_function( cH_Interval, "now", hitimes_interval_now, 0 ); /* in hitimes_interval.c */
+    rb_define_module_function( cH_Interval, "measure", hitimes_interval_measure, 0 ); /* in hitimes_interval.c */
+
+    rb_define_method( cH_Interval, "duration",     hitimes_interval_duration, 0 ); /* in hitimes_interval.c */
+    rb_define_method( cH_Interval, "length",       hitimes_interval_duration, 0 ); 
+    rb_define_method( cH_Interval, "to_f",         hitimes_interval_duration, 0 );
+    rb_define_method( cH_Interval, "to_seconds",   hitimes_interval_duration, 0 );
+
+    rb_define_method( cH_Interval, "duration_so_far", hitimes_interval_duration_so_far, 0); /* in hitimes_interval.c */
+     
+    rb_define_method( cH_Interval, "started?",     hitimes_interval_started, 0 ); /* in hitimes_interval.c */
+    rb_define_method( cH_Interval, "running?",     hitimes_interval_running, 0 ); /* in hitimes_interval.c */
+    rb_define_method( cH_Interval, "stopped?",     hitimes_interval_stopped, 0 ); /* in hitimes_interval.c */
+
+    rb_define_method( cH_Interval, "start_instant", hitimes_interval_start_instant, 0 ); /* in hitimes_interval.c */
+    rb_define_method( cH_Interval, "stop_instant",  hitimes_interval_stop_instant, 0 ); /* in hitimes_interval.c */
+
+    rb_define_method( cH_Interval, "start", hitimes_interval_start, 0); /* in hitimes_interval.c */
+    rb_define_method( cH_Interval, "stop",  hitimes_interval_stop, 0); /* in hitimes_interval.c */
+    rb_define_method( cH_Interval, "split",  hitimes_interval_split, 0); /* in hitimes_interval.c */
+ 
+}