pgLatLon

annotate latlon-v0004.c @ 17:c790cf162e04

Corrected comment
author jbe
date Fri Sep 09 19:45:03 2016 +0200 (2016-09-09)
parents e319679cefbd
children
rev   line source
jbe@0 1
jbe@0 2 /*-------------*
jbe@0 3 * C prelude *
jbe@0 4 *-------------*/
jbe@0 5
jbe@0 6 #include "postgres.h"
jbe@0 7 #include "fmgr.h"
jbe@0 8 #include "libpq/pqformat.h"
jbe@0 9 #include "access/gist.h"
jbe@0 10 #include "access/stratnum.h"
jbe@0 11 #include "utils/array.h"
jbe@0 12 #include <math.h>
jbe@0 13
jbe@0 14 #ifdef PG_MODULE_MAGIC
jbe@0 15 PG_MODULE_MAGIC;
jbe@0 16 #endif
jbe@0 17
jbe@0 18 #if INT_MAX < 2147483647
jbe@0 19 #error Expected int type to be at least 32 bit wide
jbe@0 20 #endif
jbe@0 21
jbe@0 22
jbe@0 23 /*---------------------------------*
jbe@0 24 * distance calculation on earth *
jbe@0 25 * (using WGS-84 spheroid) *
jbe@0 26 *---------------------------------*/
jbe@0 27
jbe@0 28 /* WGS-84 spheroid with following parameters:
jbe@0 29 semi-major axis a = 6378137
jbe@0 30 semi-minor axis b = a * (1 - 1/298.257223563)
jbe@0 31 estimated diameter = 2 * (2*a+b)/3
jbe@0 32 */
jbe@0 33 #define PGL_SPHEROID_A 6378137.0 /* semi major axis */
jbe@0 34 #define PGL_SPHEROID_F (1.0/298.257223563) /* flattening */
jbe@0 35 #define PGL_SPHEROID_B (PGL_SPHEROID_A * (1.0-PGL_SPHEROID_F))
jbe@0 36 #define PGL_EPS2 ( ( PGL_SPHEROID_A * PGL_SPHEROID_A - \
jbe@0 37 PGL_SPHEROID_B * PGL_SPHEROID_B ) / \
jbe@0 38 ( PGL_SPHEROID_A * PGL_SPHEROID_A ) )
jbe@0 39 #define PGL_SUBEPS2 (1.0-PGL_EPS2)
jbe@0 40 #define PGL_DIAMETER ((4.0*PGL_SPHEROID_A + 2.0*PGL_SPHEROID_B) / 3.0)
jbe@0 41 #define PGL_SCALE (PGL_SPHEROID_A / PGL_DIAMETER) /* semi-major ref. */
jbe@0 42 #define PGL_FADELIMIT (PGL_DIAMETER * M_PI / 6.0) /* 1/6 circumference */
jbe@0 43 #define PGL_MAXDIST (PGL_DIAMETER * M_PI / 2.0) /* maximum distance */
jbe@0 44
jbe@0 45 /* calculate distance between two points on earth (given in degrees) */
jbe@0 46 static inline double pgl_distance(
jbe@0 47 double lat1, double lon1, double lat2, double lon2
jbe@0 48 ) {
jbe@0 49 float8 lat1cos, lat1sin, lat2cos, lat2sin, lon2cos, lon2sin;
jbe@0 50 float8 nphi1, nphi2, x1, z1, x2, y2, z2, g, s, t;
jbe@0 51 /* normalize delta longitude (lon2 > 0 && lon1 = 0) */
jbe@0 52 /* lon1 = 0 (not used anymore) */
jbe@0 53 lon2 = fabs(lon2-lon1);
jbe@0 54 /* convert to radians (first divide, then multiply) */
jbe@0 55 lat1 = (lat1 / 180.0) * M_PI;
jbe@0 56 lat2 = (lat2 / 180.0) * M_PI;
jbe@0 57 lon2 = (lon2 / 180.0) * M_PI;
jbe@0 58 /* make lat2 >= lat1 to ensure reversal-symmetry despite floating point
jbe@0 59 operations (lon2 >= lon1 is already ensured in a previous step) */
jbe@0 60 if (lat2 < lat1) { float8 swap = lat1; lat1 = lat2; lat2 = swap; }
jbe@0 61 /* calculate 3d coordinates on scaled ellipsoid which has an average diameter
jbe@0 62 of 1.0 */
jbe@0 63 lat1cos = cos(lat1); lat1sin = sin(lat1);
jbe@0 64 lat2cos = cos(lat2); lat2sin = sin(lat2);
jbe@0 65 lon2cos = cos(lon2); lon2sin = sin(lon2);
jbe@0 66 nphi1 = PGL_SCALE / sqrt(1 - PGL_EPS2 * lat1sin * lat1sin);
jbe@0 67 nphi2 = PGL_SCALE / sqrt(1 - PGL_EPS2 * lat2sin * lat2sin);
jbe@0 68 x1 = nphi1 * lat1cos;
jbe@0 69 z1 = nphi1 * PGL_SUBEPS2 * lat1sin;
jbe@0 70 x2 = nphi2 * lat2cos * lon2cos;
jbe@0 71 y2 = nphi2 * lat2cos * lon2sin;
jbe@0 72 z2 = nphi2 * PGL_SUBEPS2 * lat2sin;
jbe@0 73 /* calculate tunnel distance through scaled (diameter 1.0) ellipsoid */
jbe@0 74 g = sqrt((x2-x1)*(x2-x1) + y2*y2 + (z2-z1)*(z2-z1));
jbe@0 75 /* convert tunnel distance through scaled ellipsoid to approximated surface
jbe@0 76 distance on original ellipsoid */
jbe@0 77 if (g > 1.0) g = 1.0;
jbe@0 78 s = PGL_DIAMETER * asin(g);
jbe@0 79 /* return result only if small enough to be precise (less than 1/3 of
jbe@0 80 maximum possible distance) */
jbe@0 81 if (s <= PGL_FADELIMIT) return s;
jbe@0 82 /* calculate tunnel distance to antipodal point through scaled ellipsoid */
jbe@3 83 g = sqrt((x2+x1)*(x2+x1) + y2*y2 + (z2+z1)*(z2+z1));
jbe@0 84 /* convert tunnel distance to antipodal point through scaled ellipsoid to
jbe@0 85 approximated surface distance to antipodal point on original ellipsoid */
jbe@0 86 if (g > 1.0) g = 1.0;
jbe@0 87 t = PGL_DIAMETER * asin(g);
jbe@0 88 /* surface distance between original points can now be approximated by
jbe@0 89 substracting antipodal distance from maximum possible distance;
jbe@0 90 return result only if small enough (less than 1/3 of maximum possible
jbe@0 91 distance) */
jbe@0 92 if (t <= PGL_FADELIMIT) return PGL_MAXDIST-t;
jbe@0 93 /* otherwise crossfade direct and antipodal result to ensure monotonicity */
jbe@0 94 return (
jbe@0 95 (s * (t-PGL_FADELIMIT) + (PGL_MAXDIST-t) * (s-PGL_FADELIMIT)) /
jbe@0 96 (s + t - 2*PGL_FADELIMIT)
jbe@0 97 );
jbe@0 98 }
jbe@0 99
jbe@0 100 /* finite distance that can not be reached on earth */
jbe@0 101 #define PGL_ULTRA_DISTANCE (3 * PGL_MAXDIST)
jbe@0 102
jbe@0 103
jbe@0 104 /*--------------------------------*
jbe@0 105 * simple geographic data types *
jbe@0 106 *--------------------------------*/
jbe@0 107
jbe@0 108 /* point on earth given by latitude and longitude in degrees */
jbe@0 109 /* (type "epoint" in SQL) */
jbe@0 110 typedef struct {
jbe@0 111 double lat; /* between -90 and 90 (both inclusive) */
jbe@0 112 double lon; /* between -180 and 180 (both inclusive) */
jbe@0 113 } pgl_point;
jbe@0 114
jbe@0 115 /* box delimited by two parallels and two meridians (all in degrees) */
jbe@0 116 /* (type "ebox" in SQL) */
jbe@0 117 typedef struct {
jbe@0 118 double lat_min; /* between -90 and 90 (both inclusive) */
jbe@0 119 double lat_max; /* between -90 and 90 (both inclusive) */
jbe@0 120 double lon_min; /* between -180 and 180 (both inclusive) */
jbe@0 121 double lon_max; /* between -180 and 180 (both inclusive) */
jbe@0 122 /* if lat_min > lat_max, then box is empty */
jbe@0 123 /* if lon_min > lon_max, then 180th meridian is crossed */
jbe@0 124 } pgl_box;
jbe@0 125
jbe@0 126 /* circle on earth surface (for radial searches with fixed radius) */
jbe@0 127 /* (type "ecircle" in SQL) */
jbe@0 128 typedef struct {
jbe@0 129 pgl_point center;
jbe@0 130 double radius; /* positive (including +0 but excluding -0), or -INFINITY */
jbe@0 131 /* A negative radius (i.e. -INFINITY) denotes nothing (i.e. no point),
jbe@0 132 zero radius (0) denotes a single point,
jbe@0 133 a finite radius (0 < radius < INFINITY) denotes a filled circle, and
jbe@0 134 a radius of INFINITY is valid and means complete coverage of earth. */
jbe@0 135 } pgl_circle;
jbe@0 136
jbe@0 137
jbe@0 138 /*----------------------------------*
jbe@0 139 * geographic "cluster" data type *
jbe@0 140 *----------------------------------*/
jbe@0 141
jbe@0 142 /* A cluster is a collection of points, paths, outlines, and polygons. If two
jbe@0 143 polygons in a cluster overlap, the area covered by both polygons does not
jbe@0 144 belong to the cluster. This way, a cluster can be used to describe complex
jbe@0 145 shapes like polygons with holes. Outlines are non-filled polygons. Paths are
jbe@0 146 open by default (i.e. the last point in the list is not connected with the
jbe@0 147 first point in the list). Note that each outline or polygon in a cluster
jbe@0 148 must cover a longitude range of less than 180 degrees to avoid ambiguities.
jbe@0 149 Areas which are larger may be split into multiple polygons. */
jbe@0 150
jbe@0 151 /* maximum number of points in a cluster */
jbe@0 152 /* (limited to avoid integer overflows, e.g. when allocating memory) */
jbe@0 153 #define PGL_CLUSTER_MAXPOINTS 16777216
jbe@0 154
jbe@0 155 /* types of cluster entries */
jbe@0 156 #define PGL_ENTRY_POINT 1 /* a point */
jbe@0 157 #define PGL_ENTRY_PATH 2 /* a path from first point to last point */
jbe@0 158 #define PGL_ENTRY_OUTLINE 3 /* a non-filled polygon with given vertices */
jbe@0 159 #define PGL_ENTRY_POLYGON 4 /* a filled polygon with given vertices */
jbe@0 160
jbe@0 161 /* Entries of a cluster are described by two different structs: pgl_newentry
jbe@0 162 and pgl_entry. The first is used only during construction of a cluster, the
jbe@0 163 second is used in all other cases (e.g. when reading clusters from the
jbe@0 164 database, performing operations, etc). */
jbe@0 165
jbe@0 166 /* entry for new geographic cluster during construction of that cluster */
jbe@0 167 typedef struct {
jbe@0 168 int32_t entrytype;
jbe@0 169 int32_t npoints;
jbe@0 170 pgl_point *points; /* pointer to an array of points (pgl_point) */
jbe@0 171 } pgl_newentry;
jbe@0 172
jbe@0 173 /* entry of geographic cluster */
jbe@0 174 typedef struct {
jbe@0 175 int32_t entrytype; /* type of entry: point, path, outline, polygon */
jbe@0 176 int32_t npoints; /* number of stored points (set to 1 for point entry) */
jbe@0 177 int32_t offset; /* offset of pgl_point array from cluster base address */
jbe@0 178 /* use macro PGL_ENTRY_POINTS to obtain a pointer to the array of points */
jbe@0 179 } pgl_entry;
jbe@0 180
jbe@0 181 /* geographic cluster which is a collection of points, (open) paths, polygons,
jbe@0 182 and outlines (non-filled polygons) */
jbe@0 183 typedef struct {
jbe@0 184 char header[VARHDRSZ]; /* PostgreSQL header for variable size data types */
jbe@0 185 int32_t nentries; /* number of stored points */
jbe@0 186 pgl_circle bounding; /* bounding circle */
jbe@0 187 /* Note: bounding circle ensures alignment of pgl_cluster for points */
jbe@0 188 pgl_entry entries[FLEXIBLE_ARRAY_MEMBER]; /* var-length data */
jbe@0 189 } pgl_cluster;
jbe@0 190
jbe@0 191 /* macro to determine memory alignment of points */
jbe@0 192 /* (needed to store pgl_point array after entries in pgl_cluster) */
jbe@0 193 typedef struct { char dummy; pgl_point aligned; } pgl_point_alignment;
jbe@0 194 #define PGL_POINT_ALIGNMENT offsetof(pgl_point_alignment, aligned)
jbe@0 195
jbe@0 196 /* macro to extract a pointer to the array of points of a cluster entry */
jbe@0 197 #define PGL_ENTRY_POINTS(cluster, idx) \
jbe@0 198 ((pgl_point *)(((intptr_t)cluster)+(cluster)->entries[idx].offset))
jbe@0 199
jbe@0 200 /* convert pgl_newentry array to pgl_cluster */
jbe@0 201 static pgl_cluster *pgl_new_cluster(int nentries, pgl_newentry *entries) {
jbe@0 202 int i; /* index of current entry */
jbe@0 203 int npoints = 0; /* number of points in whole cluster */
jbe@0 204 int entry_npoints; /* number of points in current entry */
jbe@0 205 int points_offset = PGL_POINT_ALIGNMENT * (
jbe@0 206 ( offsetof(pgl_cluster, entries) +
jbe@0 207 nentries * sizeof(pgl_entry) +
jbe@0 208 PGL_POINT_ALIGNMENT - 1
jbe@0 209 ) / PGL_POINT_ALIGNMENT
jbe@0 210 ); /* offset of pgl_point array from base address (considering alignment) */
jbe@0 211 pgl_cluster *cluster; /* new cluster to be returned */
jbe@0 212 /* determine total number of points */
jbe@0 213 for (i=0; i<nentries; i++) npoints += entries[i].npoints;
jbe@0 214 /* allocate memory for cluster (including entries and points) */
jbe@0 215 cluster = palloc(points_offset + npoints * sizeof(pgl_point));
jbe@0 216 /* re-count total number of points to determine offset for each entry */
jbe@0 217 npoints = 0;
jbe@0 218 /* copy entries and points */
jbe@0 219 for (i=0; i<nentries; i++) {
jbe@0 220 /* determine number of points in entry */
jbe@0 221 entry_npoints = entries[i].npoints;
jbe@0 222 /* copy entry */
jbe@0 223 cluster->entries[i].entrytype = entries[i].entrytype;
jbe@0 224 cluster->entries[i].npoints = entry_npoints;
jbe@0 225 /* calculate offset (in bytes) of pgl_point array */
jbe@0 226 cluster->entries[i].offset = points_offset + npoints * sizeof(pgl_point);
jbe@0 227 /* copy points */
jbe@0 228 memcpy(
jbe@0 229 PGL_ENTRY_POINTS(cluster, i),
jbe@0 230 entries[i].points,
jbe@0 231 entry_npoints * sizeof(pgl_point)
jbe@0 232 );
jbe@0 233 /* update total number of points processed */
jbe@0 234 npoints += entry_npoints;
jbe@0 235 }
jbe@0 236 /* set number of entries in cluster */
jbe@0 237 cluster->nentries = nentries;
jbe@0 238 /* set PostgreSQL header for variable sized data */
jbe@0 239 SET_VARSIZE(cluster, points_offset + npoints * sizeof(pgl_point));
jbe@0 240 /* return newly created cluster */
jbe@0 241 return cluster;
jbe@0 242 }
jbe@0 243
jbe@0 244
jbe@0 245 /*----------------------------------------*
jbe@0 246 * C functions on geographic data types *
jbe@0 247 *----------------------------------------*/
jbe@0 248
jbe@0 249 /* round latitude or longitude to 12 digits after decimal point */
jbe@0 250 static inline double pgl_round(double val) {
jbe@0 251 return round(val * 1e12) / 1e12;
jbe@0 252 }
jbe@0 253
jbe@0 254 /* compare two points */
jbe@0 255 /* (equality when same point on earth is described, otherwise an arbitrary
jbe@0 256 linear order) */
jbe@0 257 static int pgl_point_cmp(pgl_point *point1, pgl_point *point2) {
jbe@0 258 double lon1, lon2; /* modified longitudes for special cases */
jbe@0 259 /* use latitude as first ordering criterion */
jbe@0 260 if (point1->lat < point2->lat) return -1;
jbe@0 261 if (point1->lat > point2->lat) return 1;
jbe@0 262 /* determine modified longitudes (considering special case of poles and
jbe@0 263 180th meridian which can be described as W180 or E180) */
jbe@0 264 if (point1->lat == -90 || point1->lat == 90) lon1 = 0;
jbe@0 265 else if (point1->lon == 180) lon1 = -180;
jbe@0 266 else lon1 = point1->lon;
jbe@0 267 if (point2->lat == -90 || point2->lat == 90) lon2 = 0;
jbe@0 268 else if (point2->lon == 180) lon2 = -180;
jbe@0 269 else lon2 = point2->lon;
jbe@0 270 /* use (modified) longitude as secondary ordering criterion */
jbe@0 271 if (lon1 < lon2) return -1;
jbe@0 272 if (lon1 > lon2) return 1;
jbe@0 273 /* no difference found, points are equal */
jbe@0 274 return 0;
jbe@0 275 }
jbe@0 276
jbe@0 277 /* compare two boxes */
jbe@0 278 /* (equality when same box on earth is described, otherwise an arbitrary linear
jbe@0 279 order) */
jbe@0 280 static int pgl_box_cmp(pgl_box *box1, pgl_box *box2) {
jbe@0 281 /* two empty boxes are equal, and an empty box is always considered "less
jbe@0 282 than" a non-empty box */
jbe@0 283 if (box1->lat_min> box1->lat_max && box2->lat_min<=box2->lat_max) return -1;
jbe@0 284 if (box1->lat_min> box1->lat_max && box2->lat_min> box2->lat_max) return 0;
jbe@0 285 if (box1->lat_min<=box1->lat_max && box2->lat_min> box2->lat_max) return 1;
jbe@0 286 /* use southern border as first ordering criterion */
jbe@0 287 if (box1->lat_min < box2->lat_min) return -1;
jbe@0 288 if (box1->lat_min > box2->lat_min) return 1;
jbe@0 289 /* use northern border as second ordering criterion */
jbe@0 290 if (box1->lat_max < box2->lat_max) return -1;
jbe@0 291 if (box1->lat_max > box2->lat_max) return 1;
jbe@0 292 /* use western border as third ordering criterion */
jbe@0 293 if (box1->lon_min < box2->lon_min) return -1;
jbe@0 294 if (box1->lon_min > box2->lon_min) return 1;
jbe@0 295 /* use eastern border as fourth ordering criterion */
jbe@0 296 if (box1->lon_max < box2->lon_max) return -1;
jbe@0 297 if (box1->lon_max > box2->lon_max) return 1;
jbe@0 298 /* no difference found, boxes are equal */
jbe@0 299 return 0;
jbe@0 300 }
jbe@0 301
jbe@0 302 /* compare two circles */
jbe@0 303 /* (equality when same circle on earth is described, otherwise an arbitrary
jbe@0 304 linear order) */
jbe@0 305 static int pgl_circle_cmp(pgl_circle *circle1, pgl_circle *circle2) {
jbe@0 306 /* two circles with same infinite radius (positive or negative infinity) are
jbe@0 307 considered equal independently of center point */
jbe@0 308 if (
jbe@0 309 !isfinite(circle1->radius) && !isfinite(circle2->radius) &&
jbe@0 310 circle1->radius == circle2->radius
jbe@0 311 ) return 0;
jbe@0 312 /* use radius as first ordering criterion */
jbe@0 313 if (circle1->radius < circle2->radius) return -1;
jbe@0 314 if (circle1->radius > circle2->radius) return 1;
jbe@0 315 /* use center point as secondary ordering criterion */
jbe@0 316 return pgl_point_cmp(&(circle1->center), &(circle2->center));
jbe@0 317 }
jbe@0 318
jbe@0 319 /* set box to empty box*/
jbe@0 320 static void pgl_box_set_empty(pgl_box *box) {
jbe@0 321 box->lat_min = INFINITY;
jbe@0 322 box->lat_max = -INFINITY;
jbe@0 323 box->lon_min = 0;
jbe@0 324 box->lon_max = 0;
jbe@0 325 }
jbe@0 326
jbe@0 327 /* check if point is inside a box */
jbe@0 328 static bool pgl_point_in_box(pgl_point *point, pgl_box *box) {
jbe@0 329 return (
jbe@0 330 point->lat >= box->lat_min && point->lat <= box->lat_max && (
jbe@0 331 (box->lon_min > box->lon_max) ? (
jbe@0 332 /* box crosses 180th meridian */
jbe@0 333 point->lon >= box->lon_min || point->lon <= box->lon_max
jbe@0 334 ) : (
jbe@0 335 /* box does not cross the 180th meridian */
jbe@0 336 point->lon >= box->lon_min && point->lon <= box->lon_max
jbe@0 337 )
jbe@0 338 )
jbe@0 339 );
jbe@0 340 }
jbe@0 341
jbe@0 342 /* check if two boxes overlap */
jbe@0 343 static bool pgl_boxes_overlap(pgl_box *box1, pgl_box *box2) {
jbe@0 344 return (
jbe@0 345 box2->lat_max >= box2->lat_min && /* ensure box2 is not empty */
jbe@0 346 ( box2->lat_min >= box1->lat_min || box2->lat_max >= box1->lat_min ) &&
jbe@0 347 ( box2->lat_min <= box1->lat_max || box2->lat_max <= box1->lat_max ) && (
jbe@0 348 (
jbe@0 349 /* check if one and only one box crosses the 180th meridian */
jbe@0 350 ((box1->lon_min > box1->lon_max) ? 1 : 0) ^
jbe@0 351 ((box2->lon_min > box2->lon_max) ? 1 : 0)
jbe@0 352 ) ? (
jbe@0 353 /* exactly one box crosses the 180th meridian */
jbe@0 354 box2->lon_min >= box1->lon_min || box2->lon_max >= box1->lon_min ||
jbe@0 355 box2->lon_min <= box1->lon_max || box2->lon_max <= box1->lon_max
jbe@0 356 ) : (
jbe@0 357 /* no box or both boxes cross the 180th meridian */
jbe@0 358 (
jbe@0 359 (box2->lon_min >= box1->lon_min || box2->lon_max >= box1->lon_min) &&
jbe@0 360 (box2->lon_min <= box1->lon_max || box2->lon_max <= box1->lon_max)
jbe@0 361 ) ||
jbe@0 362 /* handle W180 == E180 */
jbe@0 363 ( box1->lon_min == -180 && box2->lon_max == 180 ) ||
jbe@0 364 ( box2->lon_min == -180 && box1->lon_max == 180 )
jbe@0 365 )
jbe@0 366 )
jbe@0 367 );
jbe@0 368 }
jbe@0 369
jbe@0 370 /* check unambiguousness of east/west orientation of cluster entries and set
jbe@0 371 bounding circle of cluster */
jbe@0 372 static bool pgl_finalize_cluster(pgl_cluster *cluster) {
jbe@0 373 int i, j; /* i: index of entry, j: index of point in entry */
jbe@0 374 int npoints; /* number of points in entry */
jbe@0 375 int total_npoints = 0; /* total number of points in cluster */
jbe@0 376 pgl_point *points; /* points in entry */
jbe@0 377 int lon_dir; /* first point of entry west (-1) or east (+1) */
jbe@0 378 double lon_break = 0; /* antipodal longitude of first point in entry */
jbe@0 379 double lon_min, lon_max; /* covered longitude range of entry */
jbe@0 380 double value; /* temporary variable */
jbe@0 381 /* reset bounding circle center to empty circle at 0/0 coordinates */
jbe@0 382 cluster->bounding.center.lat = 0;
jbe@0 383 cluster->bounding.center.lon = 0;
jbe@0 384 cluster->bounding.radius = -INFINITY;
jbe@0 385 /* if cluster is not empty */
jbe@0 386 if (cluster->nentries != 0) {
jbe@0 387 /* iterate over all cluster entries and ensure they each cover a longitude
jbe@0 388 range less than 180 degrees */
jbe@0 389 for (i=0; i<cluster->nentries; i++) {
jbe@0 390 /* get properties of entry */
jbe@0 391 npoints = cluster->entries[i].npoints;
jbe@0 392 points = PGL_ENTRY_POINTS(cluster, i);
jbe@0 393 /* get longitude of first point of entry */
jbe@0 394 value = points[0].lon;
jbe@0 395 /* initialize lon_min and lon_max with longitude of first point */
jbe@0 396 lon_min = value;
jbe@0 397 lon_max = value;
jbe@0 398 /* determine east/west orientation of first point and calculate antipodal
jbe@0 399 longitude (Note: rounding required here) */
jbe@0 400 if (value < 0) { lon_dir = -1; lon_break = pgl_round(value + 180); }
jbe@0 401 else if (value > 0) { lon_dir = 1; lon_break = pgl_round(value - 180); }
jbe@0 402 else lon_dir = 0;
jbe@0 403 /* iterate over all other points in entry */
jbe@0 404 for (j=1; j<npoints; j++) {
jbe@0 405 /* consider longitude wrap-around */
jbe@0 406 value = points[j].lon;
jbe@0 407 if (lon_dir<0 && value>lon_break) value = pgl_round(value - 360);
jbe@0 408 else if (lon_dir>0 && value<lon_break) value = pgl_round(value + 360);
jbe@0 409 /* update lon_min and lon_max */
jbe@0 410 if (value < lon_min) lon_min = value;
jbe@0 411 else if (value > lon_max) lon_max = value;
jbe@0 412 /* return false if 180 degrees or more are covered */
jbe@0 413 if (lon_max - lon_min >= 180) return false;
jbe@0 414 }
jbe@0 415 }
jbe@0 416 /* iterate over all points of all entries and calculate arbitrary center
jbe@0 417 point for bounding circle (best if center point minimizes the radius,
jbe@0 418 but some error is allowed here) */
jbe@0 419 for (i=0; i<cluster->nentries; i++) {
jbe@0 420 /* get properties of entry */
jbe@0 421 npoints = cluster->entries[i].npoints;
jbe@0 422 points = PGL_ENTRY_POINTS(cluster, i);
jbe@0 423 /* check if first entry */
jbe@0 424 if (i==0) {
jbe@0 425 /* get longitude of first point of first entry in whole cluster */
jbe@0 426 value = points[0].lon;
jbe@0 427 /* initialize lon_min and lon_max with longitude of first point of
jbe@0 428 first entry in whole cluster (used to determine if whole cluster
jbe@0 429 covers a longitude range of 180 degrees or more) */
jbe@0 430 lon_min = value;
jbe@0 431 lon_max = value;
jbe@0 432 /* determine east/west orientation of first point and calculate
jbe@0 433 antipodal longitude (Note: rounding not necessary here) */
jbe@0 434 if (value < 0) { lon_dir = -1; lon_break = value + 180; }
jbe@0 435 else if (value > 0) { lon_dir = 1; lon_break = value - 180; }
jbe@0 436 else lon_dir = 0;
jbe@0 437 }
jbe@0 438 /* iterate over all points in entry */
jbe@0 439 for (j=0; j<npoints; j++) {
jbe@0 440 /* longitude wrap-around (Note: rounding not necessary here) */
jbe@0 441 value = points[j].lon;
jbe@0 442 if (lon_dir < 0 && value > lon_break) value -= 360;
jbe@0 443 else if (lon_dir > 0 && value < lon_break) value += 360;
jbe@0 444 if (value < lon_min) lon_min = value;
jbe@0 445 else if (value > lon_max) lon_max = value;
jbe@0 446 /* set bounding circle to cover whole earth if more than 180 degrees
jbe@0 447 are covered */
jbe@0 448 if (lon_max - lon_min >= 180) {
jbe@0 449 cluster->bounding.center.lat = 0;
jbe@0 450 cluster->bounding.center.lon = 0;
jbe@0 451 cluster->bounding.radius = INFINITY;
jbe@0 452 return true;
jbe@0 453 }
jbe@0 454 /* add point to bounding circle center (for average calculation) */
jbe@0 455 cluster->bounding.center.lat += points[j].lat;
jbe@0 456 cluster->bounding.center.lon += value;
jbe@0 457 }
jbe@0 458 /* count total number of points */
jbe@0 459 total_npoints += npoints;
jbe@0 460 }
jbe@0 461 /* determine average latitude and longitude of cluster */
jbe@0 462 cluster->bounding.center.lat /= total_npoints;
jbe@0 463 cluster->bounding.center.lon /= total_npoints;
jbe@0 464 /* normalize longitude of center of cluster bounding circle */
jbe@0 465 if (cluster->bounding.center.lon < -180) {
jbe@0 466 cluster->bounding.center.lon += 360;
jbe@0 467 }
jbe@0 468 else if (cluster->bounding.center.lon > 180) {
jbe@0 469 cluster->bounding.center.lon -= 360;
jbe@0 470 }
jbe@0 471 /* round bounding circle center (useful if it is used by other functions) */
jbe@0 472 cluster->bounding.center.lat = pgl_round(cluster->bounding.center.lat);
jbe@0 473 cluster->bounding.center.lon = pgl_round(cluster->bounding.center.lon);
jbe@0 474 /* calculate radius of bounding circle */
jbe@0 475 for (i=0; i<cluster->nentries; i++) {
jbe@0 476 npoints = cluster->entries[i].npoints;
jbe@0 477 points = PGL_ENTRY_POINTS(cluster, i);
jbe@0 478 for (j=0; j<npoints; j++) {
jbe@0 479 value = pgl_distance(
jbe@0 480 cluster->bounding.center.lat, cluster->bounding.center.lon,
jbe@0 481 points[j].lat, points[j].lon
jbe@0 482 );
jbe@0 483 if (value > cluster->bounding.radius) cluster->bounding.radius = value;
jbe@0 484 }
jbe@0 485 }
jbe@0 486 }
jbe@0 487 /* return true (east/west orientation is unambiguous) */
jbe@0 488 return true;
jbe@0 489 }
jbe@0 490
jbe@0 491 /* check if point is inside cluster */
jbe@0 492 static bool pgl_point_in_cluster(pgl_point *point, pgl_cluster *cluster) {
jbe@0 493 int i, j, k; /* i: entry, j: point in entry, k: next point in entry */
jbe@0 494 int entrytype; /* type of entry */
jbe@0 495 int npoints; /* number of points in entry */
jbe@0 496 pgl_point *points; /* array of points in entry */
jbe@0 497 int lon_dir = 0; /* first vertex west (-1) or east (+1) */
jbe@0 498 double lon_break = 0; /* antipodal longitude of first vertex */
jbe@0 499 double lat0 = point->lat; /* latitude of point */
jbe@0 500 double lon0; /* (adjusted) longitude of point */
jbe@0 501 double lat1, lon1; /* latitude and (adjusted) longitude of vertex */
jbe@0 502 double lat2, lon2; /* latitude and (adjusted) longitude of next vertex */
jbe@0 503 double lon; /* longitude of intersection */
jbe@0 504 int counter = 0; /* counter for intersections east of point */
jbe@0 505 /* iterate over all entries */
jbe@0 506 for (i=0; i<cluster->nentries; i++) {
jbe@0 507 /* get properties of entry */
jbe@0 508 entrytype = cluster->entries[i].entrytype;
jbe@0 509 npoints = cluster->entries[i].npoints;
jbe@0 510 points = PGL_ENTRY_POINTS(cluster, i);
jbe@0 511 /* determine east/west orientation of first point of entry and calculate
jbe@0 512 antipodal longitude */
jbe@0 513 lon_break = points[0].lon;
jbe@0 514 if (lon_break < 0) { lon_dir = -1; lon_break += 180; }
jbe@0 515 else if (lon_break > 0) { lon_dir = 1; lon_break -= 180; }
jbe@0 516 else lon_dir = 0;
jbe@0 517 /* get longitude of point */
jbe@0 518 lon0 = point->lon;
jbe@0 519 /* consider longitude wrap-around for point */
jbe@0 520 if (lon_dir < 0 && lon0 > lon_break) lon0 = pgl_round(lon0 - 360);
jbe@0 521 else if (lon_dir > 0 && lon0 < lon_break) lon0 = pgl_round(lon0 + 360);
jbe@0 522 /* iterate over all edges and vertices */
jbe@0 523 for (j=0; j<npoints; j++) {
jbe@0 524 /* return true if point is on vertex of polygon */
jbe@0 525 if (pgl_point_cmp(point, &(points[j])) == 0) return true;
jbe@0 526 /* calculate index of next vertex */
jbe@0 527 k = (j+1) % npoints;
jbe@0 528 /* skip last edge unless entry is (closed) outline or polygon */
jbe@0 529 if (
jbe@0 530 k == 0 &&
jbe@0 531 entrytype != PGL_ENTRY_OUTLINE &&
jbe@0 532 entrytype != PGL_ENTRY_POLYGON
jbe@0 533 ) continue;
jbe@16 534 /* use previously calculated values for lat1 and lon1 if possible */
jbe@16 535 if (j) {
jbe@16 536 lat1 = lat2;
jbe@16 537 lon1 = lon2;
jbe@16 538 } else {
jbe@16 539 /* otherwise get latitude and longitude values of first vertex */
jbe@16 540 lat1 = points[0].lat;
jbe@16 541 lon1 = points[0].lon;
jbe@16 542 /* and consider longitude wrap-around for first vertex */
jbe@16 543 if (lon_dir < 0 && lon1 > lon_break) lon1 = pgl_round(lon1 - 360);
jbe@16 544 else if (lon_dir > 0 && lon1 < lon_break) lon1 = pgl_round(lon1 + 360);
jbe@16 545 }
jbe@16 546 /* get latitude and longitude of next vertex */
jbe@0 547 lat2 = points[k].lat;
jbe@0 548 lon2 = points[k].lon;
jbe@16 549 /* consider longitude wrap-around for next vertex */
jbe@0 550 if (lon_dir < 0 && lon2 > lon_break) lon2 = pgl_round(lon2 - 360);
jbe@0 551 else if (lon_dir > 0 && lon2 < lon_break) lon2 = pgl_round(lon2 + 360);
jbe@0 552 /* return true if point is on horizontal (west to east) edge of polygon */
jbe@0 553 if (
jbe@0 554 lat0 == lat1 && lat0 == lat2 &&
jbe@0 555 ( (lon0 >= lon1 && lon0 <= lon2) || (lon0 >= lon2 && lon0 <= lon1) )
jbe@0 556 ) return true;
jbe@0 557 /* check if edge crosses east/west line of point */
jbe@0 558 if ((lat1 < lat0 && lat2 >= lat0) || (lat2 < lat0 && lat1 >= lat0)) {
jbe@0 559 /* calculate longitude of intersection */
jbe@0 560 lon = (lon1 * (lat2-lat0) + lon2 * (lat0-lat1)) / (lat2-lat1);
jbe@0 561 /* return true if intersection goes (approximately) through point */
jbe@0 562 if (pgl_round(lon) == lon0) return true;
jbe@0 563 /* count intersection if east of point and entry is polygon*/
jbe@0 564 if (entrytype == PGL_ENTRY_POLYGON && lon > lon0) counter++;
jbe@0 565 }
jbe@0 566 }
jbe@0 567 }
jbe@0 568 /* return true if number of intersections is odd */
jbe@0 569 return counter & 1;
jbe@0 570 }
jbe@0 571
jbe@16 572 /* check if all points of the second cluster are inside the first cluster */
jbe@16 573 static inline bool pgl_all_cluster_points_in_cluster(
jbe@16 574 pgl_cluster *outer, pgl_cluster *inner
jbe@16 575 ) {
jbe@16 576 int i, j; /* i: entry, j: point in entry */
jbe@16 577 int npoints; /* number of points in entry */
jbe@16 578 pgl_point *points; /* array of points in entry */
jbe@16 579 /* iterate over all entries of "inner" cluster */
jbe@16 580 for (i=0; i<inner->nentries; i++) {
jbe@16 581 /* get properties of entry */
jbe@16 582 npoints = inner->entries[i].npoints;
jbe@16 583 points = PGL_ENTRY_POINTS(inner, i);
jbe@16 584 /* iterate over all points in entry of "inner" cluster */
jbe@16 585 for (j=0; j<npoints; j++) {
jbe@16 586 /* return false if one point of inner cluster is not in outer cluster */
jbe@16 587 if (!pgl_point_in_cluster(points+j, outer)) return false;
jbe@16 588 }
jbe@16 589 }
jbe@16 590 /* otherwise return true */
jbe@16 591 return true;
jbe@16 592 }
jbe@16 593
jbe@16 594 /* check if any point the second cluster is inside the first cluster */
jbe@16 595 static inline bool pgl_any_cluster_points_in_cluster(
jbe@16 596 pgl_cluster *outer, pgl_cluster *inner
jbe@16 597 ) {
jbe@16 598 int i, j; /* i: entry, j: point in entry */
jbe@16 599 int npoints; /* number of points in entry */
jbe@16 600 pgl_point *points; /* array of points in entry */
jbe@16 601 /* iterate over all entries of "inner" cluster */
jbe@16 602 for (i=0; i<inner->nentries; i++) {
jbe@16 603 /* get properties of entry */
jbe@16 604 npoints = inner->entries[i].npoints;
jbe@16 605 points = PGL_ENTRY_POINTS(inner, i);
jbe@16 606 /* iterate over all points in entry of "inner" cluster */
jbe@16 607 for (j=0; j<npoints; j++) {
jbe@16 608 /* return true if one point of inner cluster is in outer cluster */
jbe@16 609 if (pgl_point_in_cluster(points+j, outer)) return true;
jbe@16 610 }
jbe@16 611 }
jbe@16 612 /* otherwise return false */
jbe@16 613 return false;
jbe@16 614 }
jbe@16 615
jbe@16 616 /* check if line segment crosses line */
jbe@16 617 /* returns -1 if yes, 1 if no, and 0 in corner cases */
jbe@16 618 /* NOTE: each line (segment) must have a length greater than zero */
jbe@16 619 static inline double pgl_lseg_crosses_line(
jbe@16 620 double seg_x1, double seg_y1, double seg_x2, double seg_y2,
jbe@16 621 double line_x1, double line_y1, double line_x2, double line_y2,
jbe@16 622 bool strict
jbe@16 623 ) {
jbe@16 624 double value = (
jbe@16 625 (seg_x1-line_x1) * (line_y2-line_y1) -
jbe@16 626 (seg_y1-line_y1) * (line_x2-line_x1)
jbe@16 627 ) * (
jbe@16 628 (seg_x2-line_x1) * (line_y2-line_y1) -
jbe@16 629 (seg_y2-line_y1) * (line_x2-line_x1)
jbe@16 630 );
jbe@16 631 if (strict) return value < 0;
jbe@16 632 else return value <= 0;
jbe@16 633 }
jbe@16 634
jbe@16 635 /* check if paths and outlines of two clusters overlap */
jbe@16 636 /* (set strict to true to disregard corner cases) */
jbe@16 637 static bool pgl_outlines_overlap(
jbe@16 638 pgl_cluster *cluster1, pgl_cluster *cluster2, bool strict
jbe@16 639 ) {
jbe@16 640 int i1, j1, k1; /* i: entry, j: point in entry, k: next point in entry */
jbe@16 641 int i2, j2, k2;
jbe@16 642 int entrytype1, entrytype2; /* type of entry */
jbe@16 643 int npoints1, npoints2; /* number of points in entry */
jbe@16 644 pgl_point *points1; /* array of points in entry of cluster1 */
jbe@16 645 pgl_point *points2; /* array of points in entry of cluster2 */
jbe@16 646 int lon_dir1, lon_dir2; /* first vertex west (-1) or east (+1) */
jbe@16 647 double lon_break1, lon_break2; /* antipodal longitude of first vertex */
jbe@16 648 double lat11, lon11; /* latitude and (adjusted) longitude of vertex */
jbe@16 649 double lat12, lon12; /* latitude and (adjusted) longitude of next vertex */
jbe@16 650 double lat21, lon21; /* latitude and (adjusted) longitudes for cluster2 */
jbe@16 651 double lat22, lon22;
jbe@16 652 double wrapvalue; /* temporary helper value to adjust wrap-around */
jbe@16 653 /* iterate over all entries of cluster1 */
jbe@16 654 for (i1=0; i1<cluster1->nentries; i1++) {
jbe@16 655 /* get properties of entry in cluster1 and skip points */
jbe@16 656 npoints1 = cluster1->entries[i1].npoints;
jbe@16 657 if (npoints1 < 2) continue;
jbe@16 658 entrytype1 = cluster1->entries[i1].entrytype;
jbe@16 659 points1 = PGL_ENTRY_POINTS(cluster1, i1);
jbe@16 660 /* determine east/west orientation of first point and calculate antipodal
jbe@16 661 longitude */
jbe@16 662 lon_break1 = points1[0].lon;
jbe@16 663 if (lon_break1 < 0) {
jbe@16 664 lon_dir1 = -1;
jbe@16 665 lon_break1 = pgl_round(lon_break1 + 180);
jbe@16 666 } else if (lon_break1 > 0) {
jbe@16 667 lon_dir1 = 1;
jbe@16 668 lon_break1 = pgl_round(lon_break1 - 180);
jbe@16 669 } else lon_dir1 = 0;
jbe@16 670 /* iterate over all edges and vertices in cluster1 */
jbe@16 671 for (j1=0; j1<npoints1; j1++) {
jbe@16 672 /* calculate index of next vertex */
jbe@16 673 k1 = (j1+1) % npoints1;
jbe@16 674 /* skip last edge unless entry is (closed) outline or polygon */
jbe@16 675 if (
jbe@16 676 k1 == 0 &&
jbe@16 677 entrytype1 != PGL_ENTRY_OUTLINE &&
jbe@16 678 entrytype1 != PGL_ENTRY_POLYGON
jbe@16 679 ) continue;
jbe@16 680 /* use previously calculated values for lat1 and lon1 if possible */
jbe@16 681 if (j1) {
jbe@16 682 lat11 = lat12;
jbe@16 683 lon11 = lon12;
jbe@16 684 } else {
jbe@16 685 /* otherwise get latitude and longitude values of first vertex */
jbe@16 686 lat11 = points1[0].lat;
jbe@16 687 lon11 = points1[0].lon;
jbe@16 688 /* and consider longitude wrap-around for first vertex */
jbe@16 689 if (lon_dir1<0 && lon11>lon_break1) lon11 = pgl_round(lon11-360);
jbe@16 690 else if (lon_dir1>0 && lon11<lon_break1) lon11 = pgl_round(lon11+360);
jbe@16 691 }
jbe@16 692 /* get latitude and longitude of next vertex */
jbe@16 693 lat12 = points1[k1].lat;
jbe@16 694 lon12 = points1[k1].lon;
jbe@16 695 /* consider longitude wrap-around for next vertex */
jbe@16 696 if (lon_dir1<0 && lon12>lon_break1) lon12 = pgl_round(lon12-360);
jbe@16 697 else if (lon_dir1>0 && lon12<lon_break1) lon12 = pgl_round(lon12+360);
jbe@16 698 /* skip degenerated edges */
jbe@16 699 if (lat11 == lat12 && lon11 == lon12) continue;
jbe@16 700 /* iterate over all entries of cluster2 */
jbe@16 701 for (i2=0; i2<cluster2->nentries; i2++) {
jbe@16 702 /* get points and number of points of entry in cluster2 */
jbe@16 703 npoints2 = cluster2->entries[i2].npoints;
jbe@16 704 if (npoints2 < 2) continue;
jbe@16 705 entrytype2 = cluster2->entries[i2].entrytype;
jbe@16 706 points2 = PGL_ENTRY_POINTS(cluster2, i2);
jbe@16 707 /* determine east/west orientation of first point and calculate antipodal
jbe@16 708 longitude */
jbe@16 709 lon_break2 = points2[0].lon;
jbe@16 710 if (lon_break2 < 0) {
jbe@16 711 lon_dir2 = -1;
jbe@16 712 lon_break2 = pgl_round(lon_break2 + 180);
jbe@16 713 } else if (lon_break2 > 0) {
jbe@16 714 lon_dir2 = 1;
jbe@16 715 lon_break2 = pgl_round(lon_break2 - 180);
jbe@16 716 } else lon_dir2 = 0;
jbe@16 717 /* iterate over all edges and vertices in cluster2 */
jbe@16 718 for (j2=0; j2<npoints2; j2++) {
jbe@16 719 /* calculate index of next vertex */
jbe@16 720 k2 = (j2+1) % npoints2;
jbe@16 721 /* skip last edge unless entry is (closed) outline or polygon */
jbe@16 722 if (
jbe@16 723 k2 == 0 &&
jbe@16 724 entrytype2 != PGL_ENTRY_OUTLINE &&
jbe@16 725 entrytype2 != PGL_ENTRY_POLYGON
jbe@16 726 ) continue;
jbe@16 727 /* use previously calculated values for lat1 and lon1 if possible */
jbe@16 728 if (j2) {
jbe@16 729 lat21 = lat22;
jbe@16 730 lon21 = lon22;
jbe@16 731 } else {
jbe@16 732 /* otherwise get latitude and longitude values of first vertex */
jbe@16 733 lat21 = points2[0].lat;
jbe@16 734 lon21 = points2[0].lon;
jbe@16 735 /* and consider longitude wrap-around for first vertex */
jbe@16 736 if (lon_dir2<0 && lon21>lon_break2) lon21 = pgl_round(lon21-360);
jbe@16 737 else if (lon_dir2>0 && lon21<lon_break2) lon21 = pgl_round(lon21+360);
jbe@16 738 }
jbe@16 739 /* get latitude and longitude of next vertex */
jbe@16 740 lat22 = points2[k2].lat;
jbe@16 741 lon22 = points2[k2].lon;
jbe@16 742 /* consider longitude wrap-around for next vertex */
jbe@16 743 if (lon_dir2<0 && lon22>lon_break2) lon22 = pgl_round(lon22-360);
jbe@16 744 else if (lon_dir2>0 && lon22<lon_break2) lon22 = pgl_round(lon22+360);
jbe@16 745 /* skip degenerated edges */
jbe@16 746 if (lat21 == lat22 && lon21 == lon22) continue;
jbe@16 747 /* perform another wrap-around where necessary */
jbe@16 748 /* TODO: improve performance of whole wrap-around mechanism */
jbe@16 749 wrapvalue = (lon21 + lon22) - (lon11 + lon12);
jbe@16 750 if (wrapvalue > 360) {
jbe@16 751 lon21 = pgl_round(lon21 - 360);
jbe@16 752 lon22 = pgl_round(lon22 - 360);
jbe@16 753 } else if (wrapvalue < -360) {
jbe@16 754 lon21 = pgl_round(lon21 + 360);
jbe@16 755 lon22 = pgl_round(lon22 + 360);
jbe@16 756 }
jbe@16 757 /* return true if segments overlap */
jbe@16 758 if (
jbe@16 759 pgl_lseg_crosses_line(
jbe@16 760 lat11, lon11, lat12, lon12,
jbe@16 761 lat21, lon21, lat22, lon22,
jbe@16 762 strict
jbe@16 763 ) && pgl_lseg_crosses_line(
jbe@16 764 lat21, lon21, lat22, lon22,
jbe@16 765 lat11, lon11, lat12, lon12,
jbe@16 766 strict
jbe@16 767 )
jbe@16 768 ) {
jbe@16 769 return true;
jbe@16 770 }
jbe@16 771 }
jbe@16 772 }
jbe@16 773 }
jbe@16 774 }
jbe@16 775 /* otherwise return false */
jbe@16 776 return false;
jbe@16 777 }
jbe@16 778
jbe@16 779 /* check if second cluster is completely contained in first cluster */
jbe@16 780 static bool pgl_cluster_in_cluster(pgl_cluster *outer, pgl_cluster *inner) {
jbe@16 781 if (!pgl_all_cluster_points_in_cluster(outer, inner)) return false;
jbe@16 782 if (pgl_outlines_overlap(outer, inner, true)) return false;
jbe@16 783 return true;
jbe@16 784 }
jbe@16 785
jbe@16 786 /* check if two clusters overlap */
jbe@16 787 static bool pgl_clusters_overlap(
jbe@16 788 pgl_cluster *cluster1, pgl_cluster *cluster2
jbe@16 789 ) {
jbe@16 790 if (pgl_any_cluster_points_in_cluster(cluster1, cluster2)) return true;
jbe@16 791 if (pgl_any_cluster_points_in_cluster(cluster2, cluster1)) return true;
jbe@16 792 if (pgl_outlines_overlap(cluster1, cluster2, false)) return true;
jbe@16 793 return false;
jbe@16 794 }
jbe@16 795
jbe@16 796
jbe@0 797 /* calculate (approximate) distance between point and cluster */
jbe@0 798 static double pgl_point_cluster_distance(pgl_point *point, pgl_cluster *cluster) {
jbe@0 799 int i, j, k; /* i: entry, j: point in entry, k: next point in entry */
jbe@0 800 int entrytype; /* type of entry */
jbe@0 801 int npoints; /* number of points in entry */
jbe@0 802 pgl_point *points; /* array of points in entry */
jbe@0 803 int lon_dir = 0; /* first vertex west (-1) or east (+1) */
jbe@0 804 double lon_break = 0; /* antipodal longitude of first vertex */
jbe@0 805 double lon_min = 0; /* minimum (adjusted) longitude of entry vertices */
jbe@0 806 double lon_max = 0; /* maximum (adjusted) longitude of entry vertices */
jbe@0 807 double lat0 = point->lat; /* latitude of point */
jbe@0 808 double lon0; /* (adjusted) longitude of point */
jbe@0 809 double lat1, lon1; /* latitude and (adjusted) longitude of vertex */
jbe@0 810 double lat2, lon2; /* latitude and (adjusted) longitude of next vertex */
jbe@0 811 double s; /* scalar for vector calculations */
jbe@0 812 double dist; /* distance calculated in one step */
jbe@0 813 double min_dist = INFINITY; /* minimum distance */
jbe@0 814 /* distance is zero if point is contained in cluster */
jbe@0 815 if (pgl_point_in_cluster(point, cluster)) return 0;
jbe@0 816 /* iterate over all entries */
jbe@0 817 for (i=0; i<cluster->nentries; i++) {
jbe@0 818 /* get properties of entry */
jbe@0 819 entrytype = cluster->entries[i].entrytype;
jbe@0 820 npoints = cluster->entries[i].npoints;
jbe@0 821 points = PGL_ENTRY_POINTS(cluster, i);
jbe@0 822 /* determine east/west orientation of first point of entry and calculate
jbe@0 823 antipodal longitude */
jbe@0 824 lon_break = points[0].lon;
jbe@0 825 if (lon_break < 0) { lon_dir = -1; lon_break += 180; }
jbe@0 826 else if (lon_break > 0) { lon_dir = 1; lon_break -= 180; }
jbe@0 827 else lon_dir = 0;
jbe@0 828 /* determine covered longitude range */
jbe@0 829 for (j=0; j<npoints; j++) {
jbe@0 830 /* get longitude of vertex */
jbe@0 831 lon1 = points[j].lon;
jbe@0 832 /* adjust longitude to fix potential wrap-around */
jbe@0 833 if (lon_dir < 0 && lon1 > lon_break) lon1 -= 360;
jbe@0 834 else if (lon_dir > 0 && lon1 < lon_break) lon1 += 360;
jbe@0 835 /* update minimum and maximum longitude of polygon */
jbe@0 836 if (j == 0 || lon1 < lon_min) lon_min = lon1;
jbe@0 837 if (j == 0 || lon1 > lon_max) lon_max = lon1;
jbe@0 838 }
jbe@0 839 /* adjust longitude wrap-around according to full longitude range */
jbe@0 840 lon_break = (lon_max + lon_min) / 2;
jbe@0 841 if (lon_break < 0) { lon_dir = -1; lon_break += 180; }
jbe@0 842 else if (lon_break > 0) { lon_dir = 1; lon_break -= 180; }
jbe@0 843 /* get longitude of point */
jbe@0 844 lon0 = point->lon;
jbe@0 845 /* consider longitude wrap-around for point */
jbe@0 846 if (lon_dir < 0 && lon0 > lon_break) lon0 -= 360;
jbe@0 847 else if (lon_dir > 0 && lon0 < lon_break) lon0 += 360;
jbe@0 848 /* iterate over all edges and vertices */
jbe@0 849 for (j=0; j<npoints; j++) {
jbe@16 850 /* use previously calculated values for lat1 and lon1 if possible */
jbe@16 851 if (j) {
jbe@16 852 lat1 = lat2;
jbe@16 853 lon1 = lon2;
jbe@16 854 } else {
jbe@16 855 /* otherwise get latitude and longitude values of first vertex */
jbe@16 856 lat1 = points[0].lat;
jbe@16 857 lon1 = points[0].lon;
jbe@16 858 /* and consider longitude wrap-around for first vertex */
jbe@16 859 if (lon_dir < 0 && lon1 > lon_break) lon1 -= 360;
jbe@16 860 else if (lon_dir > 0 && lon1 < lon_break) lon1 += 360;
jbe@16 861 }
jbe@0 862 /* calculate distance to vertex */
jbe@0 863 dist = pgl_distance(lat0, lon0, lat1, lon1);
jbe@0 864 /* store calculated distance if smallest */
jbe@0 865 if (dist < min_dist) min_dist = dist;
jbe@0 866 /* calculate index of next vertex */
jbe@0 867 k = (j+1) % npoints;
jbe@0 868 /* skip last edge unless entry is (closed) outline or polygon */
jbe@0 869 if (
jbe@0 870 k == 0 &&
jbe@0 871 entrytype != PGL_ENTRY_OUTLINE &&
jbe@0 872 entrytype != PGL_ENTRY_POLYGON
jbe@0 873 ) continue;
jbe@16 874 /* get latitude and longitude of next vertex */
jbe@0 875 lat2 = points[k].lat;
jbe@0 876 lon2 = points[k].lon;
jbe@16 877 /* consider longitude wrap-around for next vertex */
jbe@0 878 if (lon_dir < 0 && lon2 > lon_break) lon2 -= 360;
jbe@0 879 else if (lon_dir > 0 && lon2 < lon_break) lon2 += 360;
jbe@0 880 /* go to next vertex and edge if edge is degenerated */
jbe@0 881 if (lat1 == lat2 && lon1 == lon2) continue;
jbe@0 882 /* otherwise test if point can be projected onto edge of polygon */
jbe@0 883 s = (
jbe@0 884 ((lat0-lat1) * (lat2-lat1) + (lon0-lon1) * (lon2-lon1)) /
jbe@0 885 ((lat2-lat1) * (lat2-lat1) + (lon2-lon1) * (lon2-lon1))
jbe@0 886 );
jbe@0 887 /* go to next vertex and edge if point cannot be projected */
jbe@0 888 if (!(s > 0 && s < 1)) continue;
jbe@0 889 /* calculate distance from original point to projected point */
jbe@0 890 dist = pgl_distance(
jbe@0 891 lat0, lon0,
jbe@0 892 lat1 + s * (lat2-lat1),
jbe@0 893 lon1 + s * (lon2-lon1)
jbe@0 894 );
jbe@0 895 /* store calculated distance if smallest */
jbe@0 896 if (dist < min_dist) min_dist = dist;
jbe@0 897 }
jbe@0 898 }
jbe@0 899 /* return minimum distance */
jbe@0 900 return min_dist;
jbe@0 901 }
jbe@0 902
jbe@16 903 /* calculate (approximate) distance between two clusters */
jbe@16 904 static double pgl_cluster_distance(pgl_cluster *cluster1, pgl_cluster *cluster2) {
jbe@16 905 int i, j; /* i: entry, j: point in entry */
jbe@16 906 int npoints; /* number of points in entry */
jbe@16 907 pgl_point *points; /* array of points in entry */
jbe@16 908 double dist; /* distance calculated in one step */
jbe@16 909 double min_dist = INFINITY; /* minimum distance */
jbe@16 910 /* consider distance from each point in one cluster to the whole other */
jbe@16 911 for (i=0; i<cluster1->nentries; i++) {
jbe@16 912 npoints = cluster1->entries[i].npoints;
jbe@16 913 points = PGL_ENTRY_POINTS(cluster1, i);
jbe@16 914 for (j=0; j<npoints; j++) {
jbe@16 915 dist = pgl_point_cluster_distance(points+j, cluster2);
jbe@16 916 if (dist == 0) return dist;
jbe@16 917 if (dist < min_dist) min_dist = dist;
jbe@16 918 }
jbe@16 919 }
jbe@16 920 /* consider distance from each point in other cluster to the first cluster */
jbe@16 921 for (i=0; i<cluster2->nentries; i++) {
jbe@16 922 npoints = cluster2->entries[i].npoints;
jbe@16 923 points = PGL_ENTRY_POINTS(cluster2, i);
jbe@16 924 for (j=0; j<npoints; j++) {
jbe@16 925 dist = pgl_point_cluster_distance(points+j, cluster1);
jbe@16 926 if (dist == 0) return dist;
jbe@16 927 if (dist < min_dist) min_dist = dist;
jbe@16 928 }
jbe@16 929 }
jbe@16 930 return min_dist;
jbe@16 931 }
jbe@16 932
jbe@0 933 /* estimator function for distance between box and point */
jbe@16 934 /* always returns a smaller value than actually correct or zero */
jbe@0 935 static double pgl_estimate_point_box_distance(pgl_point *point, pgl_box *box) {
jbe@16 936 double dlon; /* longitude range of box (delta longitude) */
jbe@16 937 double distance; /* return value */
jbe@16 938 /* return infinity if box is empty */
jbe@0 939 if (box->lat_min > box->lat_max) return INFINITY;
jbe@16 940 /* return zero if point is inside box */
jbe@0 941 if (pgl_point_in_box(point, box)) return 0;
jbe@0 942 /* calculate delta longitude */
jbe@0 943 dlon = box->lon_max - box->lon_min;
jbe@0 944 if (dlon < 0) dlon += 360; /* 180th meridian crossed */
jbe@16 945 /* if delta longitude is greater than 150 degrees, perform safe fall-back */
jbe@16 946 if (dlon > 150) return 0;
jbe@16 947 /* calculate lower limit for distance (formula below requires dlon <= 150) */
jbe@16 948 /* TODO: provide better estimation function to improve performance */
jbe@16 949 distance = (
jbe@16 950 (1.0-1e-14) * pgl_distance(
jbe@16 951 point->lat,
jbe@16 952 point->lon,
jbe@16 953 (box->lat_min + box->lat_max) / 2,
jbe@16 954 box->lon_min + dlon/2
jbe@16 955 ) - pgl_distance(
jbe@16 956 box->lat_min, box->lon_min,
jbe@16 957 box->lat_max, box->lon_max
jbe@16 958 )
jbe@16 959 );
jbe@16 960 /* truncate negative results to zero */
jbe@16 961 if (distance <= 0) distance = 0;
jbe@16 962 /* return result */
jbe@16 963 return distance;
jbe@0 964 }
jbe@0 965
jbe@0 966
jbe@16 967 /*-------------------------------------------------*
jbe@16 968 * geographic index based on space-filling curve *
jbe@16 969 *-------------------------------------------------*/
jbe@0 970
jbe@0 971 /* number of bytes used for geographic (center) position in keys */
jbe@0 972 #define PGL_KEY_LATLON_BYTELEN 7
jbe@0 973
jbe@0 974 /* maximum reference value for logarithmic size of geographic objects */
jbe@0 975 #define PGL_AREAKEY_REFOBJSIZE (PGL_DIAMETER/3.0) /* can be tweaked */
jbe@0 976
jbe@0 977 /* pointer to index key (either pgl_pointkey or pgl_areakey) */
jbe@0 978 typedef unsigned char *pgl_keyptr;
jbe@0 979
jbe@0 980 /* index key for points (objects with zero area) on the spheroid */
jbe@0 981 /* bit 0..55: interspersed bits of latitude and longitude,
jbe@0 982 bit 56..57: always zero,
jbe@0 983 bit 58..63: node depth in hypothetic (full) tree from 0 to 56 (incl.) */
jbe@0 984 typedef unsigned char pgl_pointkey[PGL_KEY_LATLON_BYTELEN+1];
jbe@0 985
jbe@0 986 /* index key for geographic objects on spheroid with area greater than zero */
jbe@0 987 /* bit 0..55: interspersed bits of latitude and longitude of center point,
jbe@0 988 bit 56: always set to 1,
jbe@0 989 bit 57..63: node depth in hypothetic (full) tree from 0 to (2*56)+1 (incl.),
jbe@0 990 bit 64..71: logarithmic object size from 0 to 56+1 = 57 (incl.), but set to
jbe@0 991 PGL_KEY_OBJSIZE_EMPTY (with interspersed bits = 0 and node depth
jbe@0 992 = 113) for empty objects, and set to PGL_KEY_OBJSIZE_UNIVERSAL
jbe@0 993 (with interspersed bits = 0 and node depth = 0) for keys which
jbe@0 994 cover both empty and non-empty objects */
jbe@0 995
jbe@0 996 typedef unsigned char pgl_areakey[PGL_KEY_LATLON_BYTELEN+2];
jbe@0 997
jbe@0 998 /* helper macros for reading/writing index keys */
jbe@0 999 #define PGL_KEY_NODEDEPTH_OFFSET PGL_KEY_LATLON_BYTELEN
jbe@0 1000 #define PGL_KEY_OBJSIZE_OFFSET (PGL_KEY_NODEDEPTH_OFFSET+1)
jbe@0 1001 #define PGL_POINTKEY_MAXDEPTH (PGL_KEY_LATLON_BYTELEN*8)
jbe@0 1002 #define PGL_AREAKEY_MAXDEPTH (2*PGL_POINTKEY_MAXDEPTH+1)
jbe@0 1003 #define PGL_AREAKEY_MAXOBJSIZE (PGL_POINTKEY_MAXDEPTH+1)
jbe@0 1004 #define PGL_AREAKEY_TYPEMASK 0x80
jbe@0 1005 #define PGL_KEY_LATLONBIT(key, n) ((key)[(n)/8] & (0x80 >> ((n)%8)))
jbe@0 1006 #define PGL_KEY_LATLONBIT_DIFF(key1, key2, n) \
jbe@0 1007 ( PGL_KEY_LATLONBIT(key1, n) ^ \
jbe@0 1008 PGL_KEY_LATLONBIT(key2, n) )
jbe@0 1009 #define PGL_KEY_IS_AREAKEY(key) ((key)[PGL_KEY_NODEDEPTH_OFFSET] & \
jbe@0 1010 PGL_AREAKEY_TYPEMASK)
jbe@0 1011 #define PGL_KEY_NODEDEPTH(key) ((key)[PGL_KEY_NODEDEPTH_OFFSET] & \
jbe@0 1012 (PGL_AREAKEY_TYPEMASK-1))
jbe@0 1013 #define PGL_KEY_OBJSIZE(key) ((key)[PGL_KEY_OBJSIZE_OFFSET])
jbe@0 1014 #define PGL_KEY_OBJSIZE_EMPTY 126
jbe@0 1015 #define PGL_KEY_OBJSIZE_UNIVERSAL 127
jbe@0 1016 #define PGL_KEY_IS_EMPTY(key) ( PGL_KEY_IS_AREAKEY(key) && \
jbe@0 1017 (key)[PGL_KEY_OBJSIZE_OFFSET] == \
jbe@0 1018 PGL_KEY_OBJSIZE_EMPTY )
jbe@0 1019 #define PGL_KEY_IS_UNIVERSAL(key) ( PGL_KEY_IS_AREAKEY(key) && \
jbe@0 1020 (key)[PGL_KEY_OBJSIZE_OFFSET] == \
jbe@0 1021 PGL_KEY_OBJSIZE_UNIVERSAL )
jbe@0 1022
jbe@0 1023 /* set area key to match empty objects only */
jbe@0 1024 static void pgl_key_set_empty(pgl_keyptr key) {
jbe@0 1025 memset(key, 0, sizeof(pgl_areakey));
jbe@0 1026 /* Note: setting node depth to maximum is required for picksplit function */
jbe@0 1027 key[PGL_KEY_NODEDEPTH_OFFSET] = PGL_AREAKEY_TYPEMASK | PGL_AREAKEY_MAXDEPTH;
jbe@0 1028 key[PGL_KEY_OBJSIZE_OFFSET] = PGL_KEY_OBJSIZE_EMPTY;
jbe@0 1029 }
jbe@0 1030
jbe@0 1031 /* set area key to match any object (including empty objects) */
jbe@0 1032 static void pgl_key_set_universal(pgl_keyptr key) {
jbe@0 1033 memset(key, 0, sizeof(pgl_areakey));
jbe@0 1034 key[PGL_KEY_NODEDEPTH_OFFSET] = PGL_AREAKEY_TYPEMASK;
jbe@0 1035 key[PGL_KEY_OBJSIZE_OFFSET] = PGL_KEY_OBJSIZE_UNIVERSAL;
jbe@0 1036 }
jbe@0 1037
jbe@0 1038 /* convert a point on earth into a max-depth key to be used in index */
jbe@0 1039 static void pgl_point_to_key(pgl_point *point, pgl_keyptr key) {
jbe@0 1040 double lat = point->lat;
jbe@0 1041 double lon = point->lon;
jbe@0 1042 int i;
jbe@0 1043 /* clear latitude and longitude bits */
jbe@0 1044 memset(key, 0, PGL_KEY_LATLON_BYTELEN);
jbe@0 1045 /* set node depth to maximum and type bit to zero */
jbe@0 1046 key[PGL_KEY_NODEDEPTH_OFFSET] = PGL_POINTKEY_MAXDEPTH;
jbe@0 1047 /* iterate over all latitude/longitude bit pairs */
jbe@0 1048 for (i=0; i<PGL_POINTKEY_MAXDEPTH/2; i++) {
jbe@0 1049 /* determine latitude bit */
jbe@0 1050 if (lat >= 0) {
jbe@0 1051 key[i/4] |= 0x80 >> (2*(i%4));
jbe@0 1052 lat *= 2; lat -= 90;
jbe@0 1053 } else {
jbe@0 1054 lat *= 2; lat += 90;
jbe@0 1055 }
jbe@0 1056 /* determine longitude bit */
jbe@0 1057 if (lon >= 0) {
jbe@0 1058 key[i/4] |= 0x80 >> (2*(i%4)+1);
jbe@0 1059 lon *= 2; lon -= 180;
jbe@0 1060 } else {
jbe@0 1061 lon *= 2; lon += 180;
jbe@0 1062 }
jbe@0 1063 }
jbe@0 1064 }
jbe@0 1065
jbe@0 1066 /* convert a circle on earth into a max-depth key to be used in an index */
jbe@0 1067 static void pgl_circle_to_key(pgl_circle *circle, pgl_keyptr key) {
jbe@0 1068 /* handle special case of empty circle */
jbe@0 1069 if (circle->radius < 0) {
jbe@0 1070 pgl_key_set_empty(key);
jbe@0 1071 return;
jbe@0 1072 }
jbe@0 1073 /* perform same action as for point keys */
jbe@0 1074 pgl_point_to_key(&(circle->center), key);
jbe@0 1075 /* but overwrite type and node depth to fit area index key */
jbe@0 1076 key[PGL_KEY_NODEDEPTH_OFFSET] = PGL_AREAKEY_TYPEMASK | PGL_AREAKEY_MAXDEPTH;
jbe@0 1077 /* check if radius is greater than (or equal to) reference size */
jbe@0 1078 /* (treat equal values as greater values for numerical safety) */
jbe@0 1079 if (circle->radius >= PGL_AREAKEY_REFOBJSIZE) {
jbe@0 1080 /* if yes, set logarithmic size to zero */
jbe@0 1081 key[PGL_KEY_OBJSIZE_OFFSET] = 0;
jbe@0 1082 } else {
jbe@0 1083 /* otherwise, determine logarithmic size iteratively */
jbe@0 1084 /* (one step is equivalent to a factor of sqrt(2)) */
jbe@0 1085 double reference = PGL_AREAKEY_REFOBJSIZE / M_SQRT2;
jbe@0 1086 int objsize = 1;
jbe@0 1087 while (objsize < PGL_AREAKEY_MAXOBJSIZE) {
jbe@0 1088 /* stop when radius is greater than (or equal to) adjusted reference */
jbe@0 1089 /* (treat equal values as greater values for numerical safety) */
jbe@0 1090 if (circle->radius >= reference) break;
jbe@0 1091 reference /= M_SQRT2;
jbe@0 1092 objsize++;
jbe@0 1093 }
jbe@0 1094 /* set logarithmic size to determined value */
jbe@0 1095 key[PGL_KEY_OBJSIZE_OFFSET] = objsize;
jbe@0 1096 }
jbe@0 1097 }
jbe@0 1098
jbe@0 1099 /* check if one key is subkey of another key or vice versa */
jbe@0 1100 static bool pgl_keys_overlap(pgl_keyptr key1, pgl_keyptr key2) {
jbe@0 1101 int i; /* key bit offset (includes both lat/lon and log. obj. size bits) */
jbe@0 1102 /* determine smallest depth */
jbe@0 1103 int depth1 = PGL_KEY_NODEDEPTH(key1);
jbe@0 1104 int depth2 = PGL_KEY_NODEDEPTH(key2);
jbe@0 1105 int depth = (depth1 < depth2) ? depth1 : depth2;
jbe@0 1106 /* check if keys are area keys (assuming that both keys have same type) */
jbe@0 1107 if (PGL_KEY_IS_AREAKEY(key1)) {
jbe@0 1108 int j = 0; /* bit offset for logarithmic object size bits */
jbe@0 1109 int k = 0; /* bit offset for latitude and longitude */
jbe@0 1110 /* fetch logarithmic object size information */
jbe@0 1111 int objsize1 = PGL_KEY_OBJSIZE(key1);
jbe@0 1112 int objsize2 = PGL_KEY_OBJSIZE(key2);
jbe@0 1113 /* handle special cases for empty objects (universal and empty keys) */
jbe@0 1114 if (
jbe@0 1115 objsize1 == PGL_KEY_OBJSIZE_UNIVERSAL ||
jbe@0 1116 objsize2 == PGL_KEY_OBJSIZE_UNIVERSAL
jbe@0 1117 ) return true;
jbe@0 1118 if (
jbe@0 1119 objsize1 == PGL_KEY_OBJSIZE_EMPTY ||
jbe@0 1120 objsize2 == PGL_KEY_OBJSIZE_EMPTY
jbe@0 1121 ) return objsize1 == objsize2;
jbe@0 1122 /* iterate through key bits */
jbe@0 1123 for (i=0; i<depth; i++) {
jbe@0 1124 /* every second bit is a bit describing the object size */
jbe@0 1125 if (i%2 == 0) {
jbe@0 1126 /* check if object size bit is different in both keys (objsize1 and
jbe@0 1127 objsize2 describe the minimum index when object size bit is set) */
jbe@0 1128 if (
jbe@0 1129 (objsize1 <= j && objsize2 > j) ||
jbe@0 1130 (objsize2 <= j && objsize1 > j)
jbe@0 1131 ) {
jbe@0 1132 /* bit differs, therefore keys are in separate branches */
jbe@0 1133 return false;
jbe@0 1134 }
jbe@0 1135 /* increase bit counter for object size bits */
jbe@0 1136 j++;
jbe@0 1137 }
jbe@0 1138 /* all other bits describe latitude and longitude */
jbe@0 1139 else {
jbe@0 1140 /* check if bit differs in both keys */
jbe@0 1141 if (PGL_KEY_LATLONBIT_DIFF(key1, key2, k)) {
jbe@0 1142 /* bit differs, therefore keys are in separate branches */
jbe@0 1143 return false;
jbe@0 1144 }
jbe@0 1145 /* increase bit counter for latitude/longitude bits */
jbe@0 1146 k++;
jbe@0 1147 }
jbe@0 1148 }
jbe@0 1149 }
jbe@0 1150 /* if not, keys are point keys */
jbe@0 1151 else {
jbe@0 1152 /* iterate through key bits */
jbe@0 1153 for (i=0; i<depth; i++) {
jbe@0 1154 /* check if bit differs in both keys */
jbe@0 1155 if (PGL_KEY_LATLONBIT_DIFF(key1, key2, i)) {
jbe@0 1156 /* bit differs, therefore keys are in separate branches */
jbe@0 1157 return false;
jbe@0 1158 }
jbe@0 1159 }
jbe@0 1160 }
jbe@0 1161 /* return true because keys are in the same branch */
jbe@0 1162 return true;
jbe@0 1163 }
jbe@0 1164
jbe@0 1165 /* combine two keys into new key which covers both original keys */
jbe@0 1166 /* (result stored in first argument) */
jbe@0 1167 static void pgl_unite_keys(pgl_keyptr dst, pgl_keyptr src) {
jbe@0 1168 int i; /* key bit offset (includes both lat/lon and log. obj. size bits) */
jbe@0 1169 /* determine smallest depth */
jbe@0 1170 int depth1 = PGL_KEY_NODEDEPTH(dst);
jbe@0 1171 int depth2 = PGL_KEY_NODEDEPTH(src);
jbe@0 1172 int depth = (depth1 < depth2) ? depth1 : depth2;
jbe@0 1173 /* check if keys are area keys (assuming that both keys have same type) */
jbe@0 1174 if (PGL_KEY_IS_AREAKEY(dst)) {
jbe@0 1175 pgl_areakey dstbuf = { 0, }; /* destination buffer (cleared) */
jbe@0 1176 int j = 0; /* bit offset for logarithmic object size bits */
jbe@0 1177 int k = 0; /* bit offset for latitude and longitude */
jbe@0 1178 /* fetch logarithmic object size information */
jbe@0 1179 int objsize1 = PGL_KEY_OBJSIZE(dst);
jbe@0 1180 int objsize2 = PGL_KEY_OBJSIZE(src);
jbe@0 1181 /* handle special cases for empty objects (universal and empty keys) */
jbe@0 1182 if (
jbe@0 1183 objsize1 > PGL_AREAKEY_MAXOBJSIZE ||
jbe@0 1184 objsize2 > PGL_AREAKEY_MAXOBJSIZE
jbe@0 1185 ) {
jbe@0 1186 if (
jbe@0 1187 objsize1 == PGL_KEY_OBJSIZE_EMPTY &&
jbe@0 1188 objsize2 == PGL_KEY_OBJSIZE_EMPTY
jbe@0 1189 ) pgl_key_set_empty(dst);
jbe@0 1190 else pgl_key_set_universal(dst);
jbe@0 1191 return;
jbe@0 1192 }
jbe@0 1193 /* iterate through key bits */
jbe@0 1194 for (i=0; i<depth; i++) {
jbe@0 1195 /* every second bit is a bit describing the object size */
jbe@0 1196 if (i%2 == 0) {
jbe@0 1197 /* increase bit counter for object size bits first */
jbe@0 1198 /* (handy when setting objsize variable) */
jbe@0 1199 j++;
jbe@0 1200 /* check if object size bit is set in neither key */
jbe@0 1201 if (objsize1 >= j && objsize2 >= j) {
jbe@0 1202 /* set objsize in destination buffer to indicate that size bit is
jbe@0 1203 unset in destination buffer at the current bit position */
jbe@0 1204 dstbuf[PGL_KEY_OBJSIZE_OFFSET] = j;
jbe@0 1205 }
jbe@0 1206 /* break if object size bit is set in one key only */
jbe@0 1207 else if (objsize1 >= j || objsize2 >= j) break;
jbe@0 1208 }
jbe@0 1209 /* all other bits describe latitude and longitude */
jbe@0 1210 else {
jbe@0 1211 /* break if bit differs in both keys */
jbe@0 1212 if (PGL_KEY_LATLONBIT(dst, k)) {
jbe@0 1213 if (!PGL_KEY_LATLONBIT(src, k)) break;
jbe@0 1214 /* but set bit in destination buffer if bit is set in both keys */
jbe@0 1215 dstbuf[k/8] |= 0x80 >> (k%8);
jbe@0 1216 } else if (PGL_KEY_LATLONBIT(src, k)) break;
jbe@0 1217 /* increase bit counter for latitude/longitude bits */
jbe@0 1218 k++;
jbe@0 1219 }
jbe@0 1220 }
jbe@0 1221 /* set common node depth and type bit (type bit = 1) */
jbe@0 1222 dstbuf[PGL_KEY_NODEDEPTH_OFFSET] = PGL_AREAKEY_TYPEMASK | i;
jbe@0 1223 /* copy contents of destination buffer to first key */
jbe@0 1224 memcpy(dst, dstbuf, sizeof(pgl_areakey));
jbe@0 1225 }
jbe@0 1226 /* if not, keys are point keys */
jbe@0 1227 else {
jbe@0 1228 pgl_pointkey dstbuf = { 0, }; /* destination buffer (cleared) */
jbe@0 1229 /* iterate through key bits */
jbe@0 1230 for (i=0; i<depth; i++) {
jbe@0 1231 /* break if bit differs in both keys */
jbe@0 1232 if (PGL_KEY_LATLONBIT(dst, i)) {
jbe@0 1233 if (!PGL_KEY_LATLONBIT(src, i)) break;
jbe@0 1234 /* but set bit in destination buffer if bit is set in both keys */
jbe@0 1235 dstbuf[i/8] |= 0x80 >> (i%8);
jbe@0 1236 } else if (PGL_KEY_LATLONBIT(src, i)) break;
jbe@0 1237 }
jbe@0 1238 /* set common node depth (type bit = 0) */
jbe@0 1239 dstbuf[PGL_KEY_NODEDEPTH_OFFSET] = i;
jbe@0 1240 /* copy contents of destination buffer to first key */
jbe@0 1241 memcpy(dst, dstbuf, sizeof(pgl_pointkey));
jbe@0 1242 }
jbe@0 1243 }
jbe@0 1244
jbe@0 1245 /* determine center(!) boundaries and radius estimation of index key */
jbe@0 1246 static double pgl_key_to_box(pgl_keyptr key, pgl_box *box) {
jbe@0 1247 int i;
jbe@0 1248 /* determine node depth */
jbe@0 1249 int depth = PGL_KEY_NODEDEPTH(key);
jbe@0 1250 /* center point of possible result */
jbe@0 1251 double lat = 0;
jbe@0 1252 double lon = 0;
jbe@0 1253 /* maximum distance of real center point from key center */
jbe@0 1254 double dlat = 90;
jbe@0 1255 double dlon = 180;
jbe@0 1256 /* maximum radius of contained objects */
jbe@0 1257 double radius = 0; /* always return zero for point index keys */
jbe@0 1258 /* check if key is area key */
jbe@0 1259 if (PGL_KEY_IS_AREAKEY(key)) {
jbe@0 1260 /* get logarithmic object size */
jbe@0 1261 int objsize = PGL_KEY_OBJSIZE(key);
jbe@0 1262 /* handle special cases for empty objects (universal and empty keys) */
jbe@0 1263 if (objsize == PGL_KEY_OBJSIZE_EMPTY) {
jbe@0 1264 pgl_box_set_empty(box);
jbe@0 1265 return 0;
jbe@0 1266 } else if (objsize == PGL_KEY_OBJSIZE_UNIVERSAL) {
jbe@0 1267 box->lat_min = -90;
jbe@0 1268 box->lat_max = 90;
jbe@0 1269 box->lon_min = -180;
jbe@0 1270 box->lon_max = 180;
jbe@0 1271 return 0; /* any value >= 0 would do */
jbe@0 1272 }
jbe@0 1273 /* calculate maximum possible radius of objects covered by the given key */
jbe@0 1274 if (objsize == 0) radius = INFINITY;
jbe@0 1275 else {
jbe@0 1276 radius = PGL_AREAKEY_REFOBJSIZE;
jbe@0 1277 while (--objsize) radius /= M_SQRT2;
jbe@0 1278 }
jbe@0 1279 /* iterate over latitude and longitude bits in key */
jbe@0 1280 /* (every second bit is a latitude or longitude bit) */
jbe@0 1281 for (i=0; i<depth/2; i++) {
jbe@0 1282 /* check if latitude bit */
jbe@0 1283 if (i%2 == 0) {
jbe@0 1284 /* cut latitude dimension in half */
jbe@0 1285 dlat /= 2;
jbe@0 1286 /* increase center latitude if bit is 1, otherwise decrease */
jbe@0 1287 if (PGL_KEY_LATLONBIT(key, i)) lat += dlat;
jbe@0 1288 else lat -= dlat;
jbe@0 1289 }
jbe@0 1290 /* otherwise longitude bit */
jbe@0 1291 else {
jbe@0 1292 /* cut longitude dimension in half */
jbe@0 1293 dlon /= 2;
jbe@0 1294 /* increase center longitude if bit is 1, otherwise decrease */
jbe@0 1295 if (PGL_KEY_LATLONBIT(key, i)) lon += dlon;
jbe@0 1296 else lon -= dlon;
jbe@0 1297 }
jbe@0 1298 }
jbe@0 1299 }
jbe@0 1300 /* if not, keys are point keys */
jbe@0 1301 else {
jbe@0 1302 /* iterate over all bits in key */
jbe@0 1303 for (i=0; i<depth; i++) {
jbe@0 1304 /* check if latitude bit */
jbe@0 1305 if (i%2 == 0) {
jbe@0 1306 /* cut latitude dimension in half */
jbe@0 1307 dlat /= 2;
jbe@0 1308 /* increase center latitude if bit is 1, otherwise decrease */
jbe@0 1309 if (PGL_KEY_LATLONBIT(key, i)) lat += dlat;
jbe@0 1310 else lat -= dlat;
jbe@0 1311 }
jbe@0 1312 /* otherwise longitude bit */
jbe@0 1313 else {
jbe@0 1314 /* cut longitude dimension in half */
jbe@0 1315 dlon /= 2;
jbe@0 1316 /* increase center longitude if bit is 1, otherwise decrease */
jbe@0 1317 if (PGL_KEY_LATLONBIT(key, i)) lon += dlon;
jbe@0 1318 else lon -= dlon;
jbe@0 1319 }
jbe@0 1320 }
jbe@0 1321 }
jbe@0 1322 /* calculate boundaries from center point and remaining dlat and dlon */
jbe@0 1323 /* (return values through pointer to box) */
jbe@0 1324 box->lat_min = lat - dlat;
jbe@0 1325 box->lat_max = lat + dlat;
jbe@0 1326 box->lon_min = lon - dlon;
jbe@0 1327 box->lon_max = lon + dlon;
jbe@0 1328 /* return radius (as a function return value) */
jbe@0 1329 return radius;
jbe@0 1330 }
jbe@0 1331
jbe@0 1332 /* estimator function for distance between point and index key */
jbe@16 1333 /* always returns a smaller value than actually correct or zero */
jbe@0 1334 static double pgl_estimate_key_distance(pgl_keyptr key, pgl_point *point) {
jbe@0 1335 pgl_box box; /* center(!) bounding box of area index key */
jbe@0 1336 /* calculate center(!) bounding box and maximum radius of objects covered
jbe@0 1337 by area index key (radius is zero for point index keys) */
jbe@0 1338 double distance = pgl_key_to_box(key, &box);
jbe@0 1339 /* calculate estimated distance between bounding box of center point of
jbe@0 1340 indexed object and point passed as second argument, then substract maximum
jbe@0 1341 radius of objects covered by index key */
jbe@16 1342 distance = pgl_estimate_point_box_distance(point, &box) - distance;
jbe@0 1343 /* truncate negative results to zero */
jbe@0 1344 if (distance <= 0) distance = 0;
jbe@0 1345 /* return result */
jbe@0 1346 return distance;
jbe@0 1347 }
jbe@0 1348
jbe@0 1349
jbe@0 1350 /*---------------------------------*
jbe@0 1351 * helper functions for text I/O *
jbe@0 1352 *---------------------------------*/
jbe@0 1353
jbe@0 1354 #define PGL_NUMBUFLEN 64 /* buffer size for number to string conversion */
jbe@0 1355
jbe@0 1356 /* convert floating point number to string (round-trip safe) */
jbe@0 1357 static void pgl_print_float(char *buf, double flt) {
jbe@0 1358 /* check if number is integral */
jbe@0 1359 if (trunc(flt) == flt) {
jbe@0 1360 /* for integral floats use maximum precision */
jbe@0 1361 snprintf(buf, PGL_NUMBUFLEN, "%.17g", flt);
jbe@0 1362 } else {
jbe@0 1363 /* otherwise check if 15, 16, or 17 digits needed (round-trip safety) */
jbe@0 1364 snprintf(buf, PGL_NUMBUFLEN, "%.15g", flt);
jbe@0 1365 if (strtod(buf, NULL) != flt) snprintf(buf, PGL_NUMBUFLEN, "%.16g", flt);
jbe@0 1366 if (strtod(buf, NULL) != flt) snprintf(buf, PGL_NUMBUFLEN, "%.17g", flt);
jbe@0 1367 }
jbe@0 1368 }
jbe@0 1369
jbe@0 1370 /* convert latitude floating point number (in degrees) to string */
jbe@0 1371 static void pgl_print_lat(char *buf, double lat) {
jbe@0 1372 if (signbit(lat)) {
jbe@0 1373 /* treat negative latitudes (including -0) as south */
jbe@0 1374 snprintf(buf, PGL_NUMBUFLEN, "S%015.12f", -lat);
jbe@0 1375 } else {
jbe@0 1376 /* treat positive latitudes (including +0) as north */
jbe@0 1377 snprintf(buf, PGL_NUMBUFLEN, "N%015.12f", lat);
jbe@0 1378 }
jbe@0 1379 }
jbe@0 1380
jbe@0 1381 /* convert longitude floating point number (in degrees) to string */
jbe@0 1382 static void pgl_print_lon(char *buf, double lon) {
jbe@0 1383 if (signbit(lon)) {
jbe@0 1384 /* treat negative longitudes (including -0) as west */
jbe@0 1385 snprintf(buf, PGL_NUMBUFLEN, "W%016.12f", -lon);
jbe@0 1386 } else {
jbe@0 1387 /* treat positive longitudes (including +0) as east */
jbe@0 1388 snprintf(buf, PGL_NUMBUFLEN, "E%016.12f", lon);
jbe@0 1389 }
jbe@0 1390 }
jbe@0 1391
jbe@0 1392 /* bit masks used as return value of pgl_scan() function */
jbe@0 1393 #define PGL_SCAN_NONE 0 /* no value has been parsed */
jbe@0 1394 #define PGL_SCAN_LAT (1<<0) /* latitude has been parsed */
jbe@0 1395 #define PGL_SCAN_LON (1<<1) /* longitude has been parsed */
jbe@0 1396 #define PGL_SCAN_LATLON (PGL_SCAN_LAT | PGL_SCAN_LON) /* bitwise OR of both */
jbe@0 1397
jbe@0 1398 /* parse a coordinate (can be latitude or longitude) */
jbe@0 1399 static int pgl_scan(char **str, double *lat, double *lon) {
jbe@0 1400 double val;
jbe@0 1401 int len;
jbe@0 1402 if (
jbe@0 1403 sscanf(*str, " N %lf %n", &val, &len) ||
jbe@0 1404 sscanf(*str, " n %lf %n", &val, &len)
jbe@0 1405 ) {
jbe@0 1406 *str += len; *lat = val; return PGL_SCAN_LAT;
jbe@0 1407 }
jbe@0 1408 if (
jbe@0 1409 sscanf(*str, " S %lf %n", &val, &len) ||
jbe@0 1410 sscanf(*str, " s %lf %n", &val, &len)
jbe@0 1411 ) {
jbe@0 1412 *str += len; *lat = -val; return PGL_SCAN_LAT;
jbe@0 1413 }
jbe@0 1414 if (
jbe@0 1415 sscanf(*str, " E %lf %n", &val, &len) ||
jbe@0 1416 sscanf(*str, " e %lf %n", &val, &len)
jbe@0 1417 ) {
jbe@0 1418 *str += len; *lon = val; return PGL_SCAN_LON;
jbe@0 1419 }
jbe@0 1420 if (
jbe@0 1421 sscanf(*str, " W %lf %n", &val, &len) ||
jbe@0 1422 sscanf(*str, " w %lf %n", &val, &len)
jbe@0 1423 ) {
jbe@0 1424 *str += len; *lon = -val; return PGL_SCAN_LON;
jbe@0 1425 }
jbe@0 1426 return PGL_SCAN_NONE;
jbe@0 1427 }
jbe@0 1428
jbe@0 1429
jbe@0 1430 /*-----------------*
jbe@0 1431 * SQL functions *
jbe@0 1432 *-----------------*/
jbe@0 1433
jbe@0 1434 /* Note: These function names use "epoint", "ebox", etc. notation here instead
jbe@0 1435 of "point", "box", etc. in order to distinguish them from any previously
jbe@0 1436 defined functions. */
jbe@0 1437
jbe@0 1438 /* function needed for dummy types and/or not implemented features */
jbe@0 1439 PG_FUNCTION_INFO_V1(pgl_notimpl);
jbe@0 1440 Datum pgl_notimpl(PG_FUNCTION_ARGS) {
jbe@0 1441 ereport(ERROR, (errmsg("not implemented by pgLatLon")));
jbe@0 1442 }
jbe@0 1443
jbe@0 1444 /* set point to latitude and longitude (including checks) */
jbe@0 1445 static void pgl_epoint_set_latlon(pgl_point *point, double lat, double lon) {
jbe@0 1446 /* reject infinite or NaN values */
jbe@0 1447 if (!isfinite(lat) || !isfinite(lon)) {
jbe@0 1448 ereport(ERROR, (
jbe@0 1449 errcode(ERRCODE_DATA_EXCEPTION),
jbe@0 1450 errmsg("epoint requires finite coordinates")
jbe@0 1451 ));
jbe@0 1452 }
jbe@0 1453 /* check latitude bounds */
jbe@0 1454 if (lat < -90) {
jbe@0 1455 ereport(WARNING, (errmsg("latitude exceeds south pole")));
jbe@0 1456 lat = -90;
jbe@0 1457 } else if (lat > 90) {
jbe@0 1458 ereport(WARNING, (errmsg("latitude exceeds north pole")));
jbe@0 1459 lat = 90;
jbe@0 1460 }
jbe@0 1461 /* check longitude bounds */
jbe@0 1462 if (lon < -180) {
jbe@0 1463 ereport(NOTICE, (errmsg("longitude west of 180th meridian normalized")));
jbe@0 1464 lon += 360 - trunc(lon / 360) * 360;
jbe@0 1465 } else if (lon > 180) {
jbe@0 1466 ereport(NOTICE, (errmsg("longitude east of 180th meridian normalized")));
jbe@0 1467 lon -= 360 + trunc(lon / 360) * 360;
jbe@0 1468 }
jbe@0 1469 /* store rounded latitude/longitude values for round-trip safety */
jbe@0 1470 point->lat = pgl_round(lat);
jbe@0 1471 point->lon = pgl_round(lon);
jbe@0 1472 }
jbe@0 1473
jbe@0 1474 /* create point ("epoint" in SQL) from latitude and longitude */
jbe@0 1475 PG_FUNCTION_INFO_V1(pgl_create_epoint);
jbe@0 1476 Datum pgl_create_epoint(PG_FUNCTION_ARGS) {
jbe@0 1477 pgl_point *point = (pgl_point *)palloc(sizeof(pgl_point));
jbe@0 1478 pgl_epoint_set_latlon(point, PG_GETARG_FLOAT8(0), PG_GETARG_FLOAT8(1));
jbe@0 1479 PG_RETURN_POINTER(point);
jbe@0 1480 }
jbe@0 1481
jbe@0 1482 /* parse point ("epoint" in SQL) */
jbe@0 1483 /* format: '[NS]<float> [EW]<float>' */
jbe@0 1484 PG_FUNCTION_INFO_V1(pgl_epoint_in);
jbe@0 1485 Datum pgl_epoint_in(PG_FUNCTION_ARGS) {
jbe@0 1486 char *str = PG_GETARG_CSTRING(0); /* input string */
jbe@0 1487 char *strptr = str; /* current position within string */
jbe@0 1488 int done = 0; /* bit mask storing if latitude or longitude was read */
jbe@0 1489 double lat, lon; /* parsed values as double precision floats */
jbe@0 1490 pgl_point *point; /* return value (to be palloc'ed) */
jbe@0 1491 /* parse two floats (each latitude or longitude) separated by white-space */
jbe@0 1492 done |= pgl_scan(&strptr, &lat, &lon);
jbe@0 1493 if (strptr != str && isspace(strptr[-1])) {
jbe@0 1494 done |= pgl_scan(&strptr, &lat, &lon);
jbe@0 1495 }
jbe@0 1496 /* require end of string, and latitude and longitude parsed successfully */
jbe@0 1497 if (strptr[0] || done != PGL_SCAN_LATLON) {
jbe@0 1498 ereport(ERROR, (
jbe@0 1499 errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
jbe@0 1500 errmsg("invalid input syntax for type epoint: \"%s\"", str)
jbe@0 1501 ));
jbe@0 1502 }
jbe@0 1503 /* allocate memory for result */
jbe@0 1504 point = (pgl_point *)palloc(sizeof(pgl_point));
jbe@0 1505 /* set latitude and longitude (and perform checks) */
jbe@0 1506 pgl_epoint_set_latlon(point, lat, lon);
jbe@0 1507 /* return result */
jbe@0 1508 PG_RETURN_POINTER(point);
jbe@0 1509 }
jbe@0 1510
jbe@0 1511 /* create box ("ebox" in SQL) that is empty */
jbe@0 1512 PG_FUNCTION_INFO_V1(pgl_create_empty_ebox);
jbe@0 1513 Datum pgl_create_empty_ebox(PG_FUNCTION_ARGS) {
jbe@0 1514 pgl_box *box = (pgl_box *)palloc(sizeof(pgl_box));
jbe@0 1515 pgl_box_set_empty(box);
jbe@0 1516 PG_RETURN_POINTER(box);
jbe@0 1517 }
jbe@0 1518
jbe@0 1519 /* set box to given boundaries (including checks) */
jbe@0 1520 static void pgl_ebox_set_boundaries(
jbe@0 1521 pgl_box *box,
jbe@0 1522 double lat_min, double lat_max, double lon_min, double lon_max
jbe@0 1523 ) {
jbe@0 1524 /* if minimum latitude is greater than maximum latitude, return empty box */
jbe@0 1525 if (lat_min > lat_max) {
jbe@0 1526 pgl_box_set_empty(box);
jbe@0 1527 return;
jbe@0 1528 }
jbe@0 1529 /* otherwise reject infinite or NaN values */
jbe@0 1530 if (
jbe@0 1531 !isfinite(lat_min) || !isfinite(lat_max) ||
jbe@0 1532 !isfinite(lon_min) || !isfinite(lon_max)
jbe@0 1533 ) {
jbe@0 1534 ereport(ERROR, (
jbe@0 1535 errcode(ERRCODE_DATA_EXCEPTION),
jbe@0 1536 errmsg("ebox requires finite coordinates")
jbe@0 1537 ));
jbe@0 1538 }
jbe@0 1539 /* check latitude bounds */
jbe@0 1540 if (lat_max < -90) {
jbe@0 1541 ereport(WARNING, (errmsg("northern latitude exceeds south pole")));
jbe@0 1542 lat_max = -90;
jbe@0 1543 } else if (lat_max > 90) {
jbe@0 1544 ereport(WARNING, (errmsg("northern latitude exceeds north pole")));
jbe@0 1545 lat_max = 90;
jbe@0 1546 }
jbe@0 1547 if (lat_min < -90) {
jbe@0 1548 ereport(WARNING, (errmsg("southern latitude exceeds south pole")));
jbe@0 1549 lat_min = -90;
jbe@0 1550 } else if (lat_min > 90) {
jbe@0 1551 ereport(WARNING, (errmsg("southern latitude exceeds north pole")));
jbe@0 1552 lat_min = 90;
jbe@0 1553 }
jbe@0 1554 /* check if all longitudes are included */
jbe@0 1555 if (lon_max - lon_min >= 360) {
jbe@0 1556 if (lon_max - lon_min > 360) ereport(WARNING, (
jbe@0 1557 errmsg("longitude coverage greater than 360 degrees")
jbe@0 1558 ));
jbe@0 1559 lon_min = -180;
jbe@0 1560 lon_max = 180;
jbe@0 1561 } else {
jbe@0 1562 /* normalize longitude bounds */
jbe@0 1563 if (lon_min < -180) lon_min += 360 - trunc(lon_min / 360) * 360;
jbe@0 1564 else if (lon_min > 180) lon_min -= 360 + trunc(lon_min / 360) * 360;
jbe@0 1565 if (lon_max < -180) lon_max += 360 - trunc(lon_max / 360) * 360;
jbe@0 1566 else if (lon_max > 180) lon_max -= 360 + trunc(lon_max / 360) * 360;
jbe@0 1567 }
jbe@0 1568 /* store rounded latitude/longitude values for round-trip safety */
jbe@0 1569 box->lat_min = pgl_round(lat_min);
jbe@0 1570 box->lat_max = pgl_round(lat_max);
jbe@0 1571 box->lon_min = pgl_round(lon_min);
jbe@0 1572 box->lon_max = pgl_round(lon_max);
jbe@0 1573 /* ensure that rounding does not change orientation */
jbe@0 1574 if (lon_min > lon_max && box->lon_min == box->lon_max) {
jbe@0 1575 box->lon_min = -180;
jbe@0 1576 box->lon_max = 180;
jbe@0 1577 }
jbe@0 1578 }
jbe@0 1579
jbe@0 1580 /* create box ("ebox" in SQL) from min/max latitude and min/max longitude */
jbe@0 1581 PG_FUNCTION_INFO_V1(pgl_create_ebox);
jbe@0 1582 Datum pgl_create_ebox(PG_FUNCTION_ARGS) {
jbe@0 1583 pgl_box *box = (pgl_box *)palloc(sizeof(pgl_box));
jbe@0 1584 pgl_ebox_set_boundaries(
jbe@0 1585 box,
jbe@0 1586 PG_GETARG_FLOAT8(0), PG_GETARG_FLOAT8(1),
jbe@0 1587 PG_GETARG_FLOAT8(2), PG_GETARG_FLOAT8(3)
jbe@0 1588 );
jbe@0 1589 PG_RETURN_POINTER(box);
jbe@0 1590 }
jbe@0 1591
jbe@0 1592 /* create box ("ebox" in SQL) from two points ("epoint"s) */
jbe@0 1593 /* (can not be used to cover a longitude range of more than 120 degrees) */
jbe@0 1594 PG_FUNCTION_INFO_V1(pgl_create_ebox_from_epoints);
jbe@0 1595 Datum pgl_create_ebox_from_epoints(PG_FUNCTION_ARGS) {
jbe@0 1596 pgl_point *point1 = (pgl_point *)PG_GETARG_POINTER(0);
jbe@0 1597 pgl_point *point2 = (pgl_point *)PG_GETARG_POINTER(1);
jbe@0 1598 pgl_box *box = (pgl_box *)palloc(sizeof(pgl_box));
jbe@0 1599 double lat_min, lat_max, lon_min, lon_max;
jbe@0 1600 double dlon; /* longitude range (delta longitude) */
jbe@0 1601 /* order latitude and longitude boundaries */
jbe@0 1602 if (point2->lat < point1->lat) {
jbe@0 1603 lat_min = point2->lat;
jbe@0 1604 lat_max = point1->lat;
jbe@0 1605 } else {
jbe@0 1606 lat_min = point1->lat;
jbe@0 1607 lat_max = point2->lat;
jbe@0 1608 }
jbe@0 1609 if (point2->lon < point1->lon) {
jbe@0 1610 lon_min = point2->lon;
jbe@0 1611 lon_max = point1->lon;
jbe@0 1612 } else {
jbe@0 1613 lon_min = point1->lon;
jbe@0 1614 lon_max = point2->lon;
jbe@0 1615 }
jbe@0 1616 /* calculate longitude range (round to avoid floating point errors) */
jbe@0 1617 dlon = pgl_round(lon_max - lon_min);
jbe@0 1618 /* determine east-west direction */
jbe@0 1619 if (dlon >= 240) {
jbe@0 1620 /* assume that 180th meridian is crossed and swap min/max longitude */
jbe@0 1621 double swap = lon_min; lon_min = lon_max; lon_max = swap;
jbe@0 1622 } else if (dlon > 120) {
jbe@0 1623 /* unclear orientation since delta longitude > 120 */
jbe@0 1624 ereport(ERROR, (
jbe@0 1625 errcode(ERRCODE_DATA_EXCEPTION),
jbe@0 1626 errmsg("can not determine east/west orientation for ebox")
jbe@0 1627 ));
jbe@0 1628 }
jbe@0 1629 /* use boundaries to setup box (and perform checks) */
jbe@0 1630 pgl_ebox_set_boundaries(box, lat_min, lat_max, lon_min, lon_max);
jbe@0 1631 /* return result */
jbe@0 1632 PG_RETURN_POINTER(box);
jbe@0 1633 }
jbe@0 1634
jbe@0 1635 /* parse box ("ebox" in SQL) */
jbe@0 1636 /* format: '[NS]<float> [EW]<float> [NS]<float> [EW]<float>'
jbe@0 1637 or: '[NS]<float> [NS]<float> [EW]<float> [EW]<float>' */
jbe@0 1638 PG_FUNCTION_INFO_V1(pgl_ebox_in);
jbe@0 1639 Datum pgl_ebox_in(PG_FUNCTION_ARGS) {
jbe@0 1640 char *str = PG_GETARG_CSTRING(0); /* input string */
jbe@0 1641 char *str_lower; /* lower case version of input string */
jbe@0 1642 char *strptr; /* current position within string */
jbe@0 1643 int valid; /* number of valid chars */
jbe@0 1644 int done; /* specifies if latitude or longitude was read */
jbe@0 1645 double val; /* temporary variable */
jbe@0 1646 int lat_count = 0; /* count of latitude values parsed */
jbe@0 1647 int lon_count = 0; /* count of longitufde values parsed */
jbe@0 1648 double lat_min, lat_max, lon_min, lon_max; /* see pgl_box struct */
jbe@0 1649 pgl_box *box; /* return value (to be palloc'ed) */
jbe@0 1650 /* lowercase input */
jbe@0 1651 str_lower = psprintf("%s", str);
jbe@0 1652 for (strptr=str_lower; *strptr; strptr++) {
jbe@0 1653 if (*strptr >= 'A' && *strptr <= 'Z') *strptr += 'a' - 'A';
jbe@0 1654 }
jbe@0 1655 /* reset reading position to start of (lowercase) string */
jbe@0 1656 strptr = str_lower;
jbe@0 1657 /* check if empty box */
jbe@0 1658 valid = 0;
jbe@0 1659 sscanf(strptr, " empty %n", &valid);
jbe@0 1660 if (valid && strptr[valid] == 0) {
jbe@0 1661 /* allocate and return empty box */
jbe@0 1662 box = (pgl_box *)palloc(sizeof(pgl_box));
jbe@0 1663 pgl_box_set_empty(box);
jbe@0 1664 PG_RETURN_POINTER(box);
jbe@0 1665 }
jbe@0 1666 /* demand four blocks separated by whitespace */
jbe@0 1667 valid = 0;
jbe@0 1668 sscanf(strptr, " %*s %*s %*s %*s %n", &valid);
jbe@0 1669 /* if four blocks separated by whitespace exist, parse those blocks */
jbe@0 1670 if (strptr[valid] == 0) while (strptr[0]) {
jbe@0 1671 /* parse either latitude or longitude (whichever found in input string) */
jbe@0 1672 done = pgl_scan(&strptr, &val, &val);
jbe@0 1673 /* store latitude or longitude in lat_min, lat_max, lon_min, or lon_max */
jbe@0 1674 if (done == PGL_SCAN_LAT) {
jbe@0 1675 if (!lat_count) lat_min = val; else lat_max = val;
jbe@0 1676 lat_count++;
jbe@0 1677 } else if (done == PGL_SCAN_LON) {
jbe@0 1678 if (!lon_count) lon_min = val; else lon_max = val;
jbe@0 1679 lon_count++;
jbe@0 1680 } else {
jbe@0 1681 break;
jbe@0 1682 }
jbe@0 1683 }
jbe@0 1684 /* require end of string, and two latitude and two longitude values */
jbe@0 1685 if (strptr[0] || lat_count != 2 || lon_count != 2) {
jbe@0 1686 ereport(ERROR, (
jbe@0 1687 errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
jbe@0 1688 errmsg("invalid input syntax for type ebox: \"%s\"", str)
jbe@0 1689 ));
jbe@0 1690 }
jbe@0 1691 /* free lower case string */
jbe@0 1692 pfree(str_lower);
jbe@0 1693 /* order boundaries (maximum greater than minimum) */
jbe@0 1694 if (lat_min > lat_max) { val = lat_min; lat_min = lat_max; lat_max = val; }
jbe@0 1695 if (lon_min > lon_max) { val = lon_min; lon_min = lon_max; lon_max = val; }
jbe@0 1696 /* allocate memory for result */
jbe@0 1697 box = (pgl_box *)palloc(sizeof(pgl_box));
jbe@0 1698 /* set boundaries (and perform checks) */
jbe@0 1699 pgl_ebox_set_boundaries(box, lat_min, lat_max, lon_min, lon_max);
jbe@0 1700 /* return result */
jbe@0 1701 PG_RETURN_POINTER(box);
jbe@0 1702 }
jbe@0 1703
jbe@0 1704 /* set circle to given latitude, longitude, and radius (including checks) */
jbe@0 1705 static void pgl_ecircle_set_latlon_radius(
jbe@0 1706 pgl_circle *circle, double lat, double lon, double radius
jbe@0 1707 ) {
jbe@0 1708 /* set center point (including checks) */
jbe@0 1709 pgl_epoint_set_latlon(&(circle->center), lat, lon);
jbe@0 1710 /* handle non-positive radius */
jbe@0 1711 if (isnan(radius)) {
jbe@0 1712 ereport(ERROR, (
jbe@0 1713 errcode(ERRCODE_DATA_EXCEPTION),
jbe@0 1714 errmsg("invalid radius for ecircle")
jbe@0 1715 ));
jbe@0 1716 }
jbe@0 1717 if (radius == 0) radius = 0; /* avoids -0 */
jbe@0 1718 else if (radius < 0) {
jbe@0 1719 if (isfinite(radius)) {
jbe@0 1720 ereport(NOTICE, (errmsg("negative radius converted to minus infinity")));
jbe@0 1721 }
jbe@0 1722 radius = -INFINITY;
jbe@0 1723 }
jbe@0 1724 /* store radius (round-trip safety is ensured by pgl_print_float) */
jbe@0 1725 circle->radius = radius;
jbe@0 1726 }
jbe@0 1727
jbe@0 1728 /* create circle ("ecircle" in SQL) from latitude, longitude, and radius */
jbe@0 1729 PG_FUNCTION_INFO_V1(pgl_create_ecircle);
jbe@0 1730 Datum pgl_create_ecircle(PG_FUNCTION_ARGS) {
jbe@0 1731 pgl_circle *circle = (pgl_circle *)palloc(sizeof(pgl_circle));
jbe@0 1732 pgl_ecircle_set_latlon_radius(
jbe@0 1733 circle, PG_GETARG_FLOAT8(0), PG_GETARG_FLOAT8(1), PG_GETARG_FLOAT8(2)
jbe@0 1734 );
jbe@0 1735 PG_RETURN_POINTER(circle);
jbe@0 1736 }
jbe@0 1737
jbe@0 1738 /* create circle ("ecircle" in SQL) from point ("epoint"), and radius */
jbe@0 1739 PG_FUNCTION_INFO_V1(pgl_create_ecircle_from_epoint);
jbe@0 1740 Datum pgl_create_ecircle_from_epoint(PG_FUNCTION_ARGS) {
jbe@0 1741 pgl_point *point = (pgl_point *)PG_GETARG_POINTER(0);
jbe@0 1742 double radius = PG_GETARG_FLOAT8(1);
jbe@0 1743 pgl_circle *circle = (pgl_circle *)palloc(sizeof(pgl_circle));
jbe@0 1744 /* set latitude, longitude, radius (and perform checks) */
jbe@0 1745 pgl_ecircle_set_latlon_radius(circle, point->lat, point->lon, radius);
jbe@0 1746 /* return result */
jbe@0 1747 PG_RETURN_POINTER(circle);
jbe@0 1748 }
jbe@0 1749
jbe@0 1750 /* parse circle ("ecircle" in SQL) */
jbe@0 1751 /* format: '[NS]<float> [EW]<float> <float>' */
jbe@0 1752 PG_FUNCTION_INFO_V1(pgl_ecircle_in);
jbe@0 1753 Datum pgl_ecircle_in(PG_FUNCTION_ARGS) {
jbe@0 1754 char *str = PG_GETARG_CSTRING(0); /* input string */
jbe@0 1755 char *strptr = str; /* current position within string */
jbe@0 1756 double lat, lon, radius; /* parsed values as double precision flaots */
jbe@0 1757 int valid = 0; /* number of valid chars */
jbe@0 1758 int done = 0; /* stores if latitude and/or longitude was read */
jbe@0 1759 pgl_circle *circle; /* return value (to be palloc'ed) */
jbe@0 1760 /* demand three blocks separated by whitespace */
jbe@0 1761 sscanf(strptr, " %*s %*s %*s %n", &valid);
jbe@0 1762 /* if three blocks separated by whitespace exist, parse those blocks */
jbe@0 1763 if (strptr[valid] == 0) {
jbe@0 1764 /* parse latitude and longitude */
jbe@0 1765 done |= pgl_scan(&strptr, &lat, &lon);
jbe@0 1766 done |= pgl_scan(&strptr, &lat, &lon);
jbe@0 1767 /* parse radius (while incrementing strptr by number of bytes parsed) */
jbe@0 1768 valid = 0;
jbe@0 1769 if (sscanf(strptr, " %lf %n", &radius, &valid) == 1) strptr += valid;
jbe@0 1770 }
jbe@0 1771 /* require end of string and both latitude and longitude being parsed */
jbe@0 1772 if (strptr[0] || done != PGL_SCAN_LATLON) {
jbe@0 1773 ereport(ERROR, (
jbe@0 1774 errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
jbe@0 1775 errmsg("invalid input syntax for type ecircle: \"%s\"", str)
jbe@0 1776 ));
jbe@0 1777 }
jbe@0 1778 /* allocate memory for result */
jbe@0 1779 circle = (pgl_circle *)palloc(sizeof(pgl_circle));
jbe@0 1780 /* set latitude, longitude, radius (and perform checks) */
jbe@0 1781 pgl_ecircle_set_latlon_radius(circle, lat, lon, radius);
jbe@0 1782 /* return result */
jbe@0 1783 PG_RETURN_POINTER(circle);
jbe@0 1784 }
jbe@0 1785
jbe@0 1786 /* parse cluster ("ecluster" in SQL) */
jbe@0 1787 PG_FUNCTION_INFO_V1(pgl_ecluster_in);
jbe@0 1788 Datum pgl_ecluster_in(PG_FUNCTION_ARGS) {
jbe@0 1789 int i;
jbe@0 1790 char *str = PG_GETARG_CSTRING(0); /* input string */
jbe@0 1791 char *str_lower; /* lower case version of input string */
jbe@0 1792 char *strptr; /* pointer to current reading position of input */
jbe@0 1793 int npoints_total = 0; /* total number of points in cluster */
jbe@0 1794 int nentries = 0; /* total number of entries */
jbe@0 1795 pgl_newentry *entries; /* array of pgl_newentry to create pgl_cluster */
jbe@0 1796 int entries_buflen = 4; /* maximum number of elements in entries array */
jbe@0 1797 int valid; /* number of valid chars processed */
jbe@0 1798 double lat, lon; /* latitude and longitude of parsed point */
jbe@0 1799 int entrytype; /* current entry type */
jbe@0 1800 int npoints; /* number of points in current entry */
jbe@0 1801 pgl_point *points; /* array of pgl_point for pgl_newentry */
jbe@0 1802 int points_buflen; /* maximum number of elements in points array */
jbe@0 1803 int done; /* return value of pgl_scan function */
jbe@0 1804 pgl_cluster *cluster; /* created cluster */
jbe@0 1805 /* lowercase input */
jbe@0 1806 str_lower = psprintf("%s", str);
jbe@0 1807 for (strptr=str_lower; *strptr; strptr++) {
jbe@0 1808 if (*strptr >= 'A' && *strptr <= 'Z') *strptr += 'a' - 'A';
jbe@0 1809 }
jbe@0 1810 /* reset reading position to start of (lowercase) string */
jbe@0 1811 strptr = str_lower;
jbe@0 1812 /* allocate initial buffer for entries */
jbe@0 1813 entries = palloc(entries_buflen * sizeof(pgl_newentry));
jbe@0 1814 /* parse until end of string */
jbe@0 1815 while (strptr[0]) {
jbe@0 1816 /* require previous white-space or closing parenthesis before next token */
jbe@0 1817 if (strptr != str_lower && !isspace(strptr[-1]) && strptr[-1] != ')') {
jbe@0 1818 goto pgl_ecluster_in_error;
jbe@0 1819 }
jbe@0 1820 /* ignore token "empty" */
jbe@0 1821 valid = 0; sscanf(strptr, " empty %n", &valid);
jbe@0 1822 if (valid) { strptr += valid; continue; }
jbe@0 1823 /* test for "point" token */
jbe@0 1824 valid = 0; sscanf(strptr, " point ( %n", &valid);
jbe@0 1825 if (valid) {
jbe@0 1826 strptr += valid;
jbe@0 1827 entrytype = PGL_ENTRY_POINT;
jbe@0 1828 goto pgl_ecluster_in_type_ok;
jbe@0 1829 }
jbe@0 1830 /* test for "path" token */
jbe@0 1831 valid = 0; sscanf(strptr, " path ( %n", &valid);
jbe@0 1832 if (valid) {
jbe@0 1833 strptr += valid;
jbe@0 1834 entrytype = PGL_ENTRY_PATH;
jbe@0 1835 goto pgl_ecluster_in_type_ok;
jbe@0 1836 }
jbe@0 1837 /* test for "outline" token */
jbe@0 1838 valid = 0; sscanf(strptr, " outline ( %n", &valid);
jbe@0 1839 if (valid) {
jbe@0 1840 strptr += valid;
jbe@0 1841 entrytype = PGL_ENTRY_OUTLINE;
jbe@0 1842 goto pgl_ecluster_in_type_ok;
jbe@0 1843 }
jbe@0 1844 /* test for "polygon" token */
jbe@0 1845 valid = 0; sscanf(strptr, " polygon ( %n", &valid);
jbe@0 1846 if (valid) {
jbe@0 1847 strptr += valid;
jbe@0 1848 entrytype = PGL_ENTRY_POLYGON;
jbe@0 1849 goto pgl_ecluster_in_type_ok;
jbe@0 1850 }
jbe@0 1851 /* error if no valid token found */
jbe@0 1852 goto pgl_ecluster_in_error;
jbe@0 1853 pgl_ecluster_in_type_ok:
jbe@0 1854 /* check if pgl_newentry array needs to grow */
jbe@0 1855 if (nentries == entries_buflen) {
jbe@0 1856 pgl_newentry *newbuf;
jbe@0 1857 entries_buflen *= 2;
jbe@0 1858 newbuf = palloc(entries_buflen * sizeof(pgl_newentry));
jbe@0 1859 memcpy(newbuf, entries, nentries * sizeof(pgl_newentry));
jbe@0 1860 pfree(entries);
jbe@0 1861 entries = newbuf;
jbe@0 1862 }
jbe@0 1863 /* reset number of points for current entry */
jbe@0 1864 npoints = 0;
jbe@0 1865 /* allocate array for points */
jbe@0 1866 points_buflen = 4;
jbe@0 1867 points = palloc(points_buflen * sizeof(pgl_point));
jbe@0 1868 /* parse until closing parenthesis */
jbe@0 1869 while (strptr[0] != ')') {
jbe@0 1870 /* error on unexpected end of string */
jbe@0 1871 if (strptr[0] == 0) goto pgl_ecluster_in_error;
jbe@0 1872 /* mark neither latitude nor longitude as read */
jbe@0 1873 done = PGL_SCAN_NONE;
jbe@0 1874 /* require white-space before second, third, etc. point */
jbe@0 1875 if (npoints != 0 && !isspace(strptr[-1])) goto pgl_ecluster_in_error;
jbe@0 1876 /* scan latitude (or longitude) */
jbe@0 1877 done |= pgl_scan(&strptr, &lat, &lon);
jbe@0 1878 /* require white-space before second coordinate */
jbe@0 1879 if (strptr != str && !isspace(strptr[-1])) goto pgl_ecluster_in_error;
jbe@0 1880 /* scan longitude (or latitude) */
jbe@0 1881 done |= pgl_scan(&strptr, &lat, &lon);
jbe@0 1882 /* error unless both latitude and longitude were parsed */
jbe@0 1883 if (done != PGL_SCAN_LATLON) goto pgl_ecluster_in_error;
jbe@0 1884 /* throw error if number of points is too high */
jbe@0 1885 if (npoints_total == PGL_CLUSTER_MAXPOINTS) {
jbe@0 1886 ereport(ERROR, (
jbe@0 1887 errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
jbe@0 1888 errmsg(
jbe@0 1889 "too many points for ecluster entry (maximum %i)",
jbe@0 1890 PGL_CLUSTER_MAXPOINTS
jbe@0 1891 )
jbe@0 1892 ));
jbe@0 1893 }
jbe@0 1894 /* check if pgl_point array needs to grow */
jbe@0 1895 if (npoints == points_buflen) {
jbe@0 1896 pgl_point *newbuf;
jbe@0 1897 points_buflen *= 2;
jbe@0 1898 newbuf = palloc(points_buflen * sizeof(pgl_point));
jbe@0 1899 memcpy(newbuf, points, npoints * sizeof(pgl_point));
jbe@0 1900 pfree(points);
jbe@0 1901 points = newbuf;
jbe@0 1902 }
jbe@0 1903 /* append point to pgl_point array (includes checks) */
jbe@0 1904 pgl_epoint_set_latlon(&(points[npoints++]), lat, lon);
jbe@0 1905 /* increase total number of points */
jbe@0 1906 npoints_total++;
jbe@0 1907 }
jbe@0 1908 /* error if entry has no points */
jbe@0 1909 if (!npoints) goto pgl_ecluster_in_error;
jbe@0 1910 /* entries with one point are automatically of type "point" */
jbe@0 1911 if (npoints == 1) entrytype = PGL_ENTRY_POINT;
jbe@0 1912 /* if entries have more than one point */
jbe@0 1913 else {
jbe@0 1914 /* throw error if entry type is "point" */
jbe@0 1915 if (entrytype == PGL_ENTRY_POINT) {
jbe@0 1916 ereport(ERROR, (
jbe@0 1917 errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
jbe@0 1918 errmsg("invalid input syntax for type ecluster (point entry with more than one point)")
jbe@0 1919 ));
jbe@0 1920 }
jbe@0 1921 /* coerce outlines and polygons with more than 2 points to be a path */
jbe@0 1922 if (npoints == 2) entrytype = PGL_ENTRY_PATH;
jbe@0 1923 }
jbe@0 1924 /* append entry to pgl_newentry array */
jbe@0 1925 entries[nentries].entrytype = entrytype;
jbe@0 1926 entries[nentries].npoints = npoints;
jbe@0 1927 entries[nentries].points = points;
jbe@0 1928 nentries++;
jbe@0 1929 /* consume closing parenthesis */
jbe@0 1930 strptr++;
jbe@0 1931 /* consume white-space */
jbe@0 1932 while (isspace(strptr[0])) strptr++;
jbe@0 1933 }
jbe@0 1934 /* free lower case string */
jbe@0 1935 pfree(str_lower);
jbe@0 1936 /* create cluster from pgl_newentry array */
jbe@0 1937 cluster = pgl_new_cluster(nentries, entries);
jbe@0 1938 /* free pgl_newentry array */
jbe@0 1939 for (i=0; i<nentries; i++) pfree(entries[i].points);
jbe@0 1940 pfree(entries);
jbe@0 1941 /* set bounding circle of cluster and check east/west orientation */
jbe@0 1942 if (!pgl_finalize_cluster(cluster)) {
jbe@0 1943 ereport(ERROR, (
jbe@0 1944 errcode(ERRCODE_DATA_EXCEPTION),
jbe@0 1945 errmsg("can not determine east/west orientation for ecluster"),
jbe@0 1946 errhint("Ensure that each entry has a longitude span of less than 180 degrees.")
jbe@0 1947 ));
jbe@0 1948 }
jbe@0 1949 /* return cluster */
jbe@0 1950 PG_RETURN_POINTER(cluster);
jbe@0 1951 /* code to throw error */
jbe@0 1952 pgl_ecluster_in_error:
jbe@0 1953 ereport(ERROR, (
jbe@0 1954 errcode(ERRCODE_INVALID_TEXT_REPRESENTATION),
jbe@0 1955 errmsg("invalid input syntax for type ecluster: \"%s\"", str)
jbe@0 1956 ));
jbe@0 1957 }
jbe@0 1958
jbe@0 1959 /* convert point ("epoint") to string representation */
jbe@0 1960 PG_FUNCTION_INFO_V1(pgl_epoint_out);
jbe@0 1961 Datum pgl_epoint_out(PG_FUNCTION_ARGS) {
jbe@0 1962 pgl_point *point = (pgl_point *)PG_GETARG_POINTER(0);
jbe@0 1963 char latstr[PGL_NUMBUFLEN];
jbe@0 1964 char lonstr[PGL_NUMBUFLEN];
jbe@0 1965 pgl_print_lat(latstr, point->lat);
jbe@0 1966 pgl_print_lon(lonstr, point->lon);
jbe@0 1967 PG_RETURN_CSTRING(psprintf("%s %s", latstr, lonstr));
jbe@0 1968 }
jbe@0 1969
jbe@0 1970 /* convert box ("ebox") to string representation */
jbe@0 1971 PG_FUNCTION_INFO_V1(pgl_ebox_out);
jbe@0 1972 Datum pgl_ebox_out(PG_FUNCTION_ARGS) {
jbe@0 1973 pgl_box *box = (pgl_box *)PG_GETARG_POINTER(0);
jbe@0 1974 double lon_min = box->lon_min;
jbe@0 1975 double lon_max = box->lon_max;
jbe@0 1976 char lat_min_str[PGL_NUMBUFLEN];
jbe@0 1977 char lat_max_str[PGL_NUMBUFLEN];
jbe@0 1978 char lon_min_str[PGL_NUMBUFLEN];
jbe@0 1979 char lon_max_str[PGL_NUMBUFLEN];
jbe@0 1980 /* return string "empty" if box is set to be empty */
jbe@0 1981 if (box->lat_min > box->lat_max) PG_RETURN_CSTRING("empty");
jbe@0 1982 /* use boundaries exceeding W180 or E180 if 180th meridian is enclosed */
jbe@0 1983 /* (required since pgl_box_in orders the longitude boundaries) */
jbe@0 1984 if (lon_min > lon_max) {
jbe@0 1985 if (lon_min + lon_max >= 0) lon_min -= 360;
jbe@0 1986 else lon_max += 360;
jbe@0 1987 }
jbe@0 1988 /* format and return result */
jbe@0 1989 pgl_print_lat(lat_min_str, box->lat_min);
jbe@0 1990 pgl_print_lat(lat_max_str, box->lat_max);
jbe@0 1991 pgl_print_lon(lon_min_str, lon_min);
jbe@0 1992 pgl_print_lon(lon_max_str, lon_max);
jbe@0 1993 PG_RETURN_CSTRING(psprintf(
jbe@0 1994 "%s %s %s %s",
jbe@0 1995 lat_min_str, lon_min_str, lat_max_str, lon_max_str
jbe@0 1996 ));
jbe@0 1997 }
jbe@0 1998
jbe@0 1999 /* convert circle ("ecircle") to string representation */
jbe@0 2000 PG_FUNCTION_INFO_V1(pgl_ecircle_out);
jbe@0 2001 Datum pgl_ecircle_out(PG_FUNCTION_ARGS) {
jbe@0 2002 pgl_circle *circle = (pgl_circle *)PG_GETARG_POINTER(0);
jbe@0 2003 char latstr[PGL_NUMBUFLEN];
jbe@0 2004 char lonstr[PGL_NUMBUFLEN];
jbe@0 2005 char radstr[PGL_NUMBUFLEN];
jbe@0 2006 pgl_print_lat(latstr, circle->center.lat);
jbe@0 2007 pgl_print_lon(lonstr, circle->center.lon);
jbe@0 2008 pgl_print_float(radstr, circle->radius);
jbe@0 2009 PG_RETURN_CSTRING(psprintf("%s %s %s", latstr, lonstr, radstr));
jbe@0 2010 }
jbe@0 2011
jbe@0 2012 /* convert cluster ("ecluster") to string representation */
jbe@0 2013 PG_FUNCTION_INFO_V1(pgl_ecluster_out);
jbe@0 2014 Datum pgl_ecluster_out(PG_FUNCTION_ARGS) {
jbe@0 2015 pgl_cluster *cluster = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(0));
jbe@0 2016 char latstr[PGL_NUMBUFLEN]; /* string buffer for latitude */
jbe@0 2017 char lonstr[PGL_NUMBUFLEN]; /* string buffer for longitude */
jbe@0 2018 char ***strings; /* array of array of strings */
jbe@0 2019 char *string; /* string of current token */
jbe@0 2020 char *res, *resptr; /* result and pointer to current write position */
jbe@0 2021 size_t reslen = 1; /* length of result (init with 1 for terminator) */
jbe@0 2022 int npoints; /* number of points of current entry */
jbe@0 2023 int i, j; /* i: entry, j: point in entry */
jbe@0 2024 /* handle empty clusters */
jbe@0 2025 if (cluster->nentries == 0) {
jbe@0 2026 /* free detoasted cluster (if copy) */
jbe@0 2027 PG_FREE_IF_COPY(cluster, 0);
jbe@0 2028 /* return static result */
jbe@0 2029 PG_RETURN_CSTRING("empty");
jbe@0 2030 }
jbe@0 2031 /* allocate array of array of strings */
jbe@0 2032 strings = palloc(cluster->nentries * sizeof(char **));
jbe@0 2033 /* iterate over all entries in cluster */
jbe@0 2034 for (i=0; i<cluster->nentries; i++) {
jbe@0 2035 /* get number of points in entry */
jbe@0 2036 npoints = cluster->entries[i].npoints;
jbe@0 2037 /* allocate array of strings (one string for each point plus two extra) */
jbe@0 2038 strings[i] = palloc((2 + npoints) * sizeof(char *));
jbe@0 2039 /* determine opening string */
jbe@0 2040 switch (cluster->entries[i].entrytype) {
jbe@0 2041 case PGL_ENTRY_POINT: string = (i==0)?"point (" :" point ("; break;
jbe@0 2042 case PGL_ENTRY_PATH: string = (i==0)?"path (" :" path ("; break;
jbe@0 2043 case PGL_ENTRY_OUTLINE: string = (i==0)?"outline (":" outline ("; break;
jbe@0 2044 case PGL_ENTRY_POLYGON: string = (i==0)?"polygon (":" polygon ("; break;
jbe@0 2045 default: string = (i==0)?"unknown" :" unknown";
jbe@0 2046 }
jbe@0 2047 /* use opening string as first string in array */
jbe@0 2048 strings[i][0] = string;
jbe@0 2049 /* update result length (for allocating result string later) */
jbe@0 2050 reslen += strlen(string);
jbe@0 2051 /* iterate over all points */
jbe@0 2052 for (j=0; j<npoints; j++) {
jbe@0 2053 /* create string representation of point */
jbe@0 2054 pgl_print_lat(latstr, PGL_ENTRY_POINTS(cluster, i)[j].lat);
jbe@0 2055 pgl_print_lon(lonstr, PGL_ENTRY_POINTS(cluster, i)[j].lon);
jbe@0 2056 string = psprintf((j == 0) ? "%s %s" : " %s %s", latstr, lonstr);
jbe@0 2057 /* copy string pointer to string array */
jbe@0 2058 strings[i][j+1] = string;
jbe@0 2059 /* update result length (for allocating result string later) */
jbe@0 2060 reslen += strlen(string);
jbe@0 2061 }
jbe@0 2062 /* use closing parenthesis as last string in array */
jbe@0 2063 strings[i][npoints+1] = ")";
jbe@0 2064 /* update result length (for allocating result string later) */
jbe@0 2065 reslen++;
jbe@0 2066 }
jbe@0 2067 /* allocate result string */
jbe@0 2068 res = palloc(reslen);
jbe@0 2069 /* set write pointer to begin of result string */
jbe@0 2070 resptr = res;
jbe@0 2071 /* copy strings into result string */
jbe@0 2072 for (i=0; i<cluster->nentries; i++) {
jbe@0 2073 npoints = cluster->entries[i].npoints;
jbe@0 2074 for (j=0; j<npoints+2; j++) {
jbe@0 2075 string = strings[i][j];
jbe@0 2076 strcpy(resptr, string);
jbe@0 2077 resptr += strlen(string);
jbe@0 2078 /* free strings allocated by psprintf */
jbe@0 2079 if (j != 0 && j != npoints+1) pfree(string);
jbe@0 2080 }
jbe@0 2081 /* free array of strings */
jbe@0 2082 pfree(strings[i]);
jbe@0 2083 }
jbe@0 2084 /* free array of array of strings */
jbe@0 2085 pfree(strings);
jbe@0 2086 /* free detoasted cluster (if copy) */
jbe@0 2087 PG_FREE_IF_COPY(cluster, 0);
jbe@0 2088 /* return result */
jbe@0 2089 PG_RETURN_CSTRING(res);
jbe@0 2090 }
jbe@0 2091
jbe@0 2092 /* binary input function for point ("epoint") */
jbe@0 2093 PG_FUNCTION_INFO_V1(pgl_epoint_recv);
jbe@0 2094 Datum pgl_epoint_recv(PG_FUNCTION_ARGS) {
jbe@0 2095 StringInfo buf = (StringInfo)PG_GETARG_POINTER(0);
jbe@0 2096 pgl_point *point = (pgl_point *)palloc(sizeof(pgl_point));
jbe@0 2097 point->lat = pq_getmsgfloat8(buf);
jbe@0 2098 point->lon = pq_getmsgfloat8(buf);
jbe@0 2099 PG_RETURN_POINTER(point);
jbe@0 2100 }
jbe@0 2101
jbe@0 2102 /* binary input function for box ("ebox") */
jbe@0 2103 PG_FUNCTION_INFO_V1(pgl_ebox_recv);
jbe@0 2104 Datum pgl_ebox_recv(PG_FUNCTION_ARGS) {
jbe@0 2105 StringInfo buf = (StringInfo)PG_GETARG_POINTER(0);
jbe@0 2106 pgl_box *box = (pgl_box *)palloc(sizeof(pgl_box));
jbe@0 2107 box->lat_min = pq_getmsgfloat8(buf);
jbe@0 2108 box->lat_max = pq_getmsgfloat8(buf);
jbe@0 2109 box->lon_min = pq_getmsgfloat8(buf);
jbe@0 2110 box->lon_max = pq_getmsgfloat8(buf);
jbe@0 2111 PG_RETURN_POINTER(box);
jbe@0 2112 }
jbe@0 2113
jbe@0 2114 /* binary input function for circle ("ecircle") */
jbe@0 2115 PG_FUNCTION_INFO_V1(pgl_ecircle_recv);
jbe@0 2116 Datum pgl_ecircle_recv(PG_FUNCTION_ARGS) {
jbe@0 2117 StringInfo buf = (StringInfo)PG_GETARG_POINTER(0);
jbe@0 2118 pgl_circle *circle = (pgl_circle *)palloc(sizeof(pgl_circle));
jbe@0 2119 circle->center.lat = pq_getmsgfloat8(buf);
jbe@0 2120 circle->center.lon = pq_getmsgfloat8(buf);
jbe@0 2121 circle->radius = pq_getmsgfloat8(buf);
jbe@0 2122 PG_RETURN_POINTER(circle);
jbe@0 2123 }
jbe@0 2124
jbe@0 2125 /* TODO: binary receive function for cluster */
jbe@0 2126
jbe@0 2127 /* binary output function for point ("epoint") */
jbe@0 2128 PG_FUNCTION_INFO_V1(pgl_epoint_send);
jbe@0 2129 Datum pgl_epoint_send(PG_FUNCTION_ARGS) {
jbe@0 2130 pgl_point *point = (pgl_point *)PG_GETARG_POINTER(0);
jbe@0 2131 StringInfoData buf;
jbe@0 2132 pq_begintypsend(&buf);
jbe@0 2133 pq_sendfloat8(&buf, point->lat);
jbe@0 2134 pq_sendfloat8(&buf, point->lon);
jbe@0 2135 PG_RETURN_BYTEA_P(pq_endtypsend(&buf));
jbe@0 2136 }
jbe@0 2137
jbe@0 2138 /* binary output function for box ("ebox") */
jbe@0 2139 PG_FUNCTION_INFO_V1(pgl_ebox_send);
jbe@0 2140 Datum pgl_ebox_send(PG_FUNCTION_ARGS) {
jbe@0 2141 pgl_box *box = (pgl_box *)PG_GETARG_POINTER(0);
jbe@0 2142 StringInfoData buf;
jbe@0 2143 pq_begintypsend(&buf);
jbe@0 2144 pq_sendfloat8(&buf, box->lat_min);
jbe@0 2145 pq_sendfloat8(&buf, box->lat_max);
jbe@0 2146 pq_sendfloat8(&buf, box->lon_min);
jbe@0 2147 pq_sendfloat8(&buf, box->lon_max);
jbe@0 2148 PG_RETURN_BYTEA_P(pq_endtypsend(&buf));
jbe@0 2149 }
jbe@0 2150
jbe@0 2151 /* binary output function for circle ("ecircle") */
jbe@0 2152 PG_FUNCTION_INFO_V1(pgl_ecircle_send);
jbe@0 2153 Datum pgl_ecircle_send(PG_FUNCTION_ARGS) {
jbe@0 2154 pgl_circle *circle = (pgl_circle *)PG_GETARG_POINTER(0);
jbe@0 2155 StringInfoData buf;
jbe@0 2156 pq_begintypsend(&buf);
jbe@0 2157 pq_sendfloat8(&buf, circle->center.lat);
jbe@0 2158 pq_sendfloat8(&buf, circle->center.lon);
jbe@0 2159 pq_sendfloat8(&buf, circle->radius);
jbe@0 2160 PG_RETURN_BYTEA_P(pq_endtypsend(&buf));
jbe@0 2161 }
jbe@0 2162
jbe@0 2163 /* TODO: binary send functions for cluster */
jbe@0 2164
jbe@0 2165 /* cast point ("epoint") to box ("ebox") */
jbe@0 2166 PG_FUNCTION_INFO_V1(pgl_epoint_to_ebox);
jbe@0 2167 Datum pgl_epoint_to_ebox(PG_FUNCTION_ARGS) {
jbe@0 2168 pgl_point *point = (pgl_point *)PG_GETARG_POINTER(0);
jbe@0 2169 pgl_box *box = palloc(sizeof(pgl_box));
jbe@0 2170 box->lat_min = point->lat;
jbe@0 2171 box->lat_max = point->lat;
jbe@0 2172 box->lon_min = point->lon;
jbe@0 2173 box->lon_max = point->lon;
jbe@0 2174 PG_RETURN_POINTER(box);
jbe@0 2175 }
jbe@0 2176
jbe@0 2177 /* cast point ("epoint") to circle ("ecircle") */
jbe@0 2178 PG_FUNCTION_INFO_V1(pgl_epoint_to_ecircle);
jbe@0 2179 Datum pgl_epoint_to_ecircle(PG_FUNCTION_ARGS) {
jbe@0 2180 pgl_point *point = (pgl_point *)PG_GETARG_POINTER(0);
jbe@0 2181 pgl_circle *circle = palloc(sizeof(pgl_box));
jbe@0 2182 circle->center = *point;
jbe@0 2183 circle->radius = 0;
jbe@0 2184 PG_RETURN_POINTER(circle);
jbe@0 2185 }
jbe@0 2186
jbe@0 2187 /* cast point ("epoint") to cluster ("ecluster") */
jbe@0 2188 PG_FUNCTION_INFO_V1(pgl_epoint_to_ecluster);
jbe@0 2189 Datum pgl_epoint_to_ecluster(PG_FUNCTION_ARGS) {
jbe@0 2190 pgl_point *point = (pgl_point *)PG_GETARG_POINTER(0);
jbe@0 2191 pgl_newentry entry;
jbe@0 2192 entry.entrytype = PGL_ENTRY_POINT;
jbe@0 2193 entry.npoints = 1;
jbe@0 2194 entry.points = point;
jbe@0 2195 PG_RETURN_POINTER(pgl_new_cluster(1, &entry));
jbe@0 2196 }
jbe@0 2197
jbe@0 2198 /* cast box ("ebox") to cluster ("ecluster") */
jbe@0 2199 #define pgl_ebox_to_ecluster_macro(i, a, b) \
jbe@0 2200 entries[i].entrytype = PGL_ENTRY_POLYGON; \
jbe@0 2201 entries[i].npoints = 4; \
jbe@0 2202 entries[i].points = points[i]; \
jbe@0 2203 points[i][0].lat = box->lat_min; \
jbe@0 2204 points[i][0].lon = (a); \
jbe@0 2205 points[i][1].lat = box->lat_min; \
jbe@0 2206 points[i][1].lon = (b); \
jbe@0 2207 points[i][2].lat = box->lat_max; \
jbe@0 2208 points[i][2].lon = (b); \
jbe@0 2209 points[i][3].lat = box->lat_max; \
jbe@0 2210 points[i][3].lon = (a);
jbe@0 2211 PG_FUNCTION_INFO_V1(pgl_ebox_to_ecluster);
jbe@0 2212 Datum pgl_ebox_to_ecluster(PG_FUNCTION_ARGS) {
jbe@0 2213 pgl_box *box = (pgl_box *)PG_GETARG_POINTER(0);
jbe@0 2214 double lon, dlon;
jbe@0 2215 int nentries;
jbe@0 2216 pgl_newentry entries[3];
jbe@0 2217 pgl_point points[3][4];
jbe@0 2218 if (box->lat_min > box->lat_max) {
jbe@0 2219 nentries = 0;
jbe@0 2220 } else if (box->lon_min > box->lon_max) {
jbe@0 2221 if (box->lon_min < 0) {
jbe@0 2222 lon = pgl_round((box->lon_min + 180) / 2.0);
jbe@0 2223 nentries = 3;
jbe@0 2224 pgl_ebox_to_ecluster_macro(0, box->lon_min, lon);
jbe@0 2225 pgl_ebox_to_ecluster_macro(1, lon, 180);
jbe@0 2226 pgl_ebox_to_ecluster_macro(2, -180, box->lon_max);
jbe@0 2227 } else if (box->lon_max > 0) {
jbe@0 2228 lon = pgl_round((box->lon_max - 180) / 2.0);
jbe@0 2229 nentries = 3;
jbe@0 2230 pgl_ebox_to_ecluster_macro(0, box->lon_min, 180);
jbe@0 2231 pgl_ebox_to_ecluster_macro(1, -180, lon);
jbe@0 2232 pgl_ebox_to_ecluster_macro(2, lon, box->lon_max);
jbe@0 2233 } else {
jbe@0 2234 nentries = 2;
jbe@0 2235 pgl_ebox_to_ecluster_macro(0, box->lon_min, 180);
jbe@0 2236 pgl_ebox_to_ecluster_macro(1, -180, box->lon_max);
jbe@0 2237 }
jbe@0 2238 } else {
jbe@0 2239 dlon = pgl_round(box->lon_max - box->lon_min);
jbe@0 2240 if (dlon < 180) {
jbe@0 2241 nentries = 1;
jbe@0 2242 pgl_ebox_to_ecluster_macro(0, box->lon_min, box->lon_max);
jbe@0 2243 } else {
jbe@0 2244 lon = pgl_round((box->lon_min + box->lon_max) / 2.0);
jbe@0 2245 if (
jbe@0 2246 pgl_round(lon - box->lon_min) < 180 &&
jbe@0 2247 pgl_round(box->lon_max - lon) < 180
jbe@0 2248 ) {
jbe@0 2249 nentries = 2;
jbe@0 2250 pgl_ebox_to_ecluster_macro(0, box->lon_min, lon);
jbe@0 2251 pgl_ebox_to_ecluster_macro(1, lon, box->lon_max);
jbe@0 2252 } else {
jbe@0 2253 nentries = 3;
jbe@0 2254 pgl_ebox_to_ecluster_macro(0, box->lon_min, -60);
jbe@0 2255 pgl_ebox_to_ecluster_macro(1, -60, 60);
jbe@0 2256 pgl_ebox_to_ecluster_macro(2, 60, box->lon_max);
jbe@0 2257 }
jbe@0 2258 }
jbe@0 2259 }
jbe@0 2260 PG_RETURN_POINTER(pgl_new_cluster(nentries, entries));
jbe@0 2261 }
jbe@0 2262
jbe@0 2263 /* extract latitude from point ("epoint") */
jbe@0 2264 PG_FUNCTION_INFO_V1(pgl_epoint_lat);
jbe@0 2265 Datum pgl_epoint_lat(PG_FUNCTION_ARGS) {
jbe@0 2266 PG_RETURN_FLOAT8(((pgl_point *)PG_GETARG_POINTER(0))->lat);
jbe@0 2267 }
jbe@0 2268
jbe@0 2269 /* extract longitude from point ("epoint") */
jbe@0 2270 PG_FUNCTION_INFO_V1(pgl_epoint_lon);
jbe@0 2271 Datum pgl_epoint_lon(PG_FUNCTION_ARGS) {
jbe@0 2272 PG_RETURN_FLOAT8(((pgl_point *)PG_GETARG_POINTER(0))->lon);
jbe@0 2273 }
jbe@0 2274
jbe@0 2275 /* extract minimum latitude from box ("ebox") */
jbe@0 2276 PG_FUNCTION_INFO_V1(pgl_ebox_lat_min);
jbe@0 2277 Datum pgl_ebox_lat_min(PG_FUNCTION_ARGS) {
jbe@0 2278 PG_RETURN_FLOAT8(((pgl_box *)PG_GETARG_POINTER(0))->lat_min);
jbe@0 2279 }
jbe@0 2280
jbe@0 2281 /* extract maximum latitude from box ("ebox") */
jbe@0 2282 PG_FUNCTION_INFO_V1(pgl_ebox_lat_max);
jbe@0 2283 Datum pgl_ebox_lat_max(PG_FUNCTION_ARGS) {
jbe@0 2284 PG_RETURN_FLOAT8(((pgl_box *)PG_GETARG_POINTER(0))->lat_max);
jbe@0 2285 }
jbe@0 2286
jbe@0 2287 /* extract minimum longitude from box ("ebox") */
jbe@0 2288 PG_FUNCTION_INFO_V1(pgl_ebox_lon_min);
jbe@0 2289 Datum pgl_ebox_lon_min(PG_FUNCTION_ARGS) {
jbe@0 2290 PG_RETURN_FLOAT8(((pgl_box *)PG_GETARG_POINTER(0))->lon_min);
jbe@0 2291 }
jbe@0 2292
jbe@0 2293 /* extract maximum longitude from box ("ebox") */
jbe@0 2294 PG_FUNCTION_INFO_V1(pgl_ebox_lon_max);
jbe@0 2295 Datum pgl_ebox_lon_max(PG_FUNCTION_ARGS) {
jbe@0 2296 PG_RETURN_FLOAT8(((pgl_box *)PG_GETARG_POINTER(0))->lon_max);
jbe@0 2297 }
jbe@0 2298
jbe@0 2299 /* extract center point from circle ("ecircle") */
jbe@0 2300 PG_FUNCTION_INFO_V1(pgl_ecircle_center);
jbe@0 2301 Datum pgl_ecircle_center(PG_FUNCTION_ARGS) {
jbe@0 2302 PG_RETURN_POINTER(&(((pgl_circle *)PG_GETARG_POINTER(0))->center));
jbe@0 2303 }
jbe@0 2304
jbe@0 2305 /* extract radius from circle ("ecircle") */
jbe@0 2306 PG_FUNCTION_INFO_V1(pgl_ecircle_radius);
jbe@0 2307 Datum pgl_ecircle_radius(PG_FUNCTION_ARGS) {
jbe@0 2308 PG_RETURN_FLOAT8(((pgl_circle *)PG_GETARG_POINTER(0))->radius);
jbe@0 2309 }
jbe@0 2310
jbe@0 2311 /* check if point is inside box (overlap operator "&&") in SQL */
jbe@0 2312 PG_FUNCTION_INFO_V1(pgl_epoint_ebox_overlap);
jbe@0 2313 Datum pgl_epoint_ebox_overlap(PG_FUNCTION_ARGS) {
jbe@0 2314 pgl_point *point = (pgl_point *)PG_GETARG_POINTER(0);
jbe@0 2315 pgl_box *box = (pgl_box *)PG_GETARG_POINTER(1);
jbe@0 2316 PG_RETURN_BOOL(pgl_point_in_box(point, box));
jbe@0 2317 }
jbe@0 2318
jbe@0 2319 /* check if point is inside circle (overlap operator "&&") in SQL */
jbe@0 2320 PG_FUNCTION_INFO_V1(pgl_epoint_ecircle_overlap);
jbe@0 2321 Datum pgl_epoint_ecircle_overlap(PG_FUNCTION_ARGS) {
jbe@0 2322 pgl_point *point = (pgl_point *)PG_GETARG_POINTER(0);
jbe@0 2323 pgl_circle *circle = (pgl_circle *)PG_GETARG_POINTER(1);
jbe@0 2324 PG_RETURN_BOOL(
jbe@0 2325 pgl_distance(
jbe@0 2326 point->lat, point->lon,
jbe@0 2327 circle->center.lat, circle->center.lon
jbe@0 2328 ) <= circle->radius
jbe@0 2329 );
jbe@0 2330 }
jbe@0 2331
jbe@0 2332 /* check if point is inside cluster (overlap operator "&&") in SQL */
jbe@0 2333 PG_FUNCTION_INFO_V1(pgl_epoint_ecluster_overlap);
jbe@0 2334 Datum pgl_epoint_ecluster_overlap(PG_FUNCTION_ARGS) {
jbe@0 2335 pgl_point *point = (pgl_point *)PG_GETARG_POINTER(0);
jbe@0 2336 pgl_cluster *cluster = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(1));
jbe@16 2337 bool retval;
jbe@16 2338 /* points outside bounding circle are always assumed to be non-overlapping
jbe@16 2339 (necessary for consistent table and index scans) */
jbe@16 2340 if (
jbe@16 2341 pgl_distance(
jbe@16 2342 point->lat, point->lon,
jbe@16 2343 cluster->bounding.center.lat, cluster->bounding.center.lon
jbe@16 2344 ) > cluster->bounding.radius
jbe@16 2345 ) retval = false;
jbe@16 2346 else retval = pgl_point_in_cluster(point, cluster);
jbe@0 2347 PG_FREE_IF_COPY(cluster, 1);
jbe@0 2348 PG_RETURN_BOOL(retval);
jbe@0 2349 }
jbe@0 2350
jbe@10 2351 /* check if point may be inside cluster (lossy overl. operator "&&+") in SQL */
jbe@10 2352 PG_FUNCTION_INFO_V1(pgl_epoint_ecluster_may_overlap);
jbe@10 2353 Datum pgl_epoint_ecluster_may_overlap(PG_FUNCTION_ARGS) {
jbe@10 2354 pgl_point *point = (pgl_point *)PG_GETARG_POINTER(0);
jbe@10 2355 pgl_cluster *cluster = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(1));
jbe@10 2356 bool retval = pgl_distance(
jbe@10 2357 point->lat, point->lon,
jbe@10 2358 cluster->bounding.center.lat, cluster->bounding.center.lon
jbe@10 2359 ) <= cluster->bounding.radius;
jbe@10 2360 PG_FREE_IF_COPY(cluster, 1);
jbe@10 2361 PG_RETURN_BOOL(retval);
jbe@10 2362 }
jbe@10 2363
jbe@0 2364 /* check if two boxes overlap (overlap operator "&&") in SQL */
jbe@0 2365 PG_FUNCTION_INFO_V1(pgl_ebox_overlap);
jbe@0 2366 Datum pgl_ebox_overlap(PG_FUNCTION_ARGS) {
jbe@0 2367 pgl_box *box1 = (pgl_box *)PG_GETARG_POINTER(0);
jbe@0 2368 pgl_box *box2 = (pgl_box *)PG_GETARG_POINTER(1);
jbe@0 2369 PG_RETURN_BOOL(pgl_boxes_overlap(box1, box2));
jbe@0 2370 }
jbe@0 2371
jbe@10 2372 /* check if box and circle may overlap (lossy overl. operator "&&+") in SQL */
jbe@10 2373 PG_FUNCTION_INFO_V1(pgl_ebox_ecircle_may_overlap);
jbe@10 2374 Datum pgl_ebox_ecircle_may_overlap(PG_FUNCTION_ARGS) {
jbe@10 2375 pgl_box *box = (pgl_box *)PG_GETARG_POINTER(0);
jbe@10 2376 pgl_circle *circle = (pgl_circle *)PG_GETARG_POINTER(1);
jbe@10 2377 PG_RETURN_BOOL(
jbe@10 2378 pgl_estimate_point_box_distance(&circle->center, box) <= circle->radius
jbe@10 2379 );
jbe@10 2380 }
jbe@10 2381
jbe@10 2382 /* check if box and cluster may overlap (lossy overl. operator "&&+") in SQL */
jbe@10 2383 PG_FUNCTION_INFO_V1(pgl_ebox_ecluster_may_overlap);
jbe@10 2384 Datum pgl_ebox_ecluster_may_overlap(PG_FUNCTION_ARGS) {
jbe@10 2385 pgl_box *box = (pgl_box *)PG_GETARG_POINTER(0);
jbe@10 2386 pgl_cluster *cluster = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(1));
jbe@10 2387 bool retval = pgl_estimate_point_box_distance(
jbe@10 2388 &cluster->bounding.center,
jbe@10 2389 box
jbe@10 2390 ) <= cluster->bounding.radius;
jbe@10 2391 PG_FREE_IF_COPY(cluster, 1);
jbe@10 2392 PG_RETURN_BOOL(retval);
jbe@10 2393 }
jbe@10 2394
jbe@0 2395 /* check if two circles overlap (overlap operator "&&") in SQL */
jbe@0 2396 PG_FUNCTION_INFO_V1(pgl_ecircle_overlap);
jbe@0 2397 Datum pgl_ecircle_overlap(PG_FUNCTION_ARGS) {
jbe@0 2398 pgl_circle *circle1 = (pgl_circle *)PG_GETARG_POINTER(0);
jbe@0 2399 pgl_circle *circle2 = (pgl_circle *)PG_GETARG_POINTER(1);
jbe@0 2400 PG_RETURN_BOOL(
jbe@0 2401 pgl_distance(
jbe@0 2402 circle1->center.lat, circle1->center.lon,
jbe@0 2403 circle2->center.lat, circle2->center.lon
jbe@0 2404 ) <= circle1->radius + circle2->radius
jbe@0 2405 );
jbe@0 2406 }
jbe@0 2407
jbe@0 2408 /* check if circle and cluster overlap (overlap operator "&&") in SQL */
jbe@0 2409 PG_FUNCTION_INFO_V1(pgl_ecircle_ecluster_overlap);
jbe@0 2410 Datum pgl_ecircle_ecluster_overlap(PG_FUNCTION_ARGS) {
jbe@0 2411 pgl_circle *circle = (pgl_circle *)PG_GETARG_POINTER(0);
jbe@0 2412 pgl_cluster *cluster = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(1));
jbe@0 2413 bool retval = (
jbe@0 2414 pgl_point_cluster_distance(&(circle->center), cluster) <= circle->radius
jbe@0 2415 );
jbe@0 2416 PG_FREE_IF_COPY(cluster, 1);
jbe@0 2417 PG_RETURN_BOOL(retval);
jbe@0 2418 }
jbe@0 2419
jbe@17 2420 /* check if circle and cluster may overlap (l. ov. operator "&&+") in SQL */
jbe@10 2421 PG_FUNCTION_INFO_V1(pgl_ecircle_ecluster_may_overlap);
jbe@10 2422 Datum pgl_ecircle_ecluster_may_overlap(PG_FUNCTION_ARGS) {
jbe@10 2423 pgl_circle *circle = (pgl_circle *)PG_GETARG_POINTER(0);
jbe@10 2424 pgl_cluster *cluster = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(1));
jbe@10 2425 bool retval = pgl_distance(
jbe@10 2426 circle->center.lat, circle->center.lon,
jbe@10 2427 cluster->bounding.center.lat, cluster->bounding.center.lon
jbe@10 2428 ) <= circle->radius + cluster->bounding.radius;
jbe@10 2429 PG_FREE_IF_COPY(cluster, 1);
jbe@10 2430 PG_RETURN_BOOL(retval);
jbe@10 2431 }
jbe@10 2432
jbe@16 2433 /* check if two clusters overlap (overlap operator "&&") in SQL */
jbe@16 2434 PG_FUNCTION_INFO_V1(pgl_ecluster_overlap);
jbe@16 2435 Datum pgl_ecluster_overlap(PG_FUNCTION_ARGS) {
jbe@16 2436 pgl_cluster *cluster1 = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(0));
jbe@16 2437 pgl_cluster *cluster2 = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(1));
jbe@16 2438 bool retval;
jbe@16 2439 /* clusters with non-touching bounding circles are always assumed to be
jbe@16 2440 non-overlapping (improves performance and is necessary for consistent
jbe@16 2441 table and index scans) */
jbe@16 2442 if (
jbe@16 2443 pgl_distance(
jbe@16 2444 cluster1->bounding.center.lat, cluster1->bounding.center.lon,
jbe@16 2445 cluster2->bounding.center.lat, cluster2->bounding.center.lon
jbe@16 2446 ) > cluster1->bounding.radius + cluster2->bounding.radius
jbe@16 2447 ) retval = false;
jbe@16 2448 else retval = pgl_clusters_overlap(cluster1, cluster2);
jbe@16 2449 PG_FREE_IF_COPY(cluster1, 0);
jbe@16 2450 PG_FREE_IF_COPY(cluster2, 1);
jbe@16 2451 PG_RETURN_BOOL(retval);
jbe@16 2452 }
jbe@16 2453
jbe@10 2454 /* check if two clusters may overlap (lossy overlap operator "&&+") in SQL */
jbe@10 2455 PG_FUNCTION_INFO_V1(pgl_ecluster_may_overlap);
jbe@10 2456 Datum pgl_ecluster_may_overlap(PG_FUNCTION_ARGS) {
jbe@10 2457 pgl_cluster *cluster1 = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(0));
jbe@10 2458 pgl_cluster *cluster2 = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(1));
jbe@10 2459 bool retval = pgl_distance(
jbe@10 2460 cluster1->bounding.center.lat, cluster1->bounding.center.lon,
jbe@10 2461 cluster2->bounding.center.lat, cluster2->bounding.center.lon
jbe@10 2462 ) <= cluster1->bounding.radius + cluster2->bounding.radius;
jbe@10 2463 PG_FREE_IF_COPY(cluster1, 0);
jbe@10 2464 PG_FREE_IF_COPY(cluster2, 1);
jbe@10 2465 PG_RETURN_BOOL(retval);
jbe@10 2466 }
jbe@10 2467
jbe@16 2468 /* check if second cluster is in first cluster (cont. operator "@>) in SQL */
jbe@16 2469 PG_FUNCTION_INFO_V1(pgl_ecluster_contains);
jbe@16 2470 Datum pgl_ecluster_contains(PG_FUNCTION_ARGS) {
jbe@16 2471 pgl_cluster *outer = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(0));
jbe@16 2472 pgl_cluster *inner = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(1));
jbe@16 2473 bool retval;
jbe@16 2474 /* clusters with non-touching bounding circles are always assumed to be
jbe@16 2475 non-overlapping (improves performance and is necessary for consistent
jbe@16 2476 table and index scans) */
jbe@16 2477 if (
jbe@16 2478 pgl_distance(
jbe@16 2479 outer->bounding.center.lat, outer->bounding.center.lon,
jbe@16 2480 inner->bounding.center.lat, inner->bounding.center.lon
jbe@16 2481 ) > outer->bounding.radius + inner->bounding.radius
jbe@16 2482 ) retval = false;
jbe@16 2483 else retval = pgl_cluster_in_cluster(outer, inner);
jbe@16 2484 PG_FREE_IF_COPY(outer, 0);
jbe@16 2485 PG_FREE_IF_COPY(inner, 1);
jbe@16 2486 PG_RETURN_BOOL(retval);
jbe@16 2487 }
jbe@16 2488
jbe@0 2489 /* calculate distance between two points ("<->" operator) in SQL */
jbe@0 2490 PG_FUNCTION_INFO_V1(pgl_epoint_distance);
jbe@0 2491 Datum pgl_epoint_distance(PG_FUNCTION_ARGS) {
jbe@0 2492 pgl_point *point1 = (pgl_point *)PG_GETARG_POINTER(0);
jbe@0 2493 pgl_point *point2 = (pgl_point *)PG_GETARG_POINTER(1);
jbe@0 2494 PG_RETURN_FLOAT8(pgl_distance(
jbe@0 2495 point1->lat, point1->lon, point2->lat, point2->lon
jbe@0 2496 ));
jbe@0 2497 }
jbe@0 2498
jbe@0 2499 /* calculate point to circle distance ("<->" operator) in SQL */
jbe@0 2500 PG_FUNCTION_INFO_V1(pgl_epoint_ecircle_distance);
jbe@0 2501 Datum pgl_epoint_ecircle_distance(PG_FUNCTION_ARGS) {
jbe@0 2502 pgl_point *point = (pgl_point *)PG_GETARG_POINTER(0);
jbe@0 2503 pgl_circle *circle = (pgl_circle *)PG_GETARG_POINTER(1);
jbe@0 2504 double distance = pgl_distance(
jbe@0 2505 point->lat, point->lon, circle->center.lat, circle->center.lon
jbe@0 2506 ) - circle->radius;
jbe@0 2507 PG_RETURN_FLOAT8((distance <= 0) ? 0 : distance);
jbe@0 2508 }
jbe@0 2509
jbe@0 2510 /* calculate point to cluster distance ("<->" operator) in SQL */
jbe@0 2511 PG_FUNCTION_INFO_V1(pgl_epoint_ecluster_distance);
jbe@0 2512 Datum pgl_epoint_ecluster_distance(PG_FUNCTION_ARGS) {
jbe@0 2513 pgl_point *point = (pgl_point *)PG_GETARG_POINTER(0);
jbe@0 2514 pgl_cluster *cluster = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(1));
jbe@0 2515 double distance = pgl_point_cluster_distance(point, cluster);
jbe@0 2516 PG_FREE_IF_COPY(cluster, 1);
jbe@0 2517 PG_RETURN_FLOAT8(distance);
jbe@0 2518 }
jbe@0 2519
jbe@0 2520 /* calculate distance between two circles ("<->" operator) in SQL */
jbe@0 2521 PG_FUNCTION_INFO_V1(pgl_ecircle_distance);
jbe@0 2522 Datum pgl_ecircle_distance(PG_FUNCTION_ARGS) {
jbe@0 2523 pgl_circle *circle1 = (pgl_circle *)PG_GETARG_POINTER(0);
jbe@0 2524 pgl_circle *circle2 = (pgl_circle *)PG_GETARG_POINTER(1);
jbe@0 2525 double distance = pgl_distance(
jbe@0 2526 circle1->center.lat, circle1->center.lon,
jbe@0 2527 circle2->center.lat, circle2->center.lon
jbe@0 2528 ) - (circle1->radius + circle2->radius);
jbe@0 2529 PG_RETURN_FLOAT8((distance <= 0) ? 0 : distance);
jbe@0 2530 }
jbe@0 2531
jbe@0 2532 /* calculate circle to cluster distance ("<->" operator) in SQL */
jbe@0 2533 PG_FUNCTION_INFO_V1(pgl_ecircle_ecluster_distance);
jbe@0 2534 Datum pgl_ecircle_ecluster_distance(PG_FUNCTION_ARGS) {
jbe@0 2535 pgl_circle *circle = (pgl_circle *)PG_GETARG_POINTER(0);
jbe@0 2536 pgl_cluster *cluster = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(1));
jbe@0 2537 double distance = (
jbe@0 2538 pgl_point_cluster_distance(&(circle->center), cluster) - circle->radius
jbe@0 2539 );
jbe@0 2540 PG_FREE_IF_COPY(cluster, 1);
jbe@0 2541 PG_RETURN_FLOAT8((distance <= 0) ? 0 : distance);
jbe@0 2542 }
jbe@0 2543
jbe@16 2544 /* calculate distance between two clusters ("<->" operator) in SQL */
jbe@16 2545 PG_FUNCTION_INFO_V1(pgl_ecluster_distance);
jbe@16 2546 Datum pgl_ecluster_distance(PG_FUNCTION_ARGS) {
jbe@16 2547 pgl_cluster *cluster1 = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(0));
jbe@16 2548 pgl_cluster *cluster2 = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(1));
jbe@16 2549 double retval = pgl_cluster_distance(cluster1, cluster2);
jbe@16 2550 PG_FREE_IF_COPY(cluster1, 0);
jbe@16 2551 PG_FREE_IF_COPY(cluster2, 1);
jbe@16 2552 PG_RETURN_FLOAT8(retval);
jbe@16 2553 }
jbe@16 2554
jbe@0 2555
jbe@0 2556 /*-----------------------------------------------------------*
jbe@0 2557 * B-tree comparison operators and index support functions *
jbe@0 2558 *-----------------------------------------------------------*/
jbe@0 2559
jbe@0 2560 /* macro for a B-tree operator (without detoasting) */
jbe@0 2561 #define PGL_BTREE_OPER(func, type, cmpfunc, oper) \
jbe@0 2562 PG_FUNCTION_INFO_V1(func); \
jbe@0 2563 Datum func(PG_FUNCTION_ARGS) { \
jbe@0 2564 type *a = (type *)PG_GETARG_POINTER(0); \
jbe@0 2565 type *b = (type *)PG_GETARG_POINTER(1); \
jbe@0 2566 PG_RETURN_BOOL(cmpfunc(a, b) oper 0); \
jbe@0 2567 }
jbe@0 2568
jbe@0 2569 /* macro for a B-tree comparison function (without detoasting) */
jbe@0 2570 #define PGL_BTREE_CMP(func, type, cmpfunc) \
jbe@0 2571 PG_FUNCTION_INFO_V1(func); \
jbe@0 2572 Datum func(PG_FUNCTION_ARGS) { \
jbe@0 2573 type *a = (type *)PG_GETARG_POINTER(0); \
jbe@0 2574 type *b = (type *)PG_GETARG_POINTER(1); \
jbe@0 2575 PG_RETURN_INT32(cmpfunc(a, b)); \
jbe@0 2576 }
jbe@0 2577
jbe@0 2578 /* macro for a B-tree operator (with detoasting) */
jbe@0 2579 #define PGL_BTREE_OPER_DETOAST(func, type, cmpfunc, oper) \
jbe@0 2580 PG_FUNCTION_INFO_V1(func); \
jbe@0 2581 Datum func(PG_FUNCTION_ARGS) { \
jbe@0 2582 bool res; \
jbe@0 2583 type *a = (type *)PG_DETOAST_DATUM(PG_GETARG_DATUM(0)); \
jbe@0 2584 type *b = (type *)PG_DETOAST_DATUM(PG_GETARG_DATUM(1)); \
jbe@0 2585 res = cmpfunc(a, b) oper 0; \
jbe@0 2586 PG_FREE_IF_COPY(a, 0); \
jbe@0 2587 PG_FREE_IF_COPY(b, 1); \
jbe@0 2588 PG_RETURN_BOOL(res); \
jbe@0 2589 }
jbe@0 2590
jbe@0 2591 /* macro for a B-tree comparison function (with detoasting) */
jbe@0 2592 #define PGL_BTREE_CMP_DETOAST(func, type, cmpfunc) \
jbe@0 2593 PG_FUNCTION_INFO_V1(func); \
jbe@0 2594 Datum func(PG_FUNCTION_ARGS) { \
jbe@0 2595 int32_t res; \
jbe@0 2596 type *a = (type *)PG_DETOAST_DATUM(PG_GETARG_DATUM(0)); \
jbe@0 2597 type *b = (type *)PG_DETOAST_DATUM(PG_GETARG_DATUM(1)); \
jbe@0 2598 res = cmpfunc(a, b); \
jbe@0 2599 PG_FREE_IF_COPY(a, 0); \
jbe@0 2600 PG_FREE_IF_COPY(b, 1); \
jbe@0 2601 PG_RETURN_INT32(res); \
jbe@0 2602 }
jbe@0 2603
jbe@0 2604 /* B-tree operators and comparison function for point */
jbe@0 2605 PGL_BTREE_OPER(pgl_btree_epoint_lt, pgl_point, pgl_point_cmp, <)
jbe@0 2606 PGL_BTREE_OPER(pgl_btree_epoint_le, pgl_point, pgl_point_cmp, <=)
jbe@0 2607 PGL_BTREE_OPER(pgl_btree_epoint_eq, pgl_point, pgl_point_cmp, ==)
jbe@0 2608 PGL_BTREE_OPER(pgl_btree_epoint_ne, pgl_point, pgl_point_cmp, !=)
jbe@0 2609 PGL_BTREE_OPER(pgl_btree_epoint_ge, pgl_point, pgl_point_cmp, >=)
jbe@0 2610 PGL_BTREE_OPER(pgl_btree_epoint_gt, pgl_point, pgl_point_cmp, >)
jbe@0 2611 PGL_BTREE_CMP(pgl_btree_epoint_cmp, pgl_point, pgl_point_cmp)
jbe@0 2612
jbe@0 2613 /* B-tree operators and comparison function for box */
jbe@0 2614 PGL_BTREE_OPER(pgl_btree_ebox_lt, pgl_box, pgl_box_cmp, <)
jbe@0 2615 PGL_BTREE_OPER(pgl_btree_ebox_le, pgl_box, pgl_box_cmp, <=)
jbe@0 2616 PGL_BTREE_OPER(pgl_btree_ebox_eq, pgl_box, pgl_box_cmp, ==)
jbe@0 2617 PGL_BTREE_OPER(pgl_btree_ebox_ne, pgl_box, pgl_box_cmp, !=)
jbe@0 2618 PGL_BTREE_OPER(pgl_btree_ebox_ge, pgl_box, pgl_box_cmp, >=)
jbe@0 2619 PGL_BTREE_OPER(pgl_btree_ebox_gt, pgl_box, pgl_box_cmp, >)
jbe@0 2620 PGL_BTREE_CMP(pgl_btree_ebox_cmp, pgl_box, pgl_box_cmp)
jbe@0 2621
jbe@0 2622 /* B-tree operators and comparison function for circle */
jbe@0 2623 PGL_BTREE_OPER(pgl_btree_ecircle_lt, pgl_circle, pgl_circle_cmp, <)
jbe@0 2624 PGL_BTREE_OPER(pgl_btree_ecircle_le, pgl_circle, pgl_circle_cmp, <=)
jbe@0 2625 PGL_BTREE_OPER(pgl_btree_ecircle_eq, pgl_circle, pgl_circle_cmp, ==)
jbe@0 2626 PGL_BTREE_OPER(pgl_btree_ecircle_ne, pgl_circle, pgl_circle_cmp, !=)
jbe@0 2627 PGL_BTREE_OPER(pgl_btree_ecircle_ge, pgl_circle, pgl_circle_cmp, >=)
jbe@0 2628 PGL_BTREE_OPER(pgl_btree_ecircle_gt, pgl_circle, pgl_circle_cmp, >)
jbe@0 2629 PGL_BTREE_CMP(pgl_btree_ecircle_cmp, pgl_circle, pgl_circle_cmp)
jbe@0 2630
jbe@0 2631
jbe@0 2632 /*--------------------------------*
jbe@0 2633 * GiST index support functions *
jbe@0 2634 *--------------------------------*/
jbe@0 2635
jbe@0 2636 /* GiST "consistent" support function */
jbe@0 2637 PG_FUNCTION_INFO_V1(pgl_gist_consistent);
jbe@0 2638 Datum pgl_gist_consistent(PG_FUNCTION_ARGS) {
jbe@0 2639 GISTENTRY *entry = (GISTENTRY *) PG_GETARG_POINTER(0);
jbe@0 2640 pgl_keyptr key = (pgl_keyptr)DatumGetPointer(entry->key);
jbe@0 2641 StrategyNumber strategy = (StrategyNumber)PG_GETARG_UINT16(2);
jbe@0 2642 bool *recheck = (bool *)PG_GETARG_POINTER(4);
jbe@0 2643 /* demand recheck because index and query methods are lossy */
jbe@0 2644 *recheck = true;
jbe@10 2645 /* strategy number aliases for different operators using the same strategy */
jbe@10 2646 strategy %= 100;
jbe@0 2647 /* strategy number 11: equality of two points */
jbe@0 2648 if (strategy == 11) {
jbe@0 2649 /* query datum is another point */
jbe@0 2650 pgl_point *query = (pgl_point *)PG_GETARG_POINTER(1);
jbe@0 2651 /* convert other point to key */
jbe@0 2652 pgl_pointkey querykey;
jbe@0 2653 pgl_point_to_key(query, querykey);
jbe@0 2654 /* return true if both keys overlap */
jbe@0 2655 PG_RETURN_BOOL(pgl_keys_overlap(key, querykey));
jbe@0 2656 }
jbe@0 2657 /* strategy number 13: equality of two circles */
jbe@0 2658 if (strategy == 13) {
jbe@0 2659 /* query datum is another circle */
jbe@0 2660 pgl_circle *query = (pgl_circle *)PG_GETARG_POINTER(1);
jbe@0 2661 /* convert other circle to key */
jbe@0 2662 pgl_areakey querykey;
jbe@0 2663 pgl_circle_to_key(query, querykey);
jbe@0 2664 /* return true if both keys overlap */
jbe@0 2665 PG_RETURN_BOOL(pgl_keys_overlap(key, querykey));
jbe@0 2666 }
jbe@0 2667 /* for all remaining strategies, keys on empty objects produce no match */
jbe@0 2668 /* (check necessary because query radius may be infinite) */
jbe@0 2669 if (PGL_KEY_IS_EMPTY(key)) PG_RETURN_BOOL(false);
jbe@0 2670 /* strategy number 21: overlapping with point */
jbe@0 2671 if (strategy == 21) {
jbe@0 2672 /* query datum is a point */
jbe@0 2673 pgl_point *query = (pgl_point *)PG_GETARG_POINTER(1);
jbe@0 2674 /* return true if estimated distance (allowed to be smaller than real
jbe@0 2675 distance) between index key and point is zero */
jbe@0 2676 PG_RETURN_BOOL(pgl_estimate_key_distance(key, query) == 0);
jbe@0 2677 }
jbe@0 2678 /* strategy number 22: (point) overlapping with box */
jbe@0 2679 if (strategy == 22) {
jbe@0 2680 /* query datum is a box */
jbe@0 2681 pgl_box *query = (pgl_box *)PG_GETARG_POINTER(1);
jbe@0 2682 /* determine bounding box of indexed key */
jbe@0 2683 pgl_box keybox;
jbe@0 2684 pgl_key_to_box(key, &keybox);
jbe@0 2685 /* return true if query box overlaps with bounding box of indexed key */
jbe@0 2686 PG_RETURN_BOOL(pgl_boxes_overlap(query, &keybox));
jbe@0 2687 }
jbe@0 2688 /* strategy number 23: overlapping with circle */
jbe@0 2689 if (strategy == 23) {
jbe@0 2690 /* query datum is a circle */
jbe@0 2691 pgl_circle *query = (pgl_circle *)PG_GETARG_POINTER(1);
jbe@0 2692 /* return true if estimated distance (allowed to be smaller than real
jbe@0 2693 distance) between index key and circle center is smaller than radius */
jbe@0 2694 PG_RETURN_BOOL(
jbe@0 2695 pgl_estimate_key_distance(key, &(query->center)) <= query->radius
jbe@0 2696 );
jbe@0 2697 }
jbe@0 2698 /* strategy number 24: overlapping with cluster */
jbe@0 2699 if (strategy == 24) {
jbe@0 2700 bool retval; /* return value */
jbe@0 2701 /* query datum is a cluster */
jbe@0 2702 pgl_cluster *query = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(1));
jbe@0 2703 /* return true if estimated distance (allowed to be smaller than real
jbe@0 2704 distance) between index key and circle center is smaller than radius */
jbe@0 2705 retval = (
jbe@0 2706 pgl_estimate_key_distance(key, &(query->bounding.center)) <=
jbe@0 2707 query->bounding.radius
jbe@0 2708 );
jbe@0 2709 PG_FREE_IF_COPY(query, 1); /* free detoasted cluster (if copy) */
jbe@0 2710 PG_RETURN_BOOL(retval);
jbe@0 2711 }
jbe@0 2712 /* throw error for any unknown strategy number */
jbe@0 2713 elog(ERROR, "unrecognized strategy number: %d", strategy);
jbe@0 2714 }
jbe@0 2715
jbe@0 2716 /* GiST "union" support function */
jbe@0 2717 PG_FUNCTION_INFO_V1(pgl_gist_union);
jbe@0 2718 Datum pgl_gist_union(PG_FUNCTION_ARGS) {
jbe@0 2719 GistEntryVector *entryvec = (GistEntryVector *)PG_GETARG_POINTER(0);
jbe@0 2720 pgl_keyptr out; /* return value (to be palloc'ed) */
jbe@0 2721 int i;
jbe@0 2722 /* determine key size */
jbe@0 2723 size_t keysize = PGL_KEY_IS_AREAKEY(
jbe@0 2724 (pgl_keyptr)DatumGetPointer(entryvec->vector[0].key)
jbe@0 2725 ) ? sizeof (pgl_areakey) : sizeof(pgl_pointkey);
jbe@0 2726 /* begin with first key as result */
jbe@0 2727 out = palloc(keysize);
jbe@0 2728 memcpy(out, (pgl_keyptr)DatumGetPointer(entryvec->vector[0].key), keysize);
jbe@0 2729 /* unite current result with second, third, etc. key */
jbe@0 2730 for (i=1; i<entryvec->n; i++) {
jbe@0 2731 pgl_unite_keys(out, (pgl_keyptr)DatumGetPointer(entryvec->vector[i].key));
jbe@0 2732 }
jbe@0 2733 /* return result */
jbe@0 2734 PG_RETURN_POINTER(out);
jbe@0 2735 }
jbe@0 2736
jbe@0 2737 /* GiST "compress" support function for indicis on points */
jbe@0 2738 PG_FUNCTION_INFO_V1(pgl_gist_compress_epoint);
jbe@0 2739 Datum pgl_gist_compress_epoint(PG_FUNCTION_ARGS) {
jbe@0 2740 GISTENTRY *entry = (GISTENTRY *) PG_GETARG_POINTER(0);
jbe@0 2741 GISTENTRY *retval; /* return value (to be palloc'ed unless set to entry) */
jbe@0 2742 /* only transform new leaves */
jbe@0 2743 if (entry->leafkey) {
jbe@0 2744 /* get point to be transformed */
jbe@0 2745 pgl_point *point = (pgl_point *)DatumGetPointer(entry->key);
jbe@0 2746 /* allocate memory for key */
jbe@0 2747 pgl_keyptr key = palloc(sizeof(pgl_pointkey));
jbe@0 2748 /* transform point to key */
jbe@0 2749 pgl_point_to_key(point, key);
jbe@0 2750 /* create new GISTENTRY structure as return value */
jbe@0 2751 retval = palloc(sizeof(GISTENTRY));
jbe@0 2752 gistentryinit(
jbe@0 2753 *retval, PointerGetDatum(key),
jbe@0 2754 entry->rel, entry->page, entry->offset, FALSE
jbe@0 2755 );
jbe@0 2756 } else {
jbe@0 2757 /* inner nodes have already been transformed */
jbe@0 2758 retval = entry;
jbe@0 2759 }
jbe@0 2760 /* return pointer to old or new GISTENTRY structure */
jbe@0 2761 PG_RETURN_POINTER(retval);
jbe@0 2762 }
jbe@0 2763
jbe@0 2764 /* GiST "compress" support function for indicis on circles */
jbe@0 2765 PG_FUNCTION_INFO_V1(pgl_gist_compress_ecircle);
jbe@0 2766 Datum pgl_gist_compress_ecircle(PG_FUNCTION_ARGS) {
jbe@0 2767 GISTENTRY *entry = (GISTENTRY *) PG_GETARG_POINTER(0);
jbe@0 2768 GISTENTRY *retval; /* return value (to be palloc'ed unless set to entry) */
jbe@0 2769 /* only transform new leaves */
jbe@0 2770 if (entry->leafkey) {
jbe@0 2771 /* get circle to be transformed */
jbe@0 2772 pgl_circle *circle = (pgl_circle *)DatumGetPointer(entry->key);
jbe@0 2773 /* allocate memory for key */
jbe@0 2774 pgl_keyptr key = palloc(sizeof(pgl_areakey));
jbe@0 2775 /* transform circle to key */
jbe@0 2776 pgl_circle_to_key(circle, key);
jbe@0 2777 /* create new GISTENTRY structure as return value */
jbe@0 2778 retval = palloc(sizeof(GISTENTRY));
jbe@0 2779 gistentryinit(
jbe@0 2780 *retval, PointerGetDatum(key),
jbe@0 2781 entry->rel, entry->page, entry->offset, FALSE
jbe@0 2782 );
jbe@0 2783 } else {
jbe@0 2784 /* inner nodes have already been transformed */
jbe@0 2785 retval = entry;
jbe@0 2786 }
jbe@0 2787 /* return pointer to old or new GISTENTRY structure */
jbe@0 2788 PG_RETURN_POINTER(retval);
jbe@0 2789 }
jbe@0 2790
jbe@0 2791 /* GiST "compress" support function for indices on clusters */
jbe@0 2792 PG_FUNCTION_INFO_V1(pgl_gist_compress_ecluster);
jbe@0 2793 Datum pgl_gist_compress_ecluster(PG_FUNCTION_ARGS) {
jbe@0 2794 GISTENTRY *entry = (GISTENTRY *) PG_GETARG_POINTER(0);
jbe@0 2795 GISTENTRY *retval; /* return value (to be palloc'ed unless set to entry) */
jbe@0 2796 /* only transform new leaves */
jbe@0 2797 if (entry->leafkey) {
jbe@0 2798 /* get cluster to be transformed (detoasting necessary!) */
jbe@0 2799 pgl_cluster *cluster = (pgl_cluster *)PG_DETOAST_DATUM(entry->key);
jbe@0 2800 /* allocate memory for key */
jbe@0 2801 pgl_keyptr key = palloc(sizeof(pgl_areakey));
jbe@0 2802 /* transform cluster to key */
jbe@0 2803 pgl_circle_to_key(&(cluster->bounding), key);
jbe@0 2804 /* create new GISTENTRY structure as return value */
jbe@0 2805 retval = palloc(sizeof(GISTENTRY));
jbe@0 2806 gistentryinit(
jbe@0 2807 *retval, PointerGetDatum(key),
jbe@0 2808 entry->rel, entry->page, entry->offset, FALSE
jbe@0 2809 );
jbe@0 2810 /* free detoasted datum */
jbe@0 2811 if ((void *)cluster != (void *)DatumGetPointer(entry->key)) pfree(cluster);
jbe@0 2812 } else {
jbe@0 2813 /* inner nodes have already been transformed */
jbe@0 2814 retval = entry;
jbe@0 2815 }
jbe@0 2816 /* return pointer to old or new GISTENTRY structure */
jbe@0 2817 PG_RETURN_POINTER(retval);
jbe@0 2818 }
jbe@0 2819
jbe@0 2820 /* GiST "decompress" support function for indices */
jbe@0 2821 PG_FUNCTION_INFO_V1(pgl_gist_decompress);
jbe@0 2822 Datum pgl_gist_decompress(PG_FUNCTION_ARGS) {
jbe@0 2823 /* return passed pointer without transformation */
jbe@0 2824 PG_RETURN_POINTER(PG_GETARG_POINTER(0));
jbe@0 2825 }
jbe@0 2826
jbe@0 2827 /* GiST "penalty" support function */
jbe@0 2828 PG_FUNCTION_INFO_V1(pgl_gist_penalty);
jbe@0 2829 Datum pgl_gist_penalty(PG_FUNCTION_ARGS) {
jbe@0 2830 GISTENTRY *origentry = (GISTENTRY *)PG_GETARG_POINTER(0);
jbe@0 2831 GISTENTRY *newentry = (GISTENTRY *)PG_GETARG_POINTER(1);
jbe@0 2832 float *penalty = (float *)PG_GETARG_POINTER(2);
jbe@0 2833 /* get original key and key to insert */
jbe@0 2834 pgl_keyptr orig = (pgl_keyptr)DatumGetPointer(origentry->key);
jbe@0 2835 pgl_keyptr new = (pgl_keyptr)DatumGetPointer(newentry->key);
jbe@0 2836 /* copy original key */
jbe@0 2837 union { pgl_pointkey pointkey; pgl_areakey areakey; } union_key;
jbe@0 2838 if (PGL_KEY_IS_AREAKEY(orig)) {
jbe@0 2839 memcpy(union_key.areakey, orig, sizeof(union_key.areakey));
jbe@0 2840 } else {
jbe@0 2841 memcpy(union_key.pointkey, orig, sizeof(union_key.pointkey));
jbe@0 2842 }
jbe@0 2843 /* calculate union of both keys */
jbe@0 2844 pgl_unite_keys((pgl_keyptr)&union_key, new);
jbe@0 2845 /* penalty equal to reduction of key length (logarithm of added area) */
jbe@0 2846 /* (return value by setting referenced value and returning pointer) */
jbe@0 2847 *penalty = (
jbe@0 2848 PGL_KEY_NODEDEPTH(orig) - PGL_KEY_NODEDEPTH((pgl_keyptr)&union_key)
jbe@0 2849 );
jbe@0 2850 PG_RETURN_POINTER(penalty);
jbe@0 2851 }
jbe@0 2852
jbe@0 2853 /* GiST "picksplit" support function */
jbe@0 2854 PG_FUNCTION_INFO_V1(pgl_gist_picksplit);
jbe@0 2855 Datum pgl_gist_picksplit(PG_FUNCTION_ARGS) {
jbe@0 2856 GistEntryVector *entryvec = (GistEntryVector *)PG_GETARG_POINTER(0);
jbe@0 2857 GIST_SPLITVEC *v = (GIST_SPLITVEC *)PG_GETARG_POINTER(1);
jbe@0 2858 OffsetNumber i; /* between FirstOffsetNumber and entryvec->n (inclusive) */
jbe@0 2859 union {
jbe@0 2860 pgl_pointkey pointkey;
jbe@0 2861 pgl_areakey areakey;
jbe@0 2862 } union_all; /* union of all keys (to be calculated from scratch)
jbe@0 2863 (later cut in half) */
jbe@0 2864 int is_areakey = PGL_KEY_IS_AREAKEY(
jbe@0 2865 (pgl_keyptr)DatumGetPointer(entryvec->vector[FirstOffsetNumber].key)
jbe@0 2866 );
jbe@0 2867 int keysize = is_areakey ? sizeof(pgl_areakey) : sizeof(pgl_pointkey);
jbe@0 2868 pgl_keyptr unionL = palloc(keysize); /* union of keys that go left */
jbe@0 2869 pgl_keyptr unionR = palloc(keysize); /* union of keys that go right */
jbe@0 2870 pgl_keyptr key; /* current key to be processed */
jbe@0 2871 /* allocate memory for array of left and right keys, set counts to zero */
jbe@0 2872 v->spl_left = (OffsetNumber *)palloc(entryvec->n * sizeof(OffsetNumber));
jbe@0 2873 v->spl_nleft = 0;
jbe@0 2874 v->spl_right = (OffsetNumber *)palloc(entryvec->n * sizeof(OffsetNumber));
jbe@0 2875 v->spl_nright = 0;
jbe@0 2876 /* calculate union of all keys from scratch */
jbe@0 2877 memcpy(
jbe@0 2878 (pgl_keyptr)&union_all,
jbe@0 2879 (pgl_keyptr)DatumGetPointer(entryvec->vector[FirstOffsetNumber].key),
jbe@0 2880 keysize
jbe@0 2881 );
jbe@0 2882 for (i=FirstOffsetNumber+1; i<entryvec->n; i=OffsetNumberNext(i)) {
jbe@0 2883 pgl_unite_keys(
jbe@0 2884 (pgl_keyptr)&union_all,
jbe@0 2885 (pgl_keyptr)DatumGetPointer(entryvec->vector[i].key)
jbe@0 2886 );
jbe@0 2887 }
jbe@0 2888 /* check if trivial split is necessary due to exhausted key length */
jbe@0 2889 /* (Note: keys for empty objects must have node depth set to maximum) */
jbe@0 2890 if (PGL_KEY_NODEDEPTH((pgl_keyptr)&union_all) == (
jbe@0 2891 is_areakey ? PGL_AREAKEY_MAXDEPTH : PGL_POINTKEY_MAXDEPTH
jbe@0 2892 )) {
jbe@0 2893 /* half of all keys go left */
jbe@0 2894 for (
jbe@0 2895 i=FirstOffsetNumber;
jbe@0 2896 i<FirstOffsetNumber+(entryvec->n - FirstOffsetNumber)/2;
jbe@0 2897 i=OffsetNumberNext(i)
jbe@0 2898 ) {
jbe@0 2899 /* pointer to current key */
jbe@0 2900 key = (pgl_keyptr)DatumGetPointer(entryvec->vector[i].key);
jbe@0 2901 /* update unionL */
jbe@0 2902 /* check if key is first key that goes left */
jbe@0 2903 if (!v->spl_nleft) {
jbe@0 2904 /* first key that goes left is just copied to unionL */
jbe@0 2905 memcpy(unionL, key, keysize);
jbe@0 2906 } else {
jbe@0 2907 /* unite current value and next key */
jbe@0 2908 pgl_unite_keys(unionL, key);
jbe@0 2909 }
jbe@0 2910 /* append offset number to list of keys that go left */
jbe@0 2911 v->spl_left[v->spl_nleft++] = i;
jbe@0 2912 }
jbe@0 2913 /* other half goes right */
jbe@0 2914 for (
jbe@0 2915 i=FirstOffsetNumber+(entryvec->n - FirstOffsetNumber)/2;
jbe@0 2916 i<entryvec->n;
jbe@0 2917 i=OffsetNumberNext(i)
jbe@0 2918 ) {
jbe@0 2919 /* pointer to current key */
jbe@0 2920 key = (pgl_keyptr)DatumGetPointer(entryvec->vector[i].key);
jbe@0 2921 /* update unionR */
jbe@0 2922 /* check if key is first key that goes right */
jbe@0 2923 if (!v->spl_nright) {
jbe@0 2924 /* first key that goes right is just copied to unionR */
jbe@0 2925 memcpy(unionR, key, keysize);
jbe@0 2926 } else {
jbe@0 2927 /* unite current value and next key */
jbe@0 2928 pgl_unite_keys(unionR, key);
jbe@0 2929 }
jbe@0 2930 /* append offset number to list of keys that go right */
jbe@0 2931 v->spl_right[v->spl_nright++] = i;
jbe@0 2932 }
jbe@0 2933 }
jbe@0 2934 /* otherwise, a non-trivial split is possible */
jbe@0 2935 else {
jbe@0 2936 /* cut covered area in half */
jbe@0 2937 /* (union_all then refers to area of keys that go left) */
jbe@0 2938 /* check if union of all keys covers empty and non-empty objects */
jbe@0 2939 if (PGL_KEY_IS_UNIVERSAL((pgl_keyptr)&union_all)) {
jbe@0 2940 /* if yes, split into empty and non-empty objects */
jbe@0 2941 pgl_key_set_empty((pgl_keyptr)&union_all);
jbe@0 2942 } else {
jbe@0 2943 /* otherwise split by next bit */
jbe@0 2944 ((pgl_keyptr)&union_all)[PGL_KEY_NODEDEPTH_OFFSET]++;
jbe@0 2945 /* NOTE: type bit conserved */
jbe@0 2946 }
jbe@0 2947 /* determine for each key if it goes left or right */
jbe@0 2948 for (i=FirstOffsetNumber; i<entryvec->n; i=OffsetNumberNext(i)) {
jbe@0 2949 /* pointer to current key */
jbe@0 2950 key = (pgl_keyptr)DatumGetPointer(entryvec->vector[i].key);
jbe@0 2951 /* keys within one half of the area go left */
jbe@0 2952 if (pgl_keys_overlap((pgl_keyptr)&union_all, key)) {
jbe@0 2953 /* update unionL */
jbe@0 2954 /* check if key is first key that goes left */
jbe@0 2955 if (!v->spl_nleft) {
jbe@0 2956 /* first key that goes left is just copied to unionL */
jbe@0 2957 memcpy(unionL, key, keysize);
jbe@0 2958 } else {
jbe@0 2959 /* unite current value of unionL and processed key */
jbe@0 2960 pgl_unite_keys(unionL, key);
jbe@0 2961 }
jbe@0 2962 /* append offset number to list of keys that go left */
jbe@0 2963 v->spl_left[v->spl_nleft++] = i;
jbe@0 2964 }
jbe@0 2965 /* the other keys go right */
jbe@0 2966 else {
jbe@0 2967 /* update unionR */
jbe@0 2968 /* check if key is first key that goes right */
jbe@0 2969 if (!v->spl_nright) {
jbe@0 2970 /* first key that goes right is just copied to unionR */
jbe@0 2971 memcpy(unionR, key, keysize);
jbe@0 2972 } else {
jbe@0 2973 /* unite current value of unionR and processed key */
jbe@0 2974 pgl_unite_keys(unionR, key);
jbe@0 2975 }
jbe@0 2976 /* append offset number to list of keys that go right */
jbe@0 2977 v->spl_right[v->spl_nright++] = i;
jbe@0 2978 }
jbe@0 2979 }
jbe@0 2980 }
jbe@0 2981 /* store unions in return value */
jbe@0 2982 v->spl_ldatum = PointerGetDatum(unionL);
jbe@0 2983 v->spl_rdatum = PointerGetDatum(unionR);
jbe@0 2984 /* return all results */
jbe@0 2985 PG_RETURN_POINTER(v);
jbe@0 2986 }
jbe@0 2987
jbe@0 2988 /* GiST "same"/"equal" support function */
jbe@0 2989 PG_FUNCTION_INFO_V1(pgl_gist_same);
jbe@0 2990 Datum pgl_gist_same(PG_FUNCTION_ARGS) {
jbe@0 2991 pgl_keyptr key1 = (pgl_keyptr)PG_GETARG_POINTER(0);
jbe@0 2992 pgl_keyptr key2 = (pgl_keyptr)PG_GETARG_POINTER(1);
jbe@0 2993 bool *boolptr = (bool *)PG_GETARG_POINTER(2);
jbe@0 2994 /* two keys are equal if they are binary equal */
jbe@0 2995 /* (return result by setting referenced boolean and returning pointer) */
jbe@0 2996 *boolptr = !memcmp(
jbe@0 2997 key1,
jbe@0 2998 key2,
jbe@0 2999 PGL_KEY_IS_AREAKEY(key1) ? sizeof(pgl_areakey) : sizeof(pgl_pointkey)
jbe@0 3000 );
jbe@0 3001 PG_RETURN_POINTER(boolptr);
jbe@0 3002 }
jbe@0 3003
jbe@0 3004 /* GiST "distance" support function */
jbe@0 3005 PG_FUNCTION_INFO_V1(pgl_gist_distance);
jbe@0 3006 Datum pgl_gist_distance(PG_FUNCTION_ARGS) {
jbe@0 3007 GISTENTRY *entry = (GISTENTRY *)PG_GETARG_POINTER(0);
jbe@0 3008 pgl_keyptr key = (pgl_keyptr)DatumGetPointer(entry->key);
jbe@0 3009 StrategyNumber strategy = (StrategyNumber)PG_GETARG_UINT16(2);
jbe@0 3010 bool *recheck = (bool *)PG_GETARG_POINTER(4);
jbe@0 3011 double distance; /* return value */
jbe@0 3012 /* demand recheck because distance is just an estimation */
jbe@0 3013 /* (real distance may be bigger) */
jbe@0 3014 *recheck = true;
jbe@10 3015 /* strategy number aliases for different operators using the same strategy */
jbe@10 3016 strategy %= 100;
jbe@0 3017 /* strategy number 31: distance to point */
jbe@0 3018 if (strategy == 31) {
jbe@0 3019 /* query datum is a point */
jbe@0 3020 pgl_point *query = (pgl_point *)PG_GETARG_POINTER(1);
jbe@0 3021 /* use pgl_estimate_pointkey_distance() function to compute result */
jbe@0 3022 distance = pgl_estimate_key_distance(key, query);
jbe@0 3023 /* avoid infinity (reserved!) */
jbe@0 3024 if (!isfinite(distance)) distance = PGL_ULTRA_DISTANCE;
jbe@0 3025 /* return result */
jbe@0 3026 PG_RETURN_FLOAT8(distance);
jbe@0 3027 }
jbe@0 3028 /* strategy number 33: distance to circle */
jbe@0 3029 if (strategy == 33) {
jbe@0 3030 /* query datum is a circle */
jbe@0 3031 pgl_circle *query = (pgl_circle *)PG_GETARG_POINTER(1);
jbe@0 3032 /* estimate distance to circle center and substract circle radius */
jbe@0 3033 distance = (
jbe@0 3034 pgl_estimate_key_distance(key, &(query->center)) - query->radius
jbe@0 3035 );
jbe@0 3036 /* convert non-positive values to zero and avoid infinity (reserved!) */
jbe@0 3037 if (distance <= 0) distance = 0;
jbe@0 3038 else if (!isfinite(distance)) distance = PGL_ULTRA_DISTANCE;
jbe@0 3039 /* return result */
jbe@0 3040 PG_RETURN_FLOAT8(distance);
jbe@0 3041 }
jbe@0 3042 /* strategy number 34: distance to cluster */
jbe@0 3043 if (strategy == 34) {
jbe@0 3044 /* query datum is a cluster */
jbe@0 3045 pgl_cluster *query = (pgl_cluster *)PG_DETOAST_DATUM(PG_GETARG_DATUM(1));
jbe@0 3046 /* estimate distance to bounding center and substract bounding radius */
jbe@0 3047 distance = (
jbe@0 3048 pgl_estimate_key_distance(key, &(query->bounding.center)) -
jbe@0 3049 query->bounding.radius
jbe@0 3050 );
jbe@0 3051 /* convert non-positive values to zero and avoid infinity (reserved!) */
jbe@0 3052 if (distance <= 0) distance = 0;
jbe@0 3053 else if (!isfinite(distance)) distance = PGL_ULTRA_DISTANCE;
jbe@0 3054 /* free detoasted cluster (if copy) */
jbe@0 3055 PG_FREE_IF_COPY(query, 1);
jbe@0 3056 /* return result */
jbe@0 3057 PG_RETURN_FLOAT8(distance);
jbe@0 3058 }
jbe@0 3059 /* throw error for any unknown strategy number */
jbe@0 3060 elog(ERROR, "unrecognized strategy number: %d", strategy);
jbe@0 3061 }
jbe@0 3062

Impressum / About Us