trunk/src/results.h

/***************************************
 $Header: /home/amb/CVS/routino/src/results.h,v 1.18 2010-07-23 14:32:16 amb Exp $

 A header file for the results.

 Part of the Routino routing software.
 ******************/ /******************
 This file Copyright 2008-2010 Andrew M. Bishop

 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Affero General Public License as published by
 the Free Software Foundation, either version 3 of the License, or
 (at your option) any later version.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU Affero General Public License for more details.

 You should have received a copy of the GNU Affero General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ***************************************/


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

#include <stdint.h>

#include "types.h"


/* Constants */

/*+ A result is not currently queued. +*/
#define NOT_QUEUED (uint32_t)(~0)


/* Data structures */

/*+ The result for a node. +*/
typedef struct _Result
{
 index_t   node;                /*+ The node for which this result applies. +*/
 index_t   segment;             /*+ The segment for the path to here (from prev). +*/

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

 score_t   score;               /*+ The best actual weighted distance or duration score from the start to the node. +*/

 score_t   sortby;              /*+ The best possible weighted distance or duration score from the start to the finish. +*/
 uint32_t  queued;              /*+ The position of this result 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). +*/

 index_t start;                 /*+ The start node. +*/
 index_t finish;                /*+ The finish node. +*/
}
 Results;


/* Forward definitions for opaque type */

typedef struct _Queue Queue;


/* Results Functions */

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

Result *InsertResult(Results *results,index_t node);
void ZeroResult(Result *result);

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

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


/* Queue Functions */

Queue *NewQueueList(void);
void FreeQueueList(Queue *queue);

void InsertInQueue(Queue *queue,Result *result);
Result *PopFromQueue(Queue *queue);


#endif /* RESULTS_H */
1	/***************************************
2	$Header: /home/amb/CVS/routino/src/results.h,v 1.18 2010-07-23 14:32:16 amb Exp $
3
4	A header file for the results.
5
6	Part of the Routino routing software.
7	****************/ /****************
8	This file Copyright 2008-2010 Andrew M. Bishop
9
10	This program is free software: you can redistribute it and/or modify
11	it under the terms of the GNU Affero General Public License as published by
12	the Free Software Foundation, either version 3 of the License, or
13	(at your option) any later version.
14
15	This program is distributed in the hope that it will be useful,
16	but WITHOUT ANY WARRANTY; without even the implied warranty of
17	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18	GNU Affero General Public License for more details.
19
20	You should have received a copy of the GNU Affero General Public License
21	along with this program. If not, see <http://www.gnu.org/licenses/>.
22	***************************************/
23
24
25	#ifndef RESULTS_H
26	#define RESULTS_H /+ To stop multiple inclusions. +/
27
28	#include <stdint.h>
29
30	#include "types.h"
31
32
33	/* Constants */
34
35	/+ A result is not currently queued. +/
36	#define NOT_QUEUED (uint32_t)(~0)
37
38
39	/* Data structures */
40
41	/+ The result for a node. +/
42	typedef struct _Result
43	{
44	index_t node; /+ The node for which this result applies. +/
45	index_t segment; /+ The segment for the path to here (from prev). +/
46
47	index_t prev; /+ The previous node following the best path. +/
48	index_t next; /+ The next node following the best path. +/
49
50	score_t score; /+ The best actual weighted distance or duration score from the start to the node. +/
51
52	score_t sortby; /+ The best possible weighted distance or duration score from the start to the finish. +/
53	uint32_t queued; /+ The position of this result in the queue. +/
54	}
55	Result;
56
57	/+ A list of results. +/
58	typedef struct _Results
59	{
60	uint32_t nbins; /+ The number of bins. +/
61	uint32_t mask; /+ A bit mask to select the bottom 'nbins' bits. +/
62
63	uint32_t alloced; /*+ The amount of space allocated for results
64	(the length of the number and pointers arrays and
65	1/nbins times the amount in the real results). +*/
66	uint32_t number; /+ The total number of occupied results. +/
67
68	uint32_t count; /+ An array of nbins counters of results in each array. +*/
69	Result **point; /+ An array of nbins arrays of pointers to actual results. +*/
70
71	Result *data; /+ An array of arrays containing the actual results
72	(don't need to realloc the array of data when adding more,
73	only realloc the array that points to the array of data).
74	Most importantly pointers into the real data don't change
75	as more space is allocated (since realloc is not being used). +*/
76
77	index_t start; /+ The start node. +/
78	index_t finish; /+ The finish node. +/
79	}
80	Results;
81
82
83	/* Forward definitions for opaque type */
84
85	typedef struct _Queue Queue;
86
87
88	/* Results Functions */
89
90	Results *NewResultsList(int nbins);
91	void FreeResultsList(Results *results);
92
93	Result InsertResult(Results results,index_t node);
94	void ZeroResult(Result *result);
95
96	Result FindResult(Results results,index_t node);
97
98	Result FirstResult(Results results);
99	Result NextResult(Results results,Result *result);
100
101
102	/* Queue Functions */
103
104	Queue *NewQueueList(void);
105	void FreeQueueList(Queue *queue);
106
107	void InsertInQueue(Queue queue,Result result);
108	Result PopFromQueue(Queue queue);
109
110
111	#endif /* RESULTS_H */