trunk/src/segmentsx.h

/***************************************
 $Header: /home/amb/CVS/routino/src/segmentsx.h,v 1.25 2010-07-31 14:06:56 amb Exp $

 A header file for the extended segments.

 Part of the Routino routing software.
 ******************/ /******************
 This file Copyright 2008-2010 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. +*/
 node_t     node2;              /*+ The id of the finishing node. +*/

 way_t      way;                /*+ The id of the way. +*/

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

 uint32_t   xnumber;            /*+ The number of unsorted extended nodes. +*/

#if !SLIM

 SegmentX  *xdata;              /*+ The extended segment data (unsorted). +*/

#else

 SegmentX   xcached[2];         /*+ Two cached segments read from the file in slim mode. +*/

#endif

 uint32_t   number;             /*+ How many entries are still useful? +*/

 node_t   *idata;               /*+ The extended segment data (sorted by node1 then node2). +*/
 index_t  *firstnode;           /*+ The first segment index for each node. +*/

#if !SLIM

 Segment   *sdata;              /*+ The segment data (same order as n1data). +*/

#else

 char     *sfilename;           /*+ The name of the temporary file for segments in slim mode. +*/
 int       sfd;                 /*+ The file descriptor of the temporary file. +*/

 Segment   scached[2];          /*+ Two cached segments read from the file in slim mode. +*/

#endif
};


/* Functions */


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

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

index_t IndexFirstSegmentX(SegmentsX* segmentsx,node_t node);

index_t IndexNextSegmentX(SegmentsX* segmentsx,index_t segindex,index_t nodeindex);

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 UpdateSegments(SegmentsX *segmentsx,NodesX *nodesx,WaysX *waysx);

void RotateSegments(SegmentsX* segmentsx);

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

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

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


/* Macros / inline functions */


#if !SLIM

#define LookupSegmentX(segmentsx,index,position)         &(segmentsx)->xdata[index]
  
#define LookupSegmentXSegment(segmentsx,index,position)  &(segmentsx)->sdata[index]

#else

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

static Segment *LookupSegmentXSegment(SegmentsX* segmentsx,index_t index,int position);

static void PutBackSegmentXSegment(SegmentsX* segmentsx,index_t index,int position);


/*++++++++++++++++++++++++++++++++++++++
  Lookup a particular extended segment.

  SegmentX *LookupSegmentX Returns a pointer to the extended segment with the specified id.

  SegmentsX* segmentsx The set of segments to process.

  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->xcached[position-1],sizeof(SegmentX));

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


/*++++++++++++++++++++++++++++++++++++++
  Lookup a particular extended segment's normal segment.

  Segment *LookupSegmentXSegment Returns a pointer to the segment with the specified id.

  SegmentsX* segmentsx The set of segments to process.

  index_t index The segment index to look for.

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

static inline Segment *LookupSegmentXSegment(SegmentsX* segmentsx,index_t index,int position)
{
 SeekFile(segmentsx->sfd,(off_t)index*sizeof(Segment));

 ReadFile(segmentsx->sfd,&segmentsx->scached[position-1],sizeof(Segment));

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


/*++++++++++++++++++++++++++++++++++++++
  Put back an extended segment's normal segment.

  SegmentsX* segmentsx The set of segments to process.

  index_t index The segment index to look for.

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

static inline void PutBackSegmentXSegment(SegmentsX* segmentsx,index_t index,int position)
{
 SeekFile(segmentsx->sfd,(off_t)index*sizeof(Segment));

 WriteFile(segmentsx->sfd,&segmentsx->scached[position-1],sizeof(Segment));
}

#endif /* SLIM */


#endif /* SEGMENTSX_H */
1	/***************************************
2	$Header: /home/amb/CVS/routino/src/segmentsx.h,v 1.25 2010-07-31 14:06:56 amb Exp $
3
4	A header file for the extended segments.
5
6	Part of the Routino routing software.
7	****************/ /****************
8	This file Copyright 2008-2010 Andrew M. Bishop
9
10	This program is free software: you can redistribute it and/or modify
11	it under the terms of the GNU Affero General Public License as published by
12	the Free Software Foundation, either version 3 of the License, or
13	(at your option) any later version.
14
15	This program is distributed in the hope that it will be useful,
16	but WITHOUT ANY WARRANTY; without even the implied warranty of
17	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18	GNU Affero General Public License for more details.
19
20	You should have received a copy of the GNU Affero General Public License
21	along with this program. If not, see <http://www.gnu.org/licenses/>.
22	***************************************/
23
24
25	#ifndef SEGMENTSX_H
26	#define SEGMENTSX_H /+ To stop multiple inclusions. +/
27
28	#include <stdint.h>
29
30	#include "types.h"
31	#include "segments.h"
32
33	#include "typesx.h"
34
35	#include "files.h"
36
37
38	/* Data structures */
39
40
41	/+ An extended structure used for processing. +/
42	struct _SegmentX
43	{
44	node_t node1; /+ The id of the starting node. +/
45	node_t node2; /+ The id of the finishing node. +/
46
47	way_t way; /+ The id of the way. +/
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	uint32_t xnumber; /+ The number of unsorted extended nodes. +/
60
61	#if !SLIM
62
63	SegmentX xdata; /+ The extended segment data (unsorted). +*/
64
65	#else
66
67	SegmentX xcached[2]; /+ Two cached segments read from the file in slim mode. +/
68
69	#endif
70
71	uint32_t number; /+ How many entries are still useful? +/
72
73	node_t idata; /+ The extended segment data (sorted by node1 then node2). +*/
74	index_t firstnode; /+ The first segment index for each node. +*/
75
76	#if !SLIM
77
78	Segment sdata; /+ The segment data (same order as n1data). +*/
79
80	#else
81
82	char sfilename; /+ The name of the temporary file for segments in slim mode. +*/
83	int sfd; /+ The file descriptor of the temporary file. +/
84
85	Segment scached[2]; /+ Two cached segments read from the file in slim mode. +/
86
87	#endif
88	};
89
90
91	/* Functions */
92
93
94	SegmentsX *NewSegmentList(int append);
95	void FreeSegmentList(SegmentsX *segmentsx,int keep);
96
97	void SaveSegmentList(SegmentsX segmentsx,const char filename);
98
99	index_t IndexFirstSegmentX(SegmentsX* segmentsx,node_t node);
100
101	index_t IndexNextSegmentX(SegmentsX* segmentsx,index_t segindex,index_t nodeindex);
102
103	void AppendSegment(SegmentsX* segmentsx,way_t way,node_t node1,node_t node2,distance_t distance);
104
105	void SortSegmentList(SegmentsX* segmentsx);
106
107	void RemoveBadSegments(NodesX nodesx,SegmentsX segmentsx);
108
109	void UpdateSegments(SegmentsX segmentsx,NodesX nodesx,WaysX *waysx);
110
111	void RotateSegments(SegmentsX* segmentsx);
112
113	void DeduplicateSegments(SegmentsX* segmentsx,NodesX nodesx,WaysX waysx);
114
115	void CreateRealSegments(SegmentsX segmentsx,WaysX waysx);
116
117	void IndexSegments(SegmentsX* segmentsx,NodesX *nodesx);
118
119
120	/* Macros / inline functions */
121
122
123	#if !SLIM
124
125	#define LookupSegmentX(segmentsx,index,position) &(segmentsx)->xdata[index]
126
127	#define LookupSegmentXSegment(segmentsx,index,position) &(segmentsx)->sdata[index]
128
129	#else
130
131	static SegmentX LookupSegmentX(SegmentsX segmentsx,index_t index,int position);
132
133	static Segment LookupSegmentXSegment(SegmentsX segmentsx,index_t index,int position);
134
135	static void PutBackSegmentXSegment(SegmentsX* segmentsx,index_t index,int position);
136
137
138	/*++++++++++++++++++++++++++++++++++++++
139	Lookup a particular extended segment.
140
141	SegmentX *LookupSegmentX Returns a pointer to the extended segment with the specified id.
142
143	SegmentsX* segmentsx The set of segments to process.
144
145	index_t index The segment index to look for.
146
147	int position The position in the cache to use.
148	++++++++++++++++++++++++++++++++++++++*/
149
150	static inline SegmentX LookupSegmentX(SegmentsX segmentsx,index_t index,int position)
151	{
152	SeekFile(segmentsx->fd,(off_t)index*sizeof(SegmentX));
153
154	ReadFile(segmentsx->fd,&segmentsx->xcached[position-1],sizeof(SegmentX));
155
156	return(&segmentsx->xcached[position-1]);
157	}
158
159
160	/*++++++++++++++++++++++++++++++++++++++
161	Lookup a particular extended segment's normal segment.
162
163	Segment *LookupSegmentXSegment Returns a pointer to the segment with the specified id.
164
165	SegmentsX* segmentsx The set of segments to process.
166
167	index_t index The segment index to look for.
168
169	int position The position in the cache to use.
170	++++++++++++++++++++++++++++++++++++++*/
171
172	static inline Segment LookupSegmentXSegment(SegmentsX segmentsx,index_t index,int position)
173	{
174	SeekFile(segmentsx->sfd,(off_t)index*sizeof(Segment));
175
176	ReadFile(segmentsx->sfd,&segmentsx->scached[position-1],sizeof(Segment));
177
178	return(&segmentsx->scached[position-1]);
179	}
180
181
182	/*++++++++++++++++++++++++++++++++++++++
183	Put back an extended segment's normal segment.
184
185	SegmentsX* segmentsx The set of segments to process.
186
187	index_t index The segment index to look for.
188
189	int position The position in the cache to use.
190	++++++++++++++++++++++++++++++++++++++*/
191
192	static inline void PutBackSegmentXSegment(SegmentsX* segmentsx,index_t index,int position)
193	{
194	SeekFile(segmentsx->sfd,(off_t)index*sizeof(Segment));
195
196	WriteFile(segmentsx->sfd,&segmentsx->scached[position-1],sizeof(Segment));
197	}
198
199	#endif /* SLIM */
200
201
202	#endif /* SEGMENTSX_H */