trunk/src/nodesx.h

/***************************************
 $Header: /home/amb/CVS/routino/src/nodesx.h,v 1.30 2010-08-02 18:44:54 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. +*/

 allow_t   allow;               /*+ The node allowed traffic. +*/
};

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

 index_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

 index_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

 index_t   latbins;             /*+ The number of bins containing latitude. +*/
 index_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. +*/

 index_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,allow_t allow);

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