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

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

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