trunk/src/segmentsx.h

/***************************************
 $Header: /home/amb/CVS/routino/src/segmentsx.h,v 1.28 2010-12-18 19:17:26 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; 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. +*/

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

 index_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 IndexFirstSegmentX1(SegmentsX* segmentsx,node_t node);
index_t IndexNextSegmentX1(SegmentsX* segmentsx,index_t segindex,node_t node);

index_t IndexFirstSegmentX2(SegmentsX* segmentsx,index_t node);
index_t IndexNextSegmentX2(SegmentsX* segmentsx,index_t segindex,index_t node);

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	amb	110	/***************************************
2	amb	544	$Header: /home/amb/CVS/routino/src/segmentsx.h,v 1.28 2010-12-18 19:17:26 amb Exp $
3	amb	110
4			A header file for the extended segments.
5	amb	151
6			Part of the Routino routing software.
7	amb	110	****************/ /****************
8	amb	326	This file Copyright 2008-2010 Andrew M. Bishop
9	amb	110
10	amb	151	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	amb	110	***************************************/
23
24
25			#ifndef SEGMENTSX_H
26			#define SEGMENTSX_H /+ To stop multiple inclusions. +/
27
28			#include <stdint.h>
29
30	amb	449	#include "types.h"
31	amb	448	#include "segments.h"
32
33	amb	199	#include "typesx.h"
34	amb	110
35	amb	451	#include "files.h"
36	amb	110
37	amb	451
38	amb	110	/* Data structures */
39
40
41			/+ An extended structure used for processing. +/
42			struct _SegmentX
43			{
44	amb	539	node_t node1; /+ The id of the starting node; initially the OSM value, later the NodeX index. +/
45			node_t node2; /+ The id of the finishing node; initially the OSM value, later the NodeX index. +/
46	amb	110
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	465	index_t xnumber; /+ The number of unsorted extended nodes. +/
60	amb	216
61	amb	452	#if !SLIM
62
63	amb	256	SegmentX xdata; /+ The extended segment data (unsorted). +*/
64
65	amb	452	#else
66
67			SegmentX xcached[2]; /+ Two cached segments read from the file in slim mode. +/
68
69			#endif
70
71	amb	465	index_t number; /+ How many entries are still useful? +/
72	amb	110
73	amb	275	node_t idata; /+ The extended segment data (sorted by node1 then node2). +*/
74	amb	279	index_t firstnode; /+ The first segment index for each node. +*/
75	amb	209
76	amb	452	#if !SLIM
77
78	amb	229	Segment sdata; /+ The segment data (same order as n1data). +*/
79	amb	448
80	amb	452	#else
81
82	amb	448	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	amb	452
87			#endif
88	amb	110	};
89
90
91			/* Functions */
92
93
94	amb	326	SegmentsX *NewSegmentList(int append);
95			void FreeSegmentList(SegmentsX *segmentsx,int keep);
96	amb	110
97			void SaveSegmentList(SegmentsX segmentsx,const char filename);
98
99	amb	544	index_t IndexFirstSegmentX1(SegmentsX* segmentsx,node_t node);
100			index_t IndexNextSegmentX1(SegmentsX* segmentsx,index_t segindex,node_t node);
101	amb	256
102	amb	544	index_t IndexFirstSegmentX2(SegmentsX* segmentsx,index_t node);
103			index_t IndexNextSegmentX2(SegmentsX* segmentsx,index_t segindex,index_t node);
104	amb	279
105	amb	209	void AppendSegment(SegmentsX* segmentsx,way_t way,node_t node1,node_t node2,distance_t distance);
106	amb	110
107	amb	279	void SortSegmentList(SegmentsX* segmentsx);
108	amb	110
109	amb	204	void RemoveBadSegments(NodesX nodesx,SegmentsX segmentsx);
110	amb	110
111	amb	279	void UpdateSegments(SegmentsX segmentsx,NodesX nodesx,WaysX *waysx);
112	amb	110
113	amb	275	void RotateSegments(SegmentsX* segmentsx);
114
115	amb	279	void DeduplicateSegments(SegmentsX* segmentsx,NodesX nodesx,WaysX waysx);
116	amb	110
117	amb	209	void CreateRealSegments(SegmentsX segmentsx,WaysX waysx);
118
119	amb	110	void IndexSegments(SegmentsX* segmentsx,NodesX *nodesx);
120
121
122	amb	452	/* Macros / inline functions */
123	amb	451
124
125	amb	452	#if !SLIM
126
127			#define LookupSegmentX(segmentsx,index,position) &(segmentsx)->xdata[index]
128
129			#define LookupSegmentXSegment(segmentsx,index,position) &(segmentsx)->sdata[index]
130
131			#else
132
133			static SegmentX LookupSegmentX(SegmentsX segmentsx,index_t index,int position);
134
135			static Segment LookupSegmentXSegment(SegmentsX segmentsx,index_t index,int position);
136
137			static void PutBackSegmentXSegment(SegmentsX* segmentsx,index_t index,int position);
138
139
140	amb	451	/*++++++++++++++++++++++++++++++++++++++
141			Lookup a particular extended segment.
142
143			SegmentX *LookupSegmentX Returns a pointer to the extended segment with the specified id.
144
145			SegmentsX* segmentsx The set of segments to process.
146
147			index_t index The segment index to look for.
148
149			int position The position in the cache to use.
150			++++++++++++++++++++++++++++++++++++++*/
151
152			static inline SegmentX LookupSegmentX(SegmentsX segmentsx,index_t index,int position)
153			{
154	amb	464	SeekFile(segmentsx->fd,(off_t)index*sizeof(SegmentX));
155	amb	451
156	amb	452	ReadFile(segmentsx->fd,&segmentsx->xcached[position-1],sizeof(SegmentX));
157	amb	451
158	amb	452	return(&segmentsx->xcached[position-1]);
159	amb	451	}
160
161
162			/*++++++++++++++++++++++++++++++++++++++
163			Lookup a particular extended segment's normal segment.
164
165			Segment *LookupSegmentXSegment Returns a pointer to the segment with the specified id.
166
167			SegmentsX* segmentsx The set of segments to process.
168
169			index_t index The segment index to look for.
170
171			int position The position in the cache to use.
172			++++++++++++++++++++++++++++++++++++++*/
173
174			static inline Segment LookupSegmentXSegment(SegmentsX segmentsx,index_t index,int position)
175			{
176	amb	464	SeekFile(segmentsx->sfd,(off_t)index*sizeof(Segment));
177	amb	451
178	amb	452	ReadFile(segmentsx->sfd,&segmentsx->scached[position-1],sizeof(Segment));
179	amb	451
180	amb	452	return(&segmentsx->scached[position-1]);
181	amb	451	}
182
183
184			/*++++++++++++++++++++++++++++++++++++++
185			Put back an extended segment's normal segment.
186
187			SegmentsX* segmentsx The set of segments to process.
188
189			index_t index The segment index to look for.
190
191			int position The position in the cache to use.
192			++++++++++++++++++++++++++++++++++++++*/
193
194			static inline void PutBackSegmentXSegment(SegmentsX* segmentsx,index_t index,int position)
195			{
196	amb	464	SeekFile(segmentsx->sfd,(off_t)index*sizeof(Segment));
197	amb	451
198	amb	452	WriteFile(segmentsx->sfd,&segmentsx->scached[position-1],sizeof(Segment));
199	amb	451	}
200
201	amb	452	#endif /* SLIM */
202	amb	451
203	amb	452
204	amb	110	#endif /* SEGMENTSX_H */