trunk/src/nodesx.h

/***************************************
 $Header: /home/amb/CVS/routino/src/nodesx.h,v 1.26 2010-07-13 17:43:51 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 <assert.h>
#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. +*/

 NodeX    *xdata;               /*+ The extended node data (sorted). +*/
 NodeX     cached[2];           /*+ Two cached nodes read from the file in slim mode. +*/

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

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

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

 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);
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);

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);


/* Inline the frequently called functions */

/*+ The command line '--slim' option. +*/
extern int option_slim;

/*++++++++++++++++++++++++++++++++++++++
  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)
{
 assert(index!=NO_NODE);     /* Must be a valid node */

 if(option_slim)
   {
    SeekFile(nodesx->fd,index*sizeof(NodeX));

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

    return(&nodesx->cached[position-1]);
   }
 else
   {
    return(&nodesx->xdata[index]);
   }
}


/*++++++++++++++++++++++++++++++++++++++
  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)
{
 assert(index!=NO_NODE);     /* Must be a valid node */

 if(option_slim)
   {
    SeekFile(nodesx->nfd,index*sizeof(Node));

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

    return(&nodesx->ncached[position-1]);
   }
 else
   {
    return(&nodesx->ndata[index]);
   }
}


/*++++++++++++++++++++++++++++++++++++++
  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)
{
 assert(index!=NO_NODE);     /* Must be a valid node */

 if(option_slim)
   {
    SeekFile(nodesx->nfd,index*sizeof(Node));

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


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