Spatial4j

Primary tabs

The official Spatial4j site is perhaps here at LocationTech -- what you are seeing now.  That said the README.md file (which GitHub prominently displays on the project landing page) is arguably better.  In addition, Spatial4j publishes a Maven generated site here which includes some useful project information to include the javadoc api.

Scope: 

Spatial4j has a fairly limited scope largely centered around geometric shape implementations:

  • Define geometric shapes, both classic Euclidean/Cartesian two-dimensional ones and geodetic (surface-of-sphere) ones.  Some sample shapes are: point, rectangle, circle (aka point-distance), polygon, linestring
  • Compute the bounding box of a shape
  • Compute the intersection case between a pair of shapes, especially where one of them is a point or rectangle. Intersection cases are intersects, contains, within, and disjoint. 
  • Compute the area of a shape
  • Compute the distance between points (plus other misc. distance / angle calculations)
  • Compute a geohash string for a point, and vice-versa, and compute the rectangle for a geohash, (plus other misc. geohash calculations)
  • Encode and decode a shape to and from a serialized representation. An example is Well Known Text (WKT).
Releases: 
NameDate
0.6 Current2016-02-20
Reviews: 
NameDate
0.6 Release Review2016-02-17
Creation Review2014-06-11