pgLatLon

diff README.mkd @ 20:8a8d6dc44337

Changed/fixed behavior of "contains" operator regarding perimeters; Added "contains" operator for ebox type; Minor changes in README
author jbe
date Mon Sep 12 18:00:52 2016 +0200 (2016-09-12)
parents e319679cefbd
children a7ba8335e541
line diff
     1.1 --- a/README.mkd	Fri Sep 09 23:44:28 2016 +0200
     1.2 +++ b/README.mkd	Mon Sep 12 18:00:52 2016 +0200
     1.3 @@ -1,4 +1,4 @@
     1.4 -pgLatLon v0.4 documentation
     1.5 +pgLatLon v0.5 documentation
     1.6  ===========================
     1.7  
     1.8  pgLatLon is a spatial database extension for the PostgreSQL object-relational
     1.9 @@ -39,8 +39,8 @@
    1.10  It is also possible to compile and install the extension without GNU Make as
    1.11  follows:
    1.12  
    1.13 -    cc -Wall -O2 -fPIC -shared -I `pg_config --includedir-server` -o latlon-v0003.so latlon-v0003.c
    1.14 -    cp latlon-v0003.so `pg_config --pkglibdir`
    1.15 +    cc -Wall -O2 -fPIC -shared -I `pg_config --includedir-server` -o latlon-v0005.so latlon-v0005.c
    1.16 +    cp latlon-v0005.so `pg_config --pkglibdir`
    1.17      cp latlon.control `pg_config --sharedir`/extension/
    1.18      cp latlon--*.sql `pg_config --sharedir`/extension/
    1.19  
    1.20 @@ -274,8 +274,8 @@
    1.21  * `ecircle && ecluster`
    1.22  * `ecluster && ecluster`
    1.23  
    1.24 -The `&&` operator is commutative, i.e. `a && b` is the same as `b && a`. Each
    1.25 -commutation is supported as well.
    1.26 +The `&&` operator is commutative, i.e. "`a && b`" is the same as "`b && a`".
    1.27 +Each commutation is supported as well.
    1.28  
    1.29  #### Lossy overlap operator `&&+`
    1.30  
    1.31 @@ -289,7 +289,7 @@
    1.32  * `ecircle &&+ ecluster`
    1.33  * `ecluster &&+ ecluster`
    1.34  
    1.35 -The `&&+` operator is commutative, i.e. `a &&+ b` is the same as `b &&+ a`.
    1.36 +The `&&+` operator is commutative, i.e. "`a &&+ b`" is the same as "`b &&+ a`".
    1.37  Each commutation is supported as well.
    1.38  
    1.39  Where two data types support both the `&&` and the `&&+` operator, the `&&+`
    1.40 @@ -301,13 +301,20 @@
    1.41  the operator. Currently implemented for:
    1.42  
    1.43  * `ebox @> epoint` (alias for `&&`)
    1.44 +* `ebox @> ebox`
    1.45  * `ebox @> ecluster`
    1.46  * `ecluster @> epoint` (alias for `&&`)
    1.47  * `ecluster @> ebox`
    1.48  * `ecluster @> ecluster`
    1.49  
    1.50 -The commutator of `@>` ("contains") is `<@` ("is contained in"), i.e. `a @> b`
    1.51 -is the same as `b <@ a`.
    1.52 +The commutator of `@>` ("contains") is `<@` ("is contained in"), i.e.
    1.53 +"`a @> b`" is the same as "`b <@ a`".
    1.54 +
    1.55 +Whether the perimeter of an object is taken into account is undefined and may
    1.56 +differ between the left and the right hand side of the operator. The current
    1.57 +implementation returns true only if an object is contained completely within
    1.58 +the other object, not touching its perimeter, paths, outlines, or any singular
    1.59 +points.
    1.60  
    1.61  #### Distance operator `<->`
    1.62  
    1.63 @@ -325,7 +332,7 @@
    1.64  * `ecircle <-> ecluster`
    1.65  * `ecluster <-> ecluster`
    1.66  
    1.67 -The `<->` operator is commutative, i.e. `a <-> b` is the same as `b <-> a`.
    1.68 +The `<->` operator is commutative, i.e. "`a <-> b`" is the same as "`b <-> a`".
    1.69  Each commutation is supported as well.
    1.70  
    1.71  For short distances, the result is very accurate (i.e. respects the dimensions

Impressum / About Us