trunk/src/results.h

/***************************************
 $Header: /home/amb/CVS/routino/src/results.h,v 1.10 2009-02-10 19:49:26 amb Exp $

 A header file for the results.
 ******************/ /******************
 Written by Andrew M. Bishop

 This file Copyright 2009 Andrew M. Bishop
 It may be distributed under the GNU Public License, version 2, or
 any higher version.  See section COPYING of the GNU Public license
 for conditions under which this file may be redistributed.
 ***************************************/


#ifndef RESULTS_H
#define RESULTS_H    /*+ To stop multiple inclusions. +*/

#include <stdint.h>

#include "types.h"


/* Data structures */

/*+ The result for a node. +*/
typedef struct _Result
{
 index_t     node;              /*+ The node for which this result applies. +*/

 index_t      prev;             /*+ The previous node following the best path. +*/
 index_t      next;             /*+ The next node following the best path. +*/

 distance_t  distance;          /*+ The distance travelled to the node following the best path. +*/
 duration_t  duration;          /*+ The time taken to the node following the best path. +*/

 distance_t  sortby;            /*+ The value to sort the results by in the queue. +*/
}
 Result;

/*+ A list of results. +*/
typedef struct _Results
{
 uint32_t nbins;                /*+ The number of bins. +*/
 uint32_t mask;                 /*+ A bit mask to select the bottom 'nbins' bits. +*/

 uint32_t alloced;              /*+ The amount of space allocated for results
                                    (the length of the number and pointers arrays and
                                     1/nbins times the amount in the real results). +*/
 uint32_t number;               /*+ The total number of occupied results. +*/

 uint32_t *count;               /*+ An array of nbins counters of results in each array. +*/
 Result ***point;               /*+ An array of nbins arrays of pointers to actual results. +*/

 Result  **data;                /*+ An array of arrays containing the actual results
                                    (don't need to realloc the array of data when adding more,
                                    only realloc the array that points to the array of data).
                                    Most importantly pointers into the real data don't change
                                    as more space is allocated (since realloc is not being used). +*/
}
 Results;


/* Functions */

Results *NewResultsList(int nbins);
void FreeResultsList(Results *results);

Result *InsertResult(Results *results,index_t node);

Result *FindResult(Results *results,index_t node);

Result *FirstResult(Results *results);
Result *NextResult(Results *results,Result *result);

/* Queue Functions */

void insert_in_queue(Result *result);
Result *pop_from_queue(void);


#endif /* RESULTS_H */
1	/***************************************
2	$Header: /home/amb/CVS/routino/src/results.h,v 1.10 2009-02-10 19:49:26 amb Exp $
3
4	A header file for the results.
5	****************/ /****************
6	Written by Andrew M. Bishop
7
8	This file Copyright 2009 Andrew M. Bishop
9	It may be distributed under the GNU Public License, version 2, or
10	any higher version. See section COPYING of the GNU Public license
11	for conditions under which this file may be redistributed.
12	***************************************/
13
14
15	#ifndef RESULTS_H
16	#define RESULTS_H /+ To stop multiple inclusions. +/
17
18	#include <stdint.h>
19
20	#include "types.h"
21
22
23	/* Data structures */
24
25	/+ The result for a node. +/
26	typedef struct _Result
27	{
28	index_t node; /+ The node for which this result applies. +/
29
30	index_t prev; /+ The previous node following the best path. +/
31	index_t next; /+ The next node following the best path. +/
32
33	distance_t distance; /+ The distance travelled to the node following the best path. +/
34	duration_t duration; /+ The time taken to the node following the best path. +/
35
36	distance_t sortby; /+ The value to sort the results by in the queue. +/
37	}
38	Result;
39
40	/+ A list of results. +/
41	typedef struct _Results
42	{
43	uint32_t nbins; /+ The number of bins. +/
44	uint32_t mask; /+ A bit mask to select the bottom 'nbins' bits. +/
45
46	uint32_t alloced; /*+ The amount of space allocated for results
47	(the length of the number and pointers arrays and
48	1/nbins times the amount in the real results). +*/
49	uint32_t number; /+ The total number of occupied results. +/
50
51	uint32_t count; /+ An array of nbins counters of results in each array. +*/
52	Result **point; /+ An array of nbins arrays of pointers to actual results. +*/
53
54	Result *data; /+ An array of arrays containing the actual results
55	(don't need to realloc the array of data when adding more,
56	only realloc the array that points to the array of data).
57	Most importantly pointers into the real data don't change
58	as more space is allocated (since realloc is not being used). +*/
59	}
60	Results;
61
62
63	/* Functions */
64
65	Results *NewResultsList(int nbins);
66	void FreeResultsList(Results *results);
67
68	Result InsertResult(Results results,index_t node);
69
70	Result FindResult(Results results,index_t node);
71
72	Result FirstResult(Results results);
73	Result NextResult(Results results,Result *result);
74
75	/* Queue Functions */
76
77	void insert_in_queue(Result *result);
78	Result *pop_from_queue(void);
79
80
81	#endif /* RESULTS_H */