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


/* 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 nodeindex,int position);
SegmentX *NextSegmentX(SegmentsX *segmentsx,SegmentX *segmentx,index_t nodeindex);

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

void SortSegmentList(SegmentsX *segmentsx,int delete);

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

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


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

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