trunk/src/nodesx.h

/***************************************
 A header file for the extended nodes.

 Part of the Routino routing software.
 ******************/ /******************
 This file Copyright 2008-2012 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; initially the OSM value, later the Node index, finally the first segment. +*/

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

 transports_t allow;            /*+ The node allowed traffic. +*/

 uint16_t     flags;            /*+ The node flags. +*/
};

/*+ 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   number;              /*+ The number of extended nodes still being considered. +*/

#if !SLIM

 NodeX    *data;                /*+ The extended node data (when mapped into memory). +*/

#else

 NodeX     cached[2];           /*+ Two cached extended nodes read from the file in slim mode. +*/
 index_t   incache[2];          /*+ The indexes of the cached extended nodes. +*/

#endif

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

 index_t  *gdata;               /*+ The final node indexes (sorted geographically). +*/

 BitMask  *super;               /*+ A bit-mask marker for super nodes (same order as sorted nodes). +*/

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


/* Functions in nodesx.c */

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,transports_t allow,uint16_t flags);

void SortNodeList(NodesX *nodesx);

void SortNodeListGeographically(NodesX *nodesx);

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

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


/* Macros and inline functions */

/*+ Return true if this is a pruned node. +*/
#define IsPrunedNodeX(xxx)   ((xxx)->latitude==NO_LATLONG)


#if !SLIM

#define LookupNodeX(nodesx,index,position)      &(nodesx)->data[index]
  
#define PutBackNodeX(nodesx,nodex)              /* nop */

#else

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

static void PutBackNodeX(NodesX *nodesx,NodeX *nodex);


/*++++++++++++++++++++++++++++++++++++++
  Lookup a particular extended node with the specified id from the file on disk.

  NodeX *LookupNodeX Returns a pointer to a cached copy of the extended node.

  NodesX *nodesx The set of nodes to use.

  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)
{
 SeekReadFile(nodesx->fd,&nodesx->cached[position-1],sizeof(NodeX),(off_t)index*sizeof(NodeX));

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

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


/*++++++++++++++++++++++++++++++++++++++
  Put back an extended node's data into the file on disk.

  NodesX *nodesx The set of nodes to modify.

  NodeX *nodex The extended node to be put back.
  ++++++++++++++++++++++++++++++++++++++*/

static inline void PutBackNodeX(NodesX *nodesx,NodeX *nodex)
{
 int position1=nodex-&nodesx->cached[0];

 SeekWriteFile(nodesx->fd,&nodesx->cached[position1],sizeof(NodeX),(off_t)nodesx->incache[position1]*sizeof(NodeX));
}

#endif /* SLIM */


#endif /* NODESX_H */
1	amb	110	/***************************************
2			A header file for the extended nodes.
3	amb	151
4			Part of the Routino routing software.
5	amb	110	****************/ /****************
6	amb	949	This file Copyright 2008-2012 Andrew M. Bishop
7	amb	110
8	amb	151	This program is free software: you can redistribute it and/or modify
9			it under the terms of the GNU Affero General Public License as published by
10			the Free Software Foundation, either version 3 of the License, or
11			(at your option) any later version.
12
13			This program is distributed in the hope that it will be useful,
14			but WITHOUT ANY WARRANTY; without even the implied warranty of
15			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			GNU Affero General Public License for more details.
17
18			You should have received a copy of the GNU Affero General Public License
19			along with this program. If not, see <http://www.gnu.org/licenses/>.
20	amb	110	***************************************/
21
22
23			#ifndef NODESX_H
24			#define NODESX_H /+ To stop multiple inclusions. +/
25
26			#include <stdint.h>
27
28	amb	449	#include "types.h"
29	amb	448	#include "nodes.h"
30
31	amb	199	#include "typesx.h"
32	amb	110
33	amb	451	#include "files.h"
34	amb	110
35	amb	451
36	amb	110	/* Data structures */
37
38
39			/+ An extended structure used for processing. +/
40			struct _NodeX
41			{
42	amb	600	node_t id; /+ The node identifier; initially the OSM value, later the Node index, finally the first segment. +/
43	amb	199
44	amb	529	latlong_t latitude; /+ The node latitude. +/
45			latlong_t longitude; /+ The node longitude. +/
46	amb	469
47	amb	529	transports_t allow; /+ The node allowed traffic. +/
48	amb	537
49			uint16_t flags; /+ The node flags. +/
50	amb	110	};
51
52			/+ A structure containing a set of nodes (memory format). +/
53			struct _NodesX
54			{
55	amb	252	char filename; /+ The name of the temporary file. +*/
56			int fd; /+ The file descriptor of the temporary file. +/
57	amb	216
58	amb	650	index_t number; /+ The number of extended nodes still being considered. +/
59	amb	249
60	amb	452	#if !SLIM
61
62	amb	651	NodeX data; /+ The extended node data (when mapped into memory). +*/
63	amb	216
64	amb	452	#else
65
66	amb	942	NodeX cached[2]; /+ Two cached extended nodes read from the file in slim mode. +/
67			index_t incache[2]; /+ The indexes of the cached extended nodes. +/
68	amb	452
69			#endif
70
71	amb	278	node_t idata; /+ The extended node IDs (sorted by ID). +*/
72	amb	216
73	amb	755	index_t gdata; /+ The final node indexes (sorted geographically). +*/
74	amb	249
75	amb	950	BitMask super; /+ A bit-mask marker for super nodes (same order as sorted nodes). +*/
76	amb	452
77	amb	465	index_t latbins; /+ The number of bins containing latitude. +/
78			index_t lonbins; /+ The number of bins containing longitude. +/
79	amb	257
80	amb	258	ll_bin_t latzero; /+ The bin number of the furthest south bin. +/
81			ll_bin_t lonzero; /+ The bin number of the furthest west bin. +/
82	amb	110	};
83
84
85	amb	680	/* Functions in nodesx.c */
86	amb	110
87	amb	326	NodesX *NewNodeList(int append);
88			void FreeNodeList(NodesX *nodesx,int keep);
89	amb	110
90			void SaveNodeList(NodesX nodesx,const char filename);
91
92	amb	681	index_t IndexNodeX(NodesX *nodesx,node_t id);
93	amb	110
94	amb	681	void AppendNode(NodesX *nodesx,node_t id,double latitude,double longitude,transports_t allow,uint16_t flags);
95	amb	110
96	amb	263	void SortNodeList(NodesX *nodesx);
97	amb	110
98	amb	681	void SortNodeListGeographically(NodesX *nodesx);
99	amb	212
100	amb	110	void RemoveNonHighwayNodes(NodesX nodesx,SegmentsX segmentsx);
101
102	amb	653	void UpdateNodes(NodesX nodesx,SegmentsX segmentsx);
103	amb	110
104
105	amb	680	/* Macros and inline functions */
106	amb	451
107	amb	949	/+ Return true if this is a pruned node. +/
108	amb	961	#define IsPrunedNodeX(xxx) ((xxx)->latitude==NO_LATLONG)
109	amb	949
110
111	amb	452	#if !SLIM
112	amb	451
113	amb	651	#define LookupNodeX(nodesx,index,position) &(nodesx)->data[index]
114	amb	452
115	amb	942	#define PutBackNodeX(nodesx,nodex) /* nop */
116	amb	557
117	amb	452	#else
118
119	amb	681	static NodeX LookupNodeX(NodesX nodesx,index_t index,int position);
120	amb	452
121	amb	942	static void PutBackNodeX(NodesX nodesx,NodeX nodex);
122	amb	452
123
124	amb	451	/*++++++++++++++++++++++++++++++++++++++
125	amb	680	Lookup a particular extended node with the specified id from the file on disk.
126	amb	451
127	amb	680	NodeX *LookupNodeX Returns a pointer to a cached copy of the extended node.
128	amb	451
129	amb	681	NodesX *nodesx The set of nodes to use.
130	amb	451
131			index_t index The node index to look for.
132
133			int position The position in the cache to use.
134			++++++++++++++++++++++++++++++++++++++*/
135
136	amb	681	static inline NodeX LookupNodeX(NodesX nodesx,index_t index,int position)
137	amb	451	{
138	amb	887	SeekReadFile(nodesx->fd,&nodesx->cached[position-1],sizeof(NodeX),(off_t)index*sizeof(NodeX));
139	amb	451
140	amb	942	nodesx->incache[position-1]=index;
141
142	amb	651	return(&nodesx->cached[position-1]);
143	amb	451	}
144
145
146			/*++++++++++++++++++++++++++++++++++++++
147	amb	680	Put back an extended node's data into the file on disk.
148	amb	451
149	amb	681	NodesX *nodesx The set of nodes to modify.
150	amb	451
151	amb	942	NodeX *nodex The extended node to be put back.
152	amb	451	++++++++++++++++++++++++++++++++++++++*/
153
154	amb	942	static inline void PutBackNodeX(NodesX nodesx,NodeX nodex)
155	amb	451	{
156	amb	942	int position1=nodex-&nodesx->cached[0];
157
158			SeekWriteFile(nodesx->fd,&nodesx->cached[position1],sizeof(NodeX),(off_t)nodesx->incache[position1]*sizeof(NodeX));
159	amb	451	}
160
161	amb	452	#endif /* SLIM */
162	amb	451
163	amb	452
164	amb	110	#endif /* NODESX_H */