trunk/src/segmentsx.h

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

 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 SEGMENTSX_H
#define SEGMENTSX_H    /*+ To stop multiple inclusions. +*/

#include <stdint.h>

#include "types.h"

#include "typesx.h"

#include "files.h"


/* Data structures */


/*+ An extended structure used for processing. +*/
struct _SegmentX
{
 node_t     node1;              /*+ The id of the starting node; initially the OSM value, later the NodeX index. +*/
 node_t     node2;              /*+ The id of the finishing node; initially the OSM value, later the NodeX index. +*/

 index_t    next2;              /*+ The index of the next segment with the same node2. +*/

 way_t      way;                /*+ The id of the way; initially the OSM value, later the WayX index. +*/

 distance_t distance;           /*+ The distance between the nodes. +*/
};


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

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

 index_t    number;             /*+ The number of extended segments still being considered. +*/

#if !SLIM

 SegmentX  *data;               /*+ The extended segment data (when mapped into memory). +*/

#else

 SegmentX   cached[4];          /*+ Four cached extended segments read from the file in slim mode. +*/
 index_t    incache[4];         /*+ The indexes of the cached extended segments. +*/

#endif

 index_t   *firstnode;          /*+ The first segment index for each node. +*/

 index_t   *next1;              /*+ The index of the next segment with the same node1 (used while pruning). +*/

 BitMask   *usednode;           /*+ A flag to indicate if a node is used (used for removing bad segments). +*/

 BitMask   *usedway;            /*+ A flag to indicate if a way is used (used for removing pruned ways). +*/
};


/* Functions in segmentsx.c */

SegmentsX *NewSegmentList(int append,int readonly);
void FreeSegmentList(SegmentsX *segmentsx,int preserve);

void AppendSegment(SegmentsX *segmentsx,way_t way,node_t node1,node_t node2,distance_t distance);
void FinishSegmentList(SegmentsX *segmentsx);

SegmentX *FirstSegmentX(SegmentsX *segmentsx,index_t nodeindex,int position);
SegmentX *NextSegmentX(SegmentsX *segmentsx,SegmentX *segmentx,index_t nodeindex);

void ApplySegmentChanges(SegmentsX *segmentsx);

void SortSegmentList(SegmentsX *segmentsx);

void IndexSegments(SegmentsX *segmentsx,NodesX *nodesx,WaysX *waysx);

void RemoveBadSegments(SegmentsX *segmentsx,NodesX *nodesx,WaysX *waysx,int preserve);

void MeasureSegments(SegmentsX *segmentsx,NodesX *nodesx,WaysX *waysx);

void RemovePrunedSegments(SegmentsX *segmentsx,WaysX *waysx);

void DeduplicateSuperSegments(SegmentsX *segmentsx,WaysX *waysx);

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

void SaveSegmentList(SegmentsX *segmentsx,const char *filename);


/* Macros / inline functions */

/*+ Return true if this is a pruned segment. +*/
#define IsPrunedSegmentX(xxx)   ((xxx)->node1==NO_NODE)


#if !SLIM

#define LookupSegmentX(segmentsx,index,position)         &(segmentsx)->data[index]

#define IndexSegmentX(segmentsx,segmentx)                (index_t)((segmentx)-&(segmentsx)->data[0])

#define PutBackSegmentX(segmentsx,segmentx)              /* nop */

#define ReLookupSegmentX(segmentsx,segmentx)             /* nop */
  
#else

static SegmentX *LookupSegmentX(SegmentsX *segmentsx,index_t index,int position);

static index_t IndexSegmentX(SegmentsX *segmentsx,SegmentX *segmentx);

static void PutBackSegmentX(SegmentsX *segmentsx,SegmentX *segmentx);

static void ReLookupSegmentX(SegmentsX *segmentsx,SegmentX *segmentx);


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

  SegmentX *LookupSegmentX Returns a pointer to a cached copy of the extended segment.

  SegmentsX *segmentsx The set of segments to use.

  index_t index The segment index to look for.

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

static inline SegmentX *LookupSegmentX(SegmentsX *segmentsx,index_t index,int position)
{
 SeekReadFile(segmentsx->fd,&segmentsx->cached[position-1],sizeof(SegmentX),(off_t)index*sizeof(SegmentX));

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

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


/*++++++++++++++++++++++++++++++++++++++
  Find the extended segment index for a particular extended segment pointer.

  index_t IndexSegmentX Returns the index of the extended segment.

  SegmentsX *segmentsx The set of segments to use.

  SegmentX *segmentx The extended segment whose index is to be found.
  ++++++++++++++++++++++++++++++++++++++*/

static inline index_t IndexSegmentX(SegmentsX *segmentsx,SegmentX *segmentx)
{
 int position1=segmentx-&segmentsx->cached[0];

 return(segmentsx->incache[position1]);
}


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

  SegmentsX *segmentsx The set of segments to use.

  SegmentX *segmentx The extended segment to be put back.
  ++++++++++++++++++++++++++++++++++++++*/

static inline void PutBackSegmentX(SegmentsX *segmentsx,SegmentX *segmentx)
{
 int position1=segmentx-&segmentsx->cached[0];

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


/*++++++++++++++++++++++++++++++++++++++
  Lookup an extended segment's data from the disk into file again after the disk was updated.

  SegmentsX *segmentsx The set of segments to use.

  SegmentX *segmentx The extended segment to refresh.
  ++++++++++++++++++++++++++++++++++++++*/

static inline void ReLookupSegmentX(SegmentsX *segmentsx,SegmentX *segmentx)
{
 int position1=segmentx-&segmentsx->cached[0];

 SeekReadFile(segmentsx->fd,&segmentsx->cached[position1],sizeof(SegmentX),(off_t)segmentsx->incache[position1]*sizeof(SegmentX));
}

#endif /* SLIM */


#endif /* SEGMENTSX_H */
1	amb	110	/***************************************
2			A header file for the extended segments.
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 SEGMENTSX_H
24			#define SEGMENTSX_H /+ To stop multiple inclusions. +/
25
26			#include <stdint.h>
27
28	amb	449	#include "types.h"
29	amb	448
30	amb	199	#include "typesx.h"
31	amb	110
32	amb	451	#include "files.h"
33	amb	110
34	amb	451
35	amb	110	/* Data structures */
36
37
38			/+ An extended structure used for processing. +/
39			struct _SegmentX
40			{
41	amb	539	node_t node1; /+ The id of the starting node; initially the OSM value, later the NodeX index. +/
42			node_t node2; /+ The id of the finishing node; initially the OSM value, later the NodeX index. +/
43	amb	110
44	amb	643	index_t next2; /+ The index of the next segment with the same node2. +/
45
46	amb	539	way_t way; /+ The id of the way; initially the OSM value, later the WayX index. +/
47	amb	203
48	amb	209	distance_t distance; /+ The distance between the nodes. +/
49	amb	110	};
50
51
52			/+ A structure containing a set of segments (memory format). +/
53			struct _SegmentsX
54			{
55	amb	1120	char filename; /+ The name of the intermediate file (for the SegmentsX). +*/
56			char filename_tmp; /+ The name of the temporary file (for the SegmentsX). +*/
57	amb	216
58	amb	1120	int fd; /+ The file descriptor of the open file (for the SegmentsX). +/
59
60	amb	651	index_t number; /+ The number of extended segments still being considered. +/
61	amb	216
62	amb	452	#if !SLIM
63
64	amb	651	SegmentX data; /+ The extended segment data (when mapped into memory). +*/
65	amb	256
66	amb	452	#else
67
68	amb	964	SegmentX cached[4]; /+ Four cached extended segments read from the file in slim mode. +/
69			index_t incache[4]; /+ The indexes of the cached extended segments. +/
70	amb	452
71			#endif
72
73	amb	643	index_t firstnode; /+ The first segment index for each node. +*/
74	amb	558
75	amb	949	index_t next1; /+ The index of the next segment with the same node1 (used while pruning). +*/
76
77	amb	950	BitMask usednode; /+ A flag to indicate if a node is used (used for removing bad segments). +*/
78	amb	1100
79			BitMask usedway; /+ A flag to indicate if a way is used (used for removing pruned ways). +*/
80	amb	110	};
81
82
83	amb	680	/* Functions in segmentsx.c */
84	amb	110
85	amb	1123	SegmentsX *NewSegmentList(int append,int readonly);
86	amb	1151	void FreeSegmentList(SegmentsX *segmentsx,int preserve);
87	amb	110
88	amb	1151	void AppendSegment(SegmentsX *segmentsx,way_t way,node_t node1,node_t node2,distance_t distance);
89			void FinishSegmentList(SegmentsX *segmentsx);
90
91	amb	771	SegmentX FirstSegmentX(SegmentsX segmentsx,index_t nodeindex,int position);
92	amb	943	SegmentX NextSegmentX(SegmentsX segmentsx,SegmentX *segmentx,index_t nodeindex);
93	amb	256
94	amb	1140	void ApplySegmentChanges(SegmentsX *segmentsx);
95
96	amb	1100	void SortSegmentList(SegmentsX *segmentsx);
97	amb	110
98	amb	1160	void IndexSegments(SegmentsX segmentsx,NodesX nodesx,WaysX *waysx);
99	amb	1107
100	amb	1140	void RemoveBadSegments(SegmentsX segmentsx,NodesX nodesx,WaysX *waysx,int preserve);
101	amb	110
102	amb	644	void MeasureSegments(SegmentsX segmentsx,NodesX nodesx,WaysX *waysx);
103	amb	110
104	amb	1160	void RemovePrunedSegments(SegmentsX segmentsx,WaysX waysx);
105
106	amb	1132	void DeduplicateSuperSegments(SegmentsX segmentsx,WaysX waysx);
107	amb	110
108	amb	1160	void SortSegmentListGeographically(SegmentsX segmentsx,NodesX nodesx);
109	amb	209
110	amb	1160	void SaveSegmentList(SegmentsX segmentsx,const char filename);
111	amb	110
112
113	amb	452	/* Macros / inline functions */
114	amb	451
115	amb	949	/+ Return true if this is a pruned segment. +/
116			#define IsPrunedSegmentX(xxx) ((xxx)->node1==NO_NODE)
117	amb	451
118	amb	949
119	amb	452	#if !SLIM
120
121	amb	651	#define LookupSegmentX(segmentsx,index,position) &(segmentsx)->data[index]
122	amb	452
123	amb	788	#define IndexSegmentX(segmentsx,segmentx) (index_t)((segmentx)-&(segmentsx)->data[0])
124	amb	557
125	amb	942	#define PutBackSegmentX(segmentsx,segmentx) /* nop */
126	amb	1121
127			#define ReLookupSegmentX(segmentsx,segmentx) /* nop */
128	amb	643
129	amb	452	#else
130
131	amb	681	static SegmentX LookupSegmentX(SegmentsX segmentsx,index_t index,int position);
132	amb	452
133	amb	643	static index_t IndexSegmentX(SegmentsX segmentsx,SegmentX segmentx);
134	amb	452
135	amb	942	static void PutBackSegmentX(SegmentsX segmentsx,SegmentX segmentx);
136	amb	452
137	amb	1121	static void ReLookupSegmentX(SegmentsX segmentsx,SegmentX segmentx);
138	amb	452
139	amb	1121
140	amb	451	/*++++++++++++++++++++++++++++++++++++++
141	amb	680	Lookup a particular extended segment with the specified id from the file on disk.
142	amb	451
143	amb	680	SegmentX *LookupSegmentX Returns a pointer to a cached copy of the extended segment.
144	amb	451
145	amb	681	SegmentsX *segmentsx The set of segments to use.
146	amb	451
147			index_t index The segment index to look for.
148
149			int position The position in the cache to use.
150			++++++++++++++++++++++++++++++++++++++*/
151
152	amb	681	static inline SegmentX LookupSegmentX(SegmentsX segmentsx,index_t index,int position)
153	amb	451	{
154	amb	887	SeekReadFile(segmentsx->fd,&segmentsx->cached[position-1],sizeof(SegmentX),(off_t)index*sizeof(SegmentX));
155	amb	451
156	amb	643	segmentsx->incache[position-1]=index;
157
158			return(&segmentsx->cached[position-1]);
159	amb	451	}
160
161
162			/*++++++++++++++++++++++++++++++++++++++
163	amb	643	Find the extended segment index for a particular extended segment pointer.
164	amb	451
165	amb	680	index_t IndexSegmentX Returns the index of the extended segment.
166	amb	451
167	amb	681	SegmentsX *segmentsx The set of segments to use.
168	amb	451
169	amb	643	SegmentX *segmentx The extended segment whose index is to be found.
170	amb	451	++++++++++++++++++++++++++++++++++++++*/
171
172	amb	643	static inline index_t IndexSegmentX(SegmentsX segmentsx,SegmentX segmentx)
173	amb	451	{
174	amb	704	int position1=segmentx-&segmentsx->cached[0];
175	amb	451
176	amb	704	return(segmentsx->incache[position1]);
177	amb	451	}
178
179
180			/*++++++++++++++++++++++++++++++++++++++
181	amb	680	Put back an extended segment's data into the file on disk.
182	amb	451
183	amb	681	SegmentsX *segmentsx The set of segments to use.
184	amb	451
185	amb	942	SegmentX *segmentx The extended segment to be put back.
186	amb	451	++++++++++++++++++++++++++++++++++++++*/
187
188	amb	942	static inline void PutBackSegmentX(SegmentsX segmentsx,SegmentX segmentx)
189	amb	451	{
190	amb	942	int position1=segmentx-&segmentsx->cached[0];
191
192			SeekWriteFile(segmentsx->fd,&segmentsx->cached[position1],sizeof(SegmentX),(off_t)segmentsx->incache[position1]*sizeof(SegmentX));
193	amb	451	}
194
195	amb	1121
196			/*++++++++++++++++++++++++++++++++++++++
197			Lookup an extended segment's data from the disk into file again after the disk was updated.
198
199			SegmentsX *segmentsx The set of segments to use.
200
201			SegmentX *segmentx The extended segment to refresh.
202			++++++++++++++++++++++++++++++++++++++*/
203
204			static inline void ReLookupSegmentX(SegmentsX segmentsx,SegmentX segmentx)
205			{
206			int position1=segmentx-&segmentsx->cached[0];
207
208			SeekReadFile(segmentsx->fd,&segmentsx->cached[position1],sizeof(SegmentX),(off_t)segmentsx->incache[position1]*sizeof(SegmentX));
209			}
210
211	amb	452	#endif /* SLIM */
212	amb	451
213	amb	452
214	amb	110	#endif /* SEGMENTSX_H */