trunk/src/segmentsx.h

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

 Part of the Routino routing software.
 ******************/ /******************
 This file Copyright 2008-2011 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 "segments.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 temporary file. +*/
 int        fd;                 /*+ The file descriptor of the temporary file. +*/

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

#endif

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

 char      *usednode;           /*+ A flag to indicte if a node is used. +*/
};


/* Functions in segmentsx.c */


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

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

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

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

void SortSegmentList(SegmentsX *segmentsx);

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

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

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

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

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

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


/* Macros / inline functions */


#if !SLIM

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

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

#define PutBackSegmentX(segmentsx,index,position)        /* 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,index_t index,int position);


/*++++++++++++++++++++++++++++++++++++++
  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)
{
 SeekFile(segmentsx->fd,(off_t)index*sizeof(SegmentX));

 ReadFile(segmentsx->fd,&segmentsx->cached[position-1],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.

  index_t index The segment index to put back.

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

static inline void PutBackSegmentX(SegmentsX *segmentsx,index_t index,int position)
{
 SeekFile(segmentsx->fd,(off_t)index*sizeof(SegmentX));

 WriteFile(segmentsx->fd,&segmentsx->cached[position-1],sizeof(SegmentX));
}

#endif /* SLIM */


#endif /* SEGMENTSX_H */
1	/***************************************
2	A header file for the extended segments.
3
4	Part of the Routino routing software.
5	****************/ /****************
6	This file Copyright 2008-2011 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 SEGMENTSX_H
24	#define SEGMENTSX_H /+ To stop multiple inclusions. +/
25
26	#include <stdint.h>
27
28	#include "types.h"
29	#include "segments.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 _SegmentX
41	{
42	node_t node1; /+ The id of the starting node; initially the OSM value, later the NodeX index. +/
43	node_t node2; /+ The id of the finishing node; initially the OSM value, later the NodeX index. +/
44
45	index_t next2; /+ The index of the next segment with the same node2. +/
46
47	way_t way; /+ The id of the way; initially the OSM value, later the WayX index. +/
48
49	distance_t distance; /+ The distance between the nodes. +/
50	};
51
52
53	/+ A structure containing a set of segments (memory format). +/
54	struct _SegmentsX
55	{
56	char filename; /+ The name of the temporary file. +*/
57	int fd; /+ The file descriptor of the temporary file. +/
58
59	index_t number; /+ The number of extended segments still being considered. +/
60
61	#if !SLIM
62
63	SegmentX data; /+ The extended segment data (when mapped into memory). +*/
64
65	#else
66
67	SegmentX cached[2]; /+ Two cached extended segments read from the file in slim mode. +/
68	index_t incache[2]; /+ The indexes of the cached extended segments. +/
69
70	#endif
71
72	index_t firstnode; /+ The first segment index for each node. +*/
73
74	char usednode; /+ A flag to indicte if a node is used. +*/
75	};
76
77
78	/* Functions in segmentsx.c */
79
80
81	SegmentsX *NewSegmentList(int append);
82	void FreeSegmentList(SegmentsX *segmentsx,int keep);
83
84	void SaveSegmentList(SegmentsX segmentsx,const char filename);
85
86	SegmentX FirstSegmentX(SegmentsX segmentsx,index_t node,int position);
87	SegmentX NextSegmentX(SegmentsX segmentsx,SegmentX *segmentx,index_t node,int position);
88
89	void AppendSegment(SegmentsX *segmentsx,way_t way,node_t node1,node_t node2,distance_t distance);
90
91	void SortSegmentList(SegmentsX *segmentsx);
92
93	void RemoveBadSegments(NodesX nodesx,SegmentsX segmentsx);
94
95	void MeasureSegments(SegmentsX segmentsx,NodesX nodesx,WaysX *waysx);
96
97	void DeduplicateSegments(SegmentsX segmentsx,NodesX nodesx,WaysX *waysx);
98
99	void CreateRealSegments(SegmentsX segmentsx,WaysX waysx);
100
101	void IndexSegments(SegmentsX segmentsx,NodesX nodesx);
102
103	void UpdateSegments(SegmentsX segmentsx,NodesX nodesx,WaysX *waysx);
104
105
106	/* Macros / inline functions */
107
108
109	#if !SLIM
110
111	#define LookupSegmentX(segmentsx,index,position) &(segmentsx)->data[index]
112
113	#define IndexSegmentX(segmentsx,segmentx) ((segmentx)-&(segmentsx)->data[0])
114
115	#define PutBackSegmentX(segmentsx,index,position) /* nop */
116
117	#else
118
119	static SegmentX LookupSegmentX(SegmentsX segmentsx,index_t index,int position);
120
121	static index_t IndexSegmentX(SegmentsX segmentsx,SegmentX segmentx);
122
123	static void PutBackSegmentX(SegmentsX *segmentsx,index_t index,int position);
124
125
126	/*++++++++++++++++++++++++++++++++++++++
127	Lookup a particular extended segment with the specified id from the file on disk.
128
129	SegmentX *LookupSegmentX Returns a pointer to a cached copy of the extended segment.
130
131	SegmentsX *segmentsx The set of segments to use.
132
133	index_t index The segment index to look for.
134
135	int position The position in the cache to use.
136	++++++++++++++++++++++++++++++++++++++*/
137
138	static inline SegmentX LookupSegmentX(SegmentsX segmentsx,index_t index,int position)
139	{
140	SeekFile(segmentsx->fd,(off_t)index*sizeof(SegmentX));
141
142	ReadFile(segmentsx->fd,&segmentsx->cached[position-1],sizeof(SegmentX));
143
144	segmentsx->incache[position-1]=index;
145
146	return(&segmentsx->cached[position-1]);
147	}
148
149
150	/*++++++++++++++++++++++++++++++++++++++
151	Find the extended segment index for a particular extended segment pointer.
152
153	index_t IndexSegmentX Returns the index of the extended segment.
154
155	SegmentsX *segmentsx The set of segments to use.
156
157	SegmentX *segmentx The extended segment whose index is to be found.
158	++++++++++++++++++++++++++++++++++++++*/
159
160	static inline index_t IndexSegmentX(SegmentsX segmentsx,SegmentX segmentx)
161	{
162	int position1=segmentx-&segmentsx->cached[0];
163
164	return(segmentsx->incache[position1]);
165	}
166
167
168	/*++++++++++++++++++++++++++++++++++++++
169	Put back an extended segment's data into the file on disk.
170
171	SegmentsX *segmentsx The set of segments to use.
172
173	index_t index The segment index to put back.
174
175	int position The position in the cache to use.
176	++++++++++++++++++++++++++++++++++++++*/
177
178	static inline void PutBackSegmentX(SegmentsX *segmentsx,index_t index,int position)
179	{
180	SeekFile(segmentsx->fd,(off_t)index*sizeof(SegmentX));
181
182	WriteFile(segmentsx->fd,&segmentsx->cached[position-1],sizeof(SegmentX));
183	}
184
185	#endif /* SLIM */
186
187
188	#endif /* SEGMENTSX_H */