wkfutils.h File Reference

Go to the source code of this file.

Classes
struct	wkfmsgtimer

Typedefs
typedef void *	wkf_timerhandle

Functions
wkf_timerhandle	wkf_timer_create (void)
void	wkf_timer_destroy (wkf_timerhandle)
void	wkf_timer_start (wkf_timerhandle)
void	wkf_timer_stop (wkf_timerhandle)
double	wkf_timer_time (wkf_timerhandle)
double	wkf_timer_timenow (wkf_timerhandle)
double	wkf_timer_start_time (wkf_timerhandle)
double	wkf_timer_stop_time (wkf_timerhandle)
wkfmsgtimer *	wkf_msg_timer_create (double updatetime)
int	wkf_msg_timer_timeout (wkfmsgtimer *time)
void	wkf_msg_timer_destroy (wkfmsgtimer *mt)

Typedef Documentation

wkf_timerhandle

typedef void* wkf_timerhandle

a timer handle

Definition at line 49 of file wkfutils.h.

Function Documentation

wkf_msg_timer_create()

wkfmsgtimer* wkf_msg_timer_create

(

double

updatetime

)

initialize periodic status message timer

initialize status message timer

Definition at line 178 of file wkfutils.c.

References wkfmsgtimer::timer, wkfmsgtimer::updatetime, wkf_timer_create(), and wkf_timer_start().

                                                      {
  wkfmsgtimer *mt;
  mt = (wkfmsgtimer *) malloc(sizeof(wkfmsgtimer));
  if (mt != NULL) {
    mt->timer = wkf_timer_create();
    mt->updatetime = updatetime;
    wkf_timer_start(mt->timer);
  }
  return mt;
}

wkf_msg_timer_destroy()

void wkf_msg_timer_destroy

(

wkfmsgtimer *

mt

)

destroy message timer

Definition at line 204 of file wkfutils.c.

References wkfmsgtimer::timer, and wkf_timer_destroy().

                                             {
  wkf_timer_destroy(mt->timer);
  free(mt);
}

wkf_msg_timer_timeout()

int wkf_msg_timer_timeout

(

wkfmsgtimer *

mt

)

return true if it's time to print a status update message

Definition at line 190 of file wkfutils.c.

References wkfmsgtimer::timer, wkfmsgtimer::updatetime, wkf_timer_start(), and wkf_timer_timenow().

                                           {
  double elapsed = wkf_timer_timenow(mt->timer);
  if (elapsed > mt->updatetime) {
    /* reset the clock and return true that our timer expired */
    wkf_timer_start(mt->timer);
    return 1;
  } else if (elapsed < 0) {
    /* time went backwards, best reset our clock! */
    wkf_timer_start(mt->timer);
  }
  return 0;
}

wkf_timer_create()

wkf_timerhandle wkf_timer_create

(

void

)

create a timer (clears timer)

Definition at line 161 of file wkfutils.c.

Referenced by NL_msm_create(), and wkf_msg_timer_create().

                                       {
  wkf_timer * t;
  t = (wkf_timer *) malloc(sizeof(wkf_timer));
  memset(t, 0, sizeof(wkf_timer));
  return t;
}

wkf_timer_destroy()

void wkf_timer_destroy

(

wkf_timerhandle

)

create a timer (clears timer)

Definition at line 168 of file wkfutils.c.

Referenced by NL_msm_destroy(), and wkf_msg_timer_destroy().

                                          {
  free(v);
}

wkf_timer_start()

void wkf_timer_start

(

wkf_timerhandle

)

start a timer (clears timer)

Definition at line 124 of file wkfutils.c.

References wkf_timer::tz.

Referenced by NL_msm_compute_force(), NL_msm_compute_force_sprec(), NL_msm_compute_long_range(), NL_msm_compute_long_range_sprec(), wkf_msg_timer_create(), and wkf_msg_timer_timeout().

                                        {
  wkf_timer * t = (wkf_timer *) v;
  gettimeofday(&t->starttime, &t->tz);
}

wkf_timer_start_time()

double wkf_timer_start_time

(

wkf_timerhandle

)

report wall starting time

Definition at line 142 of file wkfutils.c.

                                               {
  wkf_timer * t = (wkf_timer *) v;
  double ttime;
  ttime = ((double) t->starttime.tv_sec) +
          ((double) t->starttime.tv_usec) / 1000000.0;
  return ttime;
}

wkf_timer_stop()

void wkf_timer_stop

(

wkf_timerhandle

)

stop a timer

Definition at line 129 of file wkfutils.c.

References wkf_timer::endtime, and wkf_timer::tz.

Referenced by NL_msm_compute_force(), NL_msm_compute_force_sprec(), NL_msm_compute_long_range(), NL_msm_compute_long_range_sprec(), and wkf_timer_timenow().

                                       {
  wkf_timer * t = (wkf_timer *) v;
  gettimeofday(&t->endtime, &t->tz);
}

wkf_timer_stop_time()

double wkf_timer_stop_time

(

wkf_timerhandle

)

report wall stopping time

Definition at line 150 of file wkfutils.c.

References wkf_timer::endtime.

                                              {
  wkf_timer * t = (wkf_timer *) v;
  double ttime;
  ttime = ((double) t->endtime.tv_sec) +
          ((double) t->endtime.tv_usec) / 1000000.0;
  return ttime;
}

wkf_timer_time()

double wkf_timer_time

(

wkf_timerhandle

)

report elapsed time in seconds

Definition at line 134 of file wkfutils.c.

References wkf_timer::endtime.

Referenced by NL_msm_compute_force(), NL_msm_compute_force_sprec(), NL_msm_compute_long_range(), NL_msm_compute_long_range_sprec(), and wkf_timer_timenow().

                                         {
  wkf_timer * t = (wkf_timer *) v;
  double ttime;
  ttime = ((double) (t->endtime.tv_sec - t->starttime.tv_sec)) +
          ((double) (t->endtime.tv_usec - t->starttime.tv_usec)) / 1000000.0;
  return ttime;
}

wkf_timer_timenow()

double wkf_timer_timenow

(

wkf_timerhandle

)

report elapsed time in seconds

Definition at line 172 of file wkfutils.c.

References wkf_timer_stop(), and wkf_timer_time().

Referenced by wkf_msg_timer_timeout().

                                            {
  wkf_timer_stop(v);
  return wkf_timer_time(v);
}