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. +*/
 nodeflags_t  flags;            /*+ The node flags. +*/
};

/*+ A structure containing a set of nodes (memory format). +*/
struct _NodesX
{
 char     *filename;            /*+ The name of the intermediate file (for the NodesX). +*/
 char     *filename_tmp;        /*+ The name of the temporary file (for the NodesX). +*/

 int       fd;                  /*+ The file descriptor of the open file (for the NodesX). +*/

 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[3];           /*+ Three cached extended nodes read from the file in slim mode. +*/
 index_t   incache[3];          /*+ The indexes of the cached extended nodes. +*/

#endif

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

 index_t  *pdata;               /*+ The node indexes after pruning. +*/

 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,int readonly);
void FreeNodeList(NodesX *nodesx,int preserve);

void AppendNodeList(NodesX *nodesx,node_t id,double latitude,double longitude,transports_t allow,nodeflags_t flags);
void FinishNodeList(NodesX *nodesx);

index_t IndexNodeX(NodesX *nodesx,node_t id);

void SortNodeList(NodesX *nodesx);

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

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

void SortNodeListGeographically(NodesX *nodesx);

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


/* Macros and inline functions */

#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	/***************************************
2	A header file for the extended nodes.
3
4	Part of the Routino routing software.
5	****************/ /****************
6	This file Copyright 2008-2012 Andrew M. Bishop
7
8	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	***************************************/
21
22
23	#ifndef NODESX_H
24	#define NODESX_H /+ To stop multiple inclusions. +/
25
26	#include <stdint.h>
27
28	#include "types.h"
29	#include "nodes.h"
30
31	#include "typesx.h"
32
33	#include "files.h"
34
35
36	/* Data structures */
37
38
39	/+ An extended structure used for processing. +/
40	struct _NodeX
41	{
42	node_t id; /+ The node identifier; initially the OSM value, later the Node index, finally the first segment. +/
43
44	latlong_t latitude; /+ The node latitude. +/
45	latlong_t longitude; /+ The node longitude. +/
46
47	transports_t allow; /+ The node allowed traffic. +/
48	nodeflags_t flags; /+ The node flags. +/
49	};
50
51	/+ A structure containing a set of nodes (memory format). +/
52	struct _NodesX
53	{
54	char filename; /+ The name of the intermediate file (for the NodesX). +*/
55	char filename_tmp; /+ The name of the temporary file (for the NodesX). +*/
56
57	int fd; /+ The file descriptor of the open file (for the NodesX). +/
58
59	index_t number; /+ The number of extended nodes still being considered. +/
60
61	#if !SLIM
62
63	NodeX data; /+ The extended node data (when mapped into memory). +*/
64
65	#else
66
67	NodeX cached[3]; /+ Three cached extended nodes read from the file in slim mode. +/
68	index_t incache[3]; /+ The indexes of the cached extended nodes. +/
69
70	#endif
71
72	node_t idata; /+ The extended node IDs (sorted by ID). +*/
73
74	index_t pdata; /+ The node indexes after pruning. +*/
75
76	index_t gdata; /+ The final node indexes (sorted geographically). +*/
77
78	BitMask super; /+ A bit-mask marker for super nodes (same order as sorted nodes). +*/
79
80	index_t latbins; /+ The number of bins containing latitude. +/
81	index_t lonbins; /+ The number of bins containing longitude. +/
82
83	ll_bin_t latzero; /+ The bin number of the furthest south bin. +/
84	ll_bin_t lonzero; /+ The bin number of the furthest west bin. +/
85	};
86
87
88	/* Functions in nodesx.c */
89
90	NodesX *NewNodeList(int append,int readonly);
91	void FreeNodeList(NodesX *nodesx,int preserve);
92
93	void AppendNodeList(NodesX *nodesx,node_t id,double latitude,double longitude,transports_t allow,nodeflags_t flags);
94	void FinishNodeList(NodesX *nodesx);
95
96	index_t IndexNodeX(NodesX *nodesx,node_t id);
97
98	void SortNodeList(NodesX *nodesx);
99
100	void RemoveNonHighwayNodes(NodesX nodesx,SegmentsX segmentsx,int preserve);
101
102	void RemovePrunedNodes(NodesX nodesx,SegmentsX segmentsx);
103
104	void SortNodeListGeographically(NodesX *nodesx);
105
106	void SaveNodeList(NodesX nodesx,const char filename,SegmentsX *segmentsx);
107
108
109	/* Macros and inline functions */
110
111	#if !SLIM
112
113	#define LookupNodeX(nodesx,index,position) &(nodesx)->data[index]
114
115	#define PutBackNodeX(nodesx,nodex) /* nop */
116
117	#else
118
119	static NodeX LookupNodeX(NodesX nodesx,index_t index,int position);
120
121	static void PutBackNodeX(NodesX nodesx,NodeX nodex);
122
123
124	/*++++++++++++++++++++++++++++++++++++++
125	Lookup a particular extended node with the specified id from the file on disk.
126
127	NodeX *LookupNodeX Returns a pointer to a cached copy of the extended node.
128
129	NodesX *nodesx The set of nodes to use.
130
131	index_t index The node index to look for.
132
133	int position The position in the cache to use.
134	++++++++++++++++++++++++++++++++++++++*/
135
136	static inline NodeX LookupNodeX(NodesX nodesx,index_t index,int position)
137	{
138	SeekReadFile(nodesx->fd,&nodesx->cached[position-1],sizeof(NodeX),(off_t)index*sizeof(NodeX));
139
140	nodesx->incache[position-1]=index;
141
142	return(&nodesx->cached[position-1]);
143	}
144
145
146	/*++++++++++++++++++++++++++++++++++++++
147	Put back an extended node's data into the file on disk.
148
149	NodesX *nodesx The set of nodes to modify.
150
151	NodeX *nodex The extended node to be put back.
152	++++++++++++++++++++++++++++++++++++++*/
153
154	static inline void PutBackNodeX(NodesX nodesx,NodeX nodex)
155	{
156	int position1=nodex-&nodesx->cached[0];
157
158	SeekWriteFile(nodesx->fd,&nodesx->cached[position1],sizeof(NodeX),(off_t)nodesx->incache[position1]*sizeof(NodeX));
159	}
160
161	#endif /* SLIM */
162
163
164	#endif /* NODESX_H */