trunk/src/nodes.h

/***************************************
 $Header: /home/amb/CVS/routino/src/nodes.h,v 1.34 2010-07-31 14:06:56 amb Exp $

 A header file for the nodes.

 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 NODES_H
#define NODES_H    /*+ To stop multiple inclusions. +*/

#include <stdint.h>

#include "types.h"

#include "files.h"
#include "profiles.h"


/* Data structures */


/*+ A structure containing a single node. +*/
struct _Node
{
 index_t    firstseg;           /*+ The index of the first segment. +*/

 ll_off_t   latoffset;          /*+ The node latitude offset within its bin. +*/
 ll_off_t   lonoffset;          /*+ The node longitude offset within its bin. +*/
};


/*+ A structure containing the header from the file. +*/
typedef struct _NodesFile
{
 uint32_t number;               /*+ How many nodes in total? +*/
 uint32_t snumber;              /*+ How many super-nodes? +*/

 uint32_t latbins;              /*+ The number of bins containing latitude. +*/
 uint32_t lonbins;              /*+ The number of bins containing longitude. +*/

 ll_bin_t latzero;              /*+ The bin number of the furthest south bin. +*/
 ll_bin_t lonzero;              /*+ The bin number of the furthest west bin. +*/
}
 NodesFile;


/*+ A structure containing a set of nodes (and pointers to mmap file). +*/
struct _Nodes
{
 NodesFile file;                /*+ The header data from the file. +*/

#if !SLIM

 void     *data;                /*+ The memory mapped data. +*/

 index_t  *offsets;             /*+ An array of offsets to the first node in each bin. +*/

 Node     *nodes;               /*+ An array of nodes. +*/

#else

 int       fd;                  /*+ The file descriptor for the file. +*/
 off_t     nodesoffset;         /*+ The offset of the nodes within the file. +*/

 Node      cached[3];           /*+ The cached nodes. +*/
 index_t   incache[3];          /*+ The indexes of the cached nodes. +*/

#endif
};


/* Functions */

Nodes *LoadNodeList(const char *filename);

index_t FindClosestNode(Nodes* nodes,Segments *segments,Ways *ways,double latitude,double longitude,
                        distance_t distance,Profile *profile,distance_t *bestdist);

index_t FindClosestSegment(Nodes* nodes,Segments *segments,Ways *ways,double latitude,double longitude,
                           distance_t distance,Profile *profile, distance_t *bestdist,
                           index_t *bestnode1,index_t *bestnode2,distance_t *bestdist1,distance_t *bestdist2);

void GetLatLong(Nodes *nodes,index_t index,double *latitude,double *longitude);


/* Macros and inline functions */

#if !SLIM

/*+ Return a Node pointer given a set of nodes and an index. +*/
#define LookupNode(xxx,yyy,zzz)     (&(xxx)->nodes[yyy])

/*+ Return a Segment points given a Node pointer and a set of segments. +*/
#define FirstSegment(xxx,yyy,zzz)   LookupSegment((xxx),SEGMENT((yyy)->nodes[zzz].firstseg),1)

/*+ Return true if this is a super-node. +*/
#define IsSuperNode(xxx,yyy)        (((xxx)->nodes[yyy].firstseg)&NODE_SUPER)

/*+ Return the offset of a geographical region given a set of nodes and an index. +*/
#define LookupNodeOffset(xxx,yyy)   ((xxx)->offsets[yyy])

#else

static Node *LookupNode(Nodes *nodes,index_t index,int position);

#define FirstSegment(xxx,yyy,zzz)   LookupSegment((xxx),FirstSegment_internal(yyy,zzz),1)

static index_t FirstSegment_internal(Nodes *nodes,index_t index);

static int IsSuperNode(Nodes *nodes,index_t index);

static index_t LookupNodeOffset(Nodes *nodes,index_t index);


/*++++++++++++++++++++++++++++++++++++++
  Find the Node information for a particular node.

  Node *LookupNode Returns a pointer to the cached node information.

  Nodes *nodes The nodes structure to use.

  index_t index The index of the node.

  int position The position in the cache to store the value.
  ++++++++++++++++++++++++++++++++++++++*/

static inline Node *LookupNode(Nodes *nodes,index_t index,int position)
{
 SeekFile(nodes->fd,nodes->nodesoffset+(off_t)index*sizeof(Node));

 ReadFile(nodes->fd,&nodes->cached[position-1],sizeof(Node));

 nodes->incache[position-1]=index;

 return(&nodes->cached[position-1]);
}


/*++++++++++++++++++++++++++++++++++++++
  Find the index of the first segment of a node (called by FirstSegment() macro).

  index_t FirstSegment_internal Returns the index of the first segment.

  Nodes *nodes The nodes structure to use.

  index_t index The index of the node.
  ++++++++++++++++++++++++++++++++++++++*/

static inline index_t FirstSegment_internal(Nodes *nodes,index_t index)
{
 if(nodes->incache[0]==index)
    return(SEGMENT(nodes->cached[0].firstseg));
 else if(nodes->incache[1]==index)
    return(SEGMENT(nodes->cached[1].firstseg));
 else if(nodes->incache[2]==index)
    return(SEGMENT(nodes->cached[2].firstseg));
 else
   {
    Node *node=LookupNode(nodes,index,3);

    return(SEGMENT(node->firstseg));
   }
}


/*++++++++++++++++++++++++++++++++++++++
  Decide if a node is a super-node.

  int IsSuperNode Return true if it is a supernode.

  Nodes *nodes The nodes structure to use.

  index_t index The index of the node.
  ++++++++++++++++++++++++++++++++++++++*/

static inline int IsSuperNode(Nodes *nodes,index_t index)
{
 if(nodes->incache[0]==index)
    return(nodes->cached[0].firstseg&NODE_SUPER);
 else if(nodes->incache[1]==index)
    return(nodes->cached[1].firstseg&NODE_SUPER);
 else if(nodes->incache[2]==index)
    return(nodes->cached[2].firstseg&NODE_SUPER);
 else
   {
    Node *node=LookupNode(nodes,index,3);

    return(node->firstseg&NODE_SUPER);
   }
}


/*++++++++++++++++++++++++++++++++++++++
  Find the offset of nodes in a geographical region.

  index_t LookupNodeOffset Returns the value of the index offset.

  Nodes *nodes The nodes structure to use.

  index_t index The index of the offset.
  ++++++++++++++++++++++++++++++++++++++*/

static inline index_t LookupNodeOffset(Nodes *nodes,index_t index)
{
 index_t offset;

 SeekFile(nodes->fd,sizeof(NodesFile)+(off_t)index*sizeof(index_t));

 ReadFile(nodes->fd,&offset,sizeof(index_t));

 return(offset);
}

#endif


#endif /* NODES_H */
1	/***************************************
2	$Header: /home/amb/CVS/routino/src/nodes.h,v 1.34 2010-07-31 14:06:56 amb Exp $
3
4	A header file for the nodes.
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 NODES_H
26	#define NODES_H /+ To stop multiple inclusions. +/
27
28	#include <stdint.h>
29
30	#include "types.h"
31
32	#include "files.h"
33	#include "profiles.h"
34
35
36	/* Data structures */
37
38
39	/+ A structure containing a single node. +/
40	struct _Node
41	{
42	index_t firstseg; /+ The index of the first segment. +/
43
44	ll_off_t latoffset; /+ The node latitude offset within its bin. +/
45	ll_off_t lonoffset; /+ The node longitude offset within its bin. +/
46	};
47
48
49	/+ A structure containing the header from the file. +/
50	typedef struct _NodesFile
51	{
52	uint32_t number; /+ How many nodes in total? +/
53	uint32_t snumber; /+ How many super-nodes? +/
54
55	uint32_t latbins; /+ The number of bins containing latitude. +/
56	uint32_t lonbins; /+ The number of bins containing longitude. +/
57
58	ll_bin_t latzero; /+ The bin number of the furthest south bin. +/
59	ll_bin_t lonzero; /+ The bin number of the furthest west bin. +/
60	}
61	NodesFile;
62
63
64	/+ A structure containing a set of nodes (and pointers to mmap file). +/
65	struct _Nodes
66	{
67	NodesFile file; /+ The header data from the file. +/
68
69	#if !SLIM
70
71	void data; /+ The memory mapped data. +*/
72
73	index_t offsets; /+ An array of offsets to the first node in each bin. +*/
74
75	Node nodes; /+ An array of nodes. +*/
76
77	#else
78
79	int fd; /+ The file descriptor for the file. +/
80	off_t nodesoffset; /+ The offset of the nodes within the file. +/
81
82	Node cached[3]; /+ The cached nodes. +/
83	index_t incache[3]; /+ The indexes of the cached nodes. +/
84
85	#endif
86	};
87
88
89	/* Functions */
90
91	Nodes LoadNodeList(const char filename);
92
93	index_t FindClosestNode(Nodes* nodes,Segments segments,Ways ways,double latitude,double longitude,
94	distance_t distance,Profile profile,distance_t bestdist);
95
96	index_t FindClosestSegment(Nodes* nodes,Segments segments,Ways ways,double latitude,double longitude,
97	distance_t distance,Profile profile, distance_t bestdist,
98	index_t bestnode1,index_t bestnode2,distance_t bestdist1,distance_t bestdist2);
99
100	void GetLatLong(Nodes nodes,index_t index,double latitude,double *longitude);
101
102
103	/* Macros and inline functions */
104
105	#if !SLIM
106
107	/+ Return a Node pointer given a set of nodes and an index. +/
108	#define LookupNode(xxx,yyy,zzz) (&(xxx)->nodes[yyy])
109
110	/+ Return a Segment points given a Node pointer and a set of segments. +/
111	#define FirstSegment(xxx,yyy,zzz) LookupSegment((xxx),SEGMENT((yyy)->nodes[zzz].firstseg),1)
112
113	/+ Return true if this is a super-node. +/
114	#define IsSuperNode(xxx,yyy) (((xxx)->nodes[yyy].firstseg)&NODE_SUPER)
115
116	/+ Return the offset of a geographical region given a set of nodes and an index. +/
117	#define LookupNodeOffset(xxx,yyy) ((xxx)->offsets[yyy])
118
119	#else
120
121	static Node LookupNode(Nodes nodes,index_t index,int position);
122
123	#define FirstSegment(xxx,yyy,zzz) LookupSegment((xxx),FirstSegment_internal(yyy,zzz),1)
124
125	static index_t FirstSegment_internal(Nodes *nodes,index_t index);
126
127	static int IsSuperNode(Nodes *nodes,index_t index);
128
129	static index_t LookupNodeOffset(Nodes *nodes,index_t index);
130
131
132	/*++++++++++++++++++++++++++++++++++++++
133	Find the Node information for a particular node.
134
135	Node *LookupNode Returns a pointer to the cached node information.
136
137	Nodes *nodes The nodes structure to use.
138
139	index_t index The index of the node.
140
141	int position The position in the cache to store the value.
142	++++++++++++++++++++++++++++++++++++++*/
143
144	static inline Node LookupNode(Nodes nodes,index_t index,int position)
145	{
146	SeekFile(nodes->fd,nodes->nodesoffset+(off_t)index*sizeof(Node));
147
148	ReadFile(nodes->fd,&nodes->cached[position-1],sizeof(Node));
149
150	nodes->incache[position-1]=index;
151
152	return(&nodes->cached[position-1]);
153	}
154
155
156	/*++++++++++++++++++++++++++++++++++++++
157	Find the index of the first segment of a node (called by FirstSegment() macro).
158
159	index_t FirstSegment_internal Returns the index of the first segment.
160
161	Nodes *nodes The nodes structure to use.
162
163	index_t index The index of the node.
164	++++++++++++++++++++++++++++++++++++++*/
165
166	static inline index_t FirstSegment_internal(Nodes *nodes,index_t index)
167	{
168	if(nodes->incache[0]==index)
169	return(SEGMENT(nodes->cached[0].firstseg));
170	else if(nodes->incache[1]==index)
171	return(SEGMENT(nodes->cached[1].firstseg));
172	else if(nodes->incache[2]==index)
173	return(SEGMENT(nodes->cached[2].firstseg));
174	else
175	{
176	Node *node=LookupNode(nodes,index,3);
177
178	return(SEGMENT(node->firstseg));
179	}
180	}
181
182
183	/*++++++++++++++++++++++++++++++++++++++
184	Decide if a node is a super-node.
185
186	int IsSuperNode Return true if it is a supernode.
187
188	Nodes *nodes The nodes structure to use.
189
190	index_t index The index of the node.
191	++++++++++++++++++++++++++++++++++++++*/
192
193	static inline int IsSuperNode(Nodes *nodes,index_t index)
194	{
195	if(nodes->incache[0]==index)
196	return(nodes->cached[0].firstseg&NODE_SUPER);
197	else if(nodes->incache[1]==index)
198	return(nodes->cached[1].firstseg&NODE_SUPER);
199	else if(nodes->incache[2]==index)
200	return(nodes->cached[2].firstseg&NODE_SUPER);
201	else
202	{
203	Node *node=LookupNode(nodes,index,3);
204
205	return(node->firstseg&NODE_SUPER);
206	}
207	}
208
209
210	/*++++++++++++++++++++++++++++++++++++++
211	Find the offset of nodes in a geographical region.
212
213	index_t LookupNodeOffset Returns the value of the index offset.
214
215	Nodes *nodes The nodes structure to use.
216
217	index_t index The index of the offset.
218	++++++++++++++++++++++++++++++++++++++*/
219
220	static inline index_t LookupNodeOffset(Nodes *nodes,index_t index)
221	{
222	index_t offset;
223
224	SeekFile(nodes->fd,sizeof(NodesFile)+(off_t)index*sizeof(index_t));
225
226	ReadFile(nodes->fd,&offset,sizeof(index_t));
227
228	return(offset);
229	}
230
231	#endif
232
233
234	#endif /* NODES_H */