trunk/src/nodesx.h

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

 A header file for the extended 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 NODESX_H
#define NODESX_H    /*+ To stop multiple inclusions. +*/

#include <stdint.h>

#include "types.h"
#include "nodes.h"

#include "typesx.h"

#include "files.h"


/* Data structures */


/*+ An extended structure used for processing. +*/
struct _NodeX
{
 node_t    id;                  /*+ The node identifier. +*/

 latlong_t latitude;            /*+ The node latitude. +*/
 latlong_t longitude;           /*+ The node longitude. +*/
};

/*+ A structure containing a set of nodes (memory format). +*/
struct _NodesX
{
 char     *filename;            /*+ The name of the temporary file. +*/
 int       fd;                  /*+ The file descriptor of the temporary file. +*/

 uint32_t  xnumber;             /*+ The number of unsorted extended nodes. +*/

#if !SLIM

 NodeX    *xdata;               /*+ The extended node data (sorted). +*/

#else

 NodeX     xcached[2];          /*+ Two cached nodes read from the file in slim mode. +*/

#endif

 uint32_t  number;              /*+ How many entries are still useful? +*/

 node_t   *idata;               /*+ The extended node IDs (sorted by ID). +*/

 uint8_t  *super;               /*+ A marker for super nodes (same order sorted nodes). +*/

#if !SLIM

 Node     *ndata;               /*+ The actual nodes (same order as geographically sorted nodes). +*/

#else

 char     *nfilename;           /*+ The name of the temporary file for nodes in slim mode. +*/
 int       nfd;                 /*+ The file descriptor of the temporary file. +*/

 Node      ncached[2];          /*+ Two cached nodes read from the file in slim mode. +*/

#endif

 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. +*/

 uint32_t  latlonbin;           /*+ A temporary index into the offsets array. +*/

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


/* Functions */

NodesX *NewNodeList(int append);
void FreeNodeList(NodesX *nodesx,int keep);

void SaveNodeList(NodesX *nodesx,const char *filename);

index_t IndexNodeX(NodesX* nodesx,node_t id);

void AppendNode(NodesX* nodesx,node_t id,double latitude,double longitude);

void SortNodeList(NodesX *nodesx);

void SortNodeListGeographically(NodesX* nodesx);

void RemoveNonHighwayNodes(NodesX *nodesx,SegmentsX *segmentsx);

void CreateRealNodes(NodesX *nodesx,int iteration);

void IndexNodes(NodesX *nodesx,SegmentsX *segmentsx);


/* Macros / inline functions */

#if !SLIM

#define LookupNodeX(nodesx,index,position)      &(nodesx)->xdata[index]
  
#define LookupNodeXNode(nodesx,index,position)  &(nodesx)->ndata[index]

#else

static NodeX *LookupNodeX(NodesX* nodesx,index_t index,int position);

static Node *LookupNodeXNode(NodesX* nodesx,index_t index,int position);

static void PutBackNodeXNode(NodesX* nodesx,index_t index,int position);


/*++++++++++++++++++++++++++++++++++++++
  Lookup a particular extended node.

  NodeX *LookupNodeX Returns a pointer to the extended node with the specified id.

  NodesX* nodesx The set of nodes to process.

  index_t index The node index to look for.

  int position The position in the cache to use.
  ++++++++++++++++++++++++++++++++++++++*/

static inline NodeX *LookupNodeX(NodesX* nodesx,index_t index,int position)
{
 SeekFile(nodesx->fd,(off_t)index*sizeof(NodeX));

 ReadFile(nodesx->fd,&nodesx->xcached[position-1],sizeof(NodeX));

 return(&nodesx->xcached[position-1]);
}


/*++++++++++++++++++++++++++++++++++++++
  Lookup a particular extended node's normal node.

  Node *LookupNodeXNode Returns a pointer to the node with the specified id.

  NodesX* nodesx The set of nodes to process.

  index_t index The node index to look for.

  int position The position in the cache to use.
  ++++++++++++++++++++++++++++++++++++++*/

static inline Node *LookupNodeXNode(NodesX* nodesx,index_t index,int position)
{
 SeekFile(nodesx->nfd,(off_t)index*sizeof(Node));

 ReadFile(nodesx->nfd,&nodesx->ncached[position-1],sizeof(Node));

 return(&nodesx->ncached[position-1]);
}


/*++++++++++++++++++++++++++++++++++++++
  Put back an extended node's normal node.

  NodesX* nodesx The set of nodes to process.

  index_t index The node index to look for.

  int position The position in the cache to use.
  ++++++++++++++++++++++++++++++++++++++*/

static inline void PutBackNodeXNode(NodesX* nodesx,index_t index,int position)
{
 SeekFile(nodesx->nfd,(off_t)index*sizeof(Node));

 WriteFile(nodesx->nfd,&nodesx->ncached[position-1],sizeof(Node));
}

#endif /* SLIM */


#endif /* NODESX_H */
1	amb	110	/***************************************
2	amb	464	$Header: /home/amb/CVS/routino/src/nodesx.h,v 1.28 2010-07-31 14:06:56 amb Exp $
3	amb	110
4			A header file for the extended nodes.
5	amb	151
6			Part of the Routino routing software.
7	amb	110	****************/ /****************
8	amb	326	This file Copyright 2008-2010 Andrew M. Bishop
9	amb	110
10	amb	151	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	amb	110	***************************************/
23
24
25			#ifndef NODESX_H
26			#define NODESX_H /+ To stop multiple inclusions. +/
27
28			#include <stdint.h>
29
30	amb	449	#include "types.h"
31	amb	448	#include "nodes.h"
32
33	amb	199	#include "typesx.h"
34	amb	110
35	amb	451	#include "files.h"
36	amb	110
37	amb	451
38	amb	110	/* Data structures */
39
40
41			/+ An extended structure used for processing. +/
42			struct _NodeX
43			{
44	amb	219	node_t id; /+ The node identifier. +/
45	amb	199
46	amb	223	latlong_t latitude; /+ The node latitude. +/
47			latlong_t longitude; /+ The node longitude. +/
48	amb	110	};
49
50			/+ A structure containing a set of nodes (memory format). +/
51			struct _NodesX
52			{
53	amb	252	char filename; /+ The name of the temporary file. +*/
54			int fd; /+ The file descriptor of the temporary file. +/
55	amb	216
56	amb	252	uint32_t xnumber; /+ The number of unsorted extended nodes. +/
57	amb	249
58	amb	452	#if !SLIM
59
60	amb	252	NodeX xdata; /+ The extended node data (sorted). +*/
61	amb	216
62	amb	452	#else
63
64			NodeX xcached[2]; /+ Two cached nodes read from the file in slim mode. +/
65
66			#endif
67
68	amb	219	uint32_t number; /+ How many entries are still useful? +/
69	amb	110
70	amb	278	node_t idata; /+ The extended node IDs (sorted by ID). +*/
71	amb	216
72	amb	281	uint8_t super; /+ A marker for super nodes (same order sorted nodes). +*/
73	amb	249
74	amb	452	#if !SLIM
75
76	amb	281	Node ndata; /+ The actual nodes (same order as geographically sorted nodes). +*/
77	amb	257
78	amb	452	#else
79
80	amb	448	char nfilename; /+ The name of the temporary file for nodes in slim mode. +*/
81			int nfd; /+ The file descriptor of the temporary file. +/
82
83			Node ncached[2]; /+ Two cached nodes read from the file in slim mode. +/
84
85	amb	452	#endif
86
87	amb	258	uint32_t latbins; /+ The number of bins containing latitude. +/
88			uint32_t lonbins; /+ The number of bins containing longitude. +/
89	amb	257
90	amb	258	ll_bin_t latzero; /+ The bin number of the furthest south bin. +/
91			ll_bin_t lonzero; /+ The bin number of the furthest west bin. +/
92	amb	257
93	amb	281	uint32_t latlonbin; /+ A temporary index into the offsets array. +/
94
95	amb	258	index_t offsets; /+ An array of offset to the first node in each bin. +*/
96	amb	110	};
97
98
99			/* Functions */
100
101	amb	326	NodesX *NewNodeList(int append);
102			void FreeNodeList(NodesX *nodesx,int keep);
103	amb	110
104			void SaveNodeList(NodesX nodesx,const char filename);
105
106	amb	249	index_t IndexNodeX(NodesX* nodesx,node_t id);
107	amb	110
108	amb	219	void AppendNode(NodesX* nodesx,node_t id,double latitude,double longitude);
109	amb	110
110	amb	263	void SortNodeList(NodesX *nodesx);
111	amb	110
112	amb	212	void SortNodeListGeographically(NodesX* nodesx);
113
114	amb	110	void RemoveNonHighwayNodes(NodesX nodesx,SegmentsX segmentsx);
115
116	amb	212	void CreateRealNodes(NodesX *nodesx,int iteration);
117	amb	110
118	amb	209	void IndexNodes(NodesX nodesx,SegmentsX segmentsx);
119	amb	110
120
121	amb	452	/* Macros / inline functions */
122	amb	451
123	amb	452	#if !SLIM
124	amb	451
125	amb	452	#define LookupNodeX(nodesx,index,position) &(nodesx)->xdata[index]
126
127			#define LookupNodeXNode(nodesx,index,position) &(nodesx)->ndata[index]
128
129			#else
130
131			static NodeX LookupNodeX(NodesX nodesx,index_t index,int position);
132
133			static Node LookupNodeXNode(NodesX nodesx,index_t index,int position);
134
135			static void PutBackNodeXNode(NodesX* nodesx,index_t index,int position);
136
137
138	amb	451	/*++++++++++++++++++++++++++++++++++++++
139			Lookup a particular extended node.
140
141			NodeX *LookupNodeX Returns a pointer to the extended node with the specified id.
142
143			NodesX* nodesx The set of nodes to process.
144
145			index_t index The node index to look for.
146
147			int position The position in the cache to use.
148			++++++++++++++++++++++++++++++++++++++*/
149
150			static inline NodeX LookupNodeX(NodesX nodesx,index_t index,int position)
151			{
152	amb	464	SeekFile(nodesx->fd,(off_t)index*sizeof(NodeX));
153	amb	451
154	amb	452	ReadFile(nodesx->fd,&nodesx->xcached[position-1],sizeof(NodeX));
155	amb	451
156	amb	452	return(&nodesx->xcached[position-1]);
157	amb	451	}
158
159
160			/*++++++++++++++++++++++++++++++++++++++
161			Lookup a particular extended node's normal node.
162
163			Node *LookupNodeXNode Returns a pointer to the node with the specified id.
164
165			NodesX* nodesx The set of nodes to process.
166
167			index_t index The node index to look for.
168
169			int position The position in the cache to use.
170			++++++++++++++++++++++++++++++++++++++*/
171
172			static inline Node LookupNodeXNode(NodesX nodesx,index_t index,int position)
173			{
174	amb	464	SeekFile(nodesx->nfd,(off_t)index*sizeof(Node));
175	amb	451
176	amb	452	ReadFile(nodesx->nfd,&nodesx->ncached[position-1],sizeof(Node));
177	amb	451
178	amb	452	return(&nodesx->ncached[position-1]);
179	amb	451	}
180
181
182			/*++++++++++++++++++++++++++++++++++++++
183			Put back an extended node's normal node.
184
185			NodesX* nodesx The set of nodes to process.
186
187			index_t index The node index to look for.
188
189			int position The position in the cache to use.
190			++++++++++++++++++++++++++++++++++++++*/
191
192			static inline void PutBackNodeXNode(NodesX* nodesx,index_t index,int position)
193			{
194	amb	464	SeekFile(nodesx->nfd,(off_t)index*sizeof(Node));
195	amb	451
196	amb	452	WriteFile(nodesx->nfd,&nodesx->ncached[position-1],sizeof(Node));
197	amb	451	}
198
199	amb	452	#endif /* SLIM */
200	amb	451
201	amb	452
202	amb	110	#endif /* NODESX_H */