class Hitimes::Interval - hitimes-1.2.4 Documentation

# 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.

### Public Class Methods

measure { } → Float click to toggle source

Times the execution of the block returning the number of seconds it took

    VALUE hitimes_interval_measure( )
    {
        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 );
    }

now → Interval click to toggle source

Create an interval that has already started

    VALUE hitimes_interval_now( )
    {
        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;
    }

### Public Instance Methods

duration → Float click to toggle source

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.

Raises Error if duration is called on an interval that has not started yet.

    VALUE hitimes_interval_duration ( VALUE self )
    {
        hitimes_interval_t *i;

        Data_Get_Struct( self, hitimes_interval_t, i );

        /* raise an error if the internval is not started */
        if ( 0L == i->start_instant )  {
            rb_raise(eH_Error, "Attempt to report a duration on an interval that has not started" );
        }

        /**
         * 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 );
    }

duration_so_far → Float or false click to toggle source

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;
    }

length → Float click to toggle source

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.

Raises Error if duration is called on an interval that has not started yet.

    VALUE hitimes_interval_duration ( VALUE self )
    {
        hitimes_interval_t *i;

        Data_Get_Struct( self, hitimes_interval_t, i );

        /* raise an error if the internval is not started */
        if ( 0L == i->start_instant )  {
            rb_raise(eH_Error, "Attempt to report a duration on an interval that has not started" );
        }

        /**
         * 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 );
    }

running? → boolean click to toggle source

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;
    }

split → Interval click to toggle source

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;
    }

start → boolean click to toggle source

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;
    }

start_instant → Integer click to toggle source

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 );
    }

started? → boolean click to toggle source

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;
    }

stop → bool or Float click to toggle source

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" );
        }

        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;
    }

stop_instant → Integer click to toggle source

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 );
    }

stopped? → boolean click to toggle source

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;
    }

to_f → Float click to toggle source

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.

Raises Error if duration is called on an interval that has not started yet.

    VALUE hitimes_interval_duration ( VALUE self )
    {
        hitimes_interval_t *i;

        Data_Get_Struct( self, hitimes_interval_t, i );

        /* raise an error if the internval is not started */
        if ( 0L == i->start_instant )  {
            rb_raise(eH_Error, "Attempt to report a duration on an interval that has not started" );
        }

        /**
         * 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 );
    }

to_seconds → Float click to toggle source

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.

Raises Error if duration is called on an interval that has not started yet.

    VALUE hitimes_interval_duration ( VALUE self )
    {
        hitimes_interval_t *i;

        Data_Get_Struct( self, hitimes_interval_t, i );

        /* raise an error if the internval is not started */
        if ( 0L == i->start_instant )  {
            rb_raise(eH_Error, "Attempt to report a duration on an interval that has not started" );
        }

        /**
         * 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 );
    }