trunk/src/functions.h

/***************************************
 $Header: /home/amb/CVS/routino/src/functions.h,v 1.50 2010-03-20 13:35:15 amb Exp $

 Header file for function prototypes

 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 FUNCTIONS_H
#define FUNCTIONS_H    /*+ To stop multiple inclusions. +*/

#include <sys/types.h>
#include <stdio.h>

#include "types.h"
#include "profiles.h"
#include "results.h"


/* In router.c */

/*+ Return true if this is a fake node. +*/
#define IsFakeNode(xxx)  ((xxx)&NODE_SUPER)

index_t CreateFakes(Nodes *nodes,int point,Segment *segment,index_t node1,index_t node2,distance_t dist1,distance_t dist2);

void GetFakeLatLong(index_t node, double *latitude,double *longitude);

Segment *FirstFakeSegment(index_t node);
Segment *NextFakeSegment(Segment *segment,index_t node);
Segment *ExtraFakeSegment(index_t node,index_t fakenode);


/* In files.c */

char *FileName(const char *dirname,const char *prefix, const char *name);

void *MapFile(const char *filename);
void *UnmapFile(const char *filename);

int OpenFile(const char *filename);
int AppendFile(const char *filename);
int ReOpenFile(const char *filename);

int WriteFile(int fd,const void *address,size_t length);
int ReadFile(int fd,void *address,size_t length);

off_t SizeFile(const char *filename);
int SeekFile(int fd,off_t position);

void CloseFile(int fd);

int DeleteFile(char *filename);


/* In optimiser.c */

Results *FindNormalRoute(Nodes *nodes,Segments *segments,Ways *ways,index_t start,index_t finish,Profile *profile);
Results *FindMiddleRoute(Nodes *supernodes,Segments *supersegments,Ways *superways,Results *begin,Results *end,Profile *profile);

Results *FindStartRoutes(Nodes *nodes,Segments *segments,Ways *ways,index_t start,Profile *profile);
Results *FindFinishRoutes(Nodes *nodes,Segments *segments,Ways *ways,index_t finish,Profile *profile);

Results *CombineRoutes(Results *results,Nodes *nodes,Segments *segments,Ways *ways,Profile *profile);

void FixForwardRoute(Results *results,index_t finish);


/* In output.c */

void PrintRouteHead(const char *copyright);
void PrintRoute(Results **results,int nresults,Nodes *nodes,Segments *segments,Ways *ways,Profile *profile);
void PrintRouteTail(void);


/* In sorting.c */

/*+ The type and size of variable to store the variable length +*/
#define FILESORT_VARINT   unsigned short
#define FILESORT_VARSIZE  sizeof(FILESORT_VARINT)

void filesort_fixed(int fd_in,int fd_out,size_t itemsize,int (*compare)(const void*,const void*),int (*buildindex)(void*,index_t));

void filesort_vary(int fd_in,int fd_out,int (*compare)(const void*,const void*),int (*buildindex)(void*,index_t));

void heapsort(void **datap,size_t nitems,int(*compare)(const void*, const void*));


#endif /* FUNCTIONS_H */
1	amb	2	/***************************************
2	amb	331	$Header: /home/amb/CVS/routino/src/functions.h,v 1.50 2010-03-20 13:35:15 amb Exp $
3	amb	2
4			Header file for function prototypes
5	amb	151
6			Part of the Routino routing software.
7	amb	2	****************/ /****************
8	amb	326	This file Copyright 2008-2010 Andrew M. Bishop
9	amb	2
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	2	***************************************/
23
24
25			#ifndef FUNCTIONS_H
26			#define FUNCTIONS_H /+ To stop multiple inclusions. +/
27
28	amb	331	#include <sys/types.h>
29	amb	2	#include <stdio.h>
30
31	amb	97	#include "types.h"
32	amb	82	#include "profiles.h"
33	amb	31	#include "results.h"
34	amb	2
35	amb	26
36	amb	303	/* In router.c */
37
38			/+ Return true if this is a fake node. +/
39			#define IsFakeNode(xxx) ((xxx)&NODE_SUPER)
40
41			index_t CreateFakes(Nodes nodes,int point,Segment segment,index_t node1,index_t node2,distance_t dist1,distance_t dist2);
42
43			void GetFakeLatLong(index_t node, double latitude,double longitude);
44
45			Segment *FirstFakeSegment(index_t node);
46			Segment NextFakeSegment(Segment segment,index_t node);
47			Segment *ExtraFakeSegment(index_t node,index_t fakenode);
48
49
50	amb	2	/* In files.c */
51
52	amb	162	char FileName(const char dirname,const char prefix, const char name);
53
54	amb	250	void MapFile(const char filename);
55	amb	255	void UnmapFile(const char filename);
56	amb	2
57	amb	87	int OpenFile(const char *filename);
58	amb	326	int AppendFile(const char *filename);
59	amb	251	int ReOpenFile(const char *filename);
60
61	amb	259	int WriteFile(int fd,const void *address,size_t length);
62	amb	251	int ReadFile(int fd,void *address,size_t length);
63
64	amb	331	off_t SizeFile(const char *filename);
65			int SeekFile(int fd,off_t position);
66
67	amb	97	void CloseFile(int fd);
68	amb	2
69	amb	251	int DeleteFile(char *filename);
70	amb	87
71	amb	251
72	amb	2	/* In optimiser.c */
73
74	amb	238	Results FindNormalRoute(Nodes nodes,Segments segments,Ways ways,index_t start,index_t finish,Profile *profile);
75			Results FindMiddleRoute(Nodes supernodes,Segments supersegments,Ways superways,Results begin,Results end,Profile *profile);
76	amb	2
77	amb	126	Results FindStartRoutes(Nodes nodes,Segments segments,Ways ways,index_t start,Profile *profile);
78			Results FindFinishRoutes(Nodes nodes,Segments segments,Ways ways,index_t finish,Profile *profile);
79	amb	31
80	amb	165	Results CombineRoutes(Results results,Nodes nodes,Segments segments,Ways ways,Profile profile);
81	amb	31
82	amb	290	void FixForwardRoute(Results *results,index_t finish);
83	amb	31
84	amb	290
85	amb	161	/* In output.c */
86
87	amb	164	void PrintRouteHead(const char *copyright);
88	amb	317	void PrintRoute(Results *results,int nresults,Nodes nodes,Segments segments,Ways ways,Profile *profile);
89	amb	164	void PrintRouteTail(void);
90	amb	161
91
92	amb	270	/* In sorting.c */
93
94	amb	311	/+ The type and size of variable to store the variable length +/
95			#define FILESORT_VARINT unsigned short
96			#define FILESORT_VARSIZE sizeof(FILESORT_VARINT)
97	amb	310
98	amb	311	void filesort_fixed(int fd_in,int fd_out,size_t itemsize,int (compare)(const void,const void),int (buildindex)(void*,index_t));
99	amb	310
100	amb	311	void filesort_vary(int fd_in,int fd_out,int (compare)(const void,const void),int (buildindex)(void*,index_t));
101
102	amb	270	void heapsort(void *datap,size_t nitems,int(compare)(const void, const void));
103
104
105	amb	2	#endif /* FUNCTIONS_H */