togo 0.1.2__cp38-cp38-musllinux_1_2_x86_64.whl → 0.1.5__cp38-cp38-musllinux_1_2_x86_64.whl

{togo-0.1.2.dist-info → togo-0.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: togo
-Version: 0.1.2
+Version: 0.1.5
 Summary: Lightweight Python bindings for the TG geometry library
 Author-email: Giorgio Salluzzo <giorgio.salluzzo@gmail.com>
 License: MIT
@@ -92,24 +92,119 @@ second = gc[1]
 print(first.type_string())  # 'Point'
 ```
 
-### Point, Line, Ring, Poly
-
-Building blocks for constructing geometries:
+### Point
 
 ```python
+from togo import Point
+
 # Create a point
 p = Point(1.0, 2.0)
 
-# Create a line
-line = Line([(0,0), (1,1), (2,2)])
+# Access coordinates
+print(f"X: {p.x}, Y: {p.y}")
+
+# Get as a tuple
+print(p.as_tuple())
+
+# Convert to a Geometry object
+geom = p.as_geometry()
+print(geom.type_string())
+```
+
+### Segment
+
+```python
+from togo import Segment, Point
+
+# Create a segment from two points (or tuples)
+seg = Segment(Point(0, 0), Point(1, 1))
+# Or using tuples
+tuple_seg = Segment((0, 0), (1, 1))
+
+# Access endpoints
+print(seg.a)  # Point(0, 0)
+print(seg.b)  # Point(1, 1)
+
+# Get the bounding rectangle
+rect = seg.rect()
+print(rect)  # ((0.0, 0.0), (1.0, 1.0))
+
+# Check intersection with another segment
+other = Segment((1, 1), (2, 2))
+print(seg.intersects(other))  # True or False
+```
+
+### Line
+
+```python
+from togo import Line
+
+# Create a line from a list of tuples
+line = Line([(0,0), (1,1), (2,0)])
 
-# Create a ring (closed line)
+# Get number of points
+print(f"Number of points: {line.num_points()}")
+
+# Get all points as a list of tuples
+print(f"Points: {line.points()}")
+
+# Get the length of the line
+print(f"Length: {line.length()}")
+
+# Get the bounding box
+print(f"Bounding box: {line.rect()}")
+
+# Get a point by index
+print(f"First point: {line[0].as_tuple()}")
+```
+
+### Ring
+
+```python
+from togo import Ring
+
+# Create a ring (must be closed)
 ring = Ring([(0,0), (10,0), (10,10), (0,10), (0,0)])
 
-# Create a polygon with holes
+# Get area and perimeter
+print(f"Area: {ring.area()}")
+print(f"Perimeter: {ring.perimeter()}")
+
+# Check if it's convex or clockwise
+print(f"Is convex: {ring.is_convex()}")
+print(f"Is clockwise: {ring.is_clockwise()}")
+
+# Get bounding box
+min_pt, max_pt = ring.rect().min, ring.rect().max
+print(f"Bounding box: {min_pt.as_tuple()}, {max_pt.as_tuple()}")
+```
+
+### Poly
+
+```python
+from togo import Poly, Ring, Point
+
+# Create a polygon with one exterior ring and one interior hole
 exterior = Ring([(0,0), (10,0), (10,10), (0,10), (0,0)])
-hole = Ring([(2,2), (8,2), (8,8), (2,8), (2,2)])
-poly = Poly(exterior, [hole])
+hole1 = Ring([(1,1), (2,1), (2,2), (1,2), (1,1)])
+poly = Poly(exterior, holes=[hole1])
+
+# Get the exterior ring
+ext_ring = poly.exterior()
+print(f"Exterior has {ext_ring.num_points()} points")
+
+# Get number of holes
+print(f"Number of holes: {poly.num_holes()}")
+
+# Get a hole by index
+h = poly.hole(0)
+print(f"Hole area: {h.area()}")
+
+# A polygon is a geometry, so you can use geometry methods
+geom = poly.as_geometry()
+print(f"Contains point (5,5): {geom.contains(Point(5,5).as_geometry())}")
+# Point is inside the hole, so it is not contained by the polygon
+print(f"Contains point (1.5,1.5): {geom.contains(Point(1.5,1.5).as_geometry())}")
 ```
 
 ### MultiGeometries
@@ -117,6 +212,8 @@ poly = Poly(exterior, [hole])
 Creating collections of geometries:
 
 ```python
+from togo import Geometry, Point, Line, Poly, Ring
+
 # Create a MultiPoint
 multi_point = Geometry.from_multipoint([(0,0), (1,1), Point(2,2)])
 
@@ -132,42 +229,41 @@ poly2 = Poly(Ring([(2,2), (3,2), (3,3), (2,3), (2,2)]))
 multi_poly = Geometry.from_multipolygon([poly1, poly2])
 ```
 
-### Segment
+## Polygon Indexing
 
-Represents a line segment between two points:
+Togo supports different polygon indexing strategies for optimized spatial operations:
 
 ```python
-from togo import Segment, Point
-
-# Create a segment from two points (or tuples)
-seg = Segment(Point(0, 0), Point(1, 1))
-# Or using tuples
-tuple_seg = Segment((0, 0), (1, 1))
+from togo import TGIndex, set_polygon_indexing_mode
 
-# Access endpoints
-print(seg.a)  # Point(0, 0)
-print(seg.b)  # Point(1, 1)
+# Set the indexing mode
+set_polygon_indexing_mode(TGIndex.NATURAL)  # or NONE, YSTRIPES
+```
 
-# Get the bounding rectangle
-rect = seg.rect()
-print(rect)  # ((0.0, 0.0), (1.0, 1.0))
+## Integration with tgx and libgeos
 
-# Check intersection with another segment
-other = Segment((1, 1), (2, 2))
-print(seg.intersects(other))  # True or False
-```
+Togo integrates with the [tgx](https://github.com/tidwall/tgx) extension and [libgeos](https://libgeos.org/) to provide advanced geometry operations, such as topological unions and conversions between TG and GEOS geometry formats. This allows you to leverage the speed of TG for basic operations and the flexibility of GEOS for more complex tasks.
 
-## Polygon Indexing
+### Example: Unary Union (GEOS integration)
 
-Togo supports different polygon indexing strategies for optimized spatial operations:
+The `unary_union` method demonstrates this integration. It combines multiple geometries into a single geometry using GEOS's topological union, with all conversions handled automatically:
 
 ```python
-from togo import TGIndex, set_polygon_indexing_mode
+from togo import Geometry, Point, Poly, Ring
 
-# Set the indexing mode
-set_polygon_indexing_mode(TGIndex.NATURAL)  # or NONE, YSTRIPES
+# Create several polygons
+poly1 = Poly(Ring([(0,0), (2,0), (2,2), (0,2), (0,0)]))
+poly2 = Poly(Ring([(1,1), (3,1), (3,3), (1,3), (1,1)]))
+
+# Perform unary union (requires tgx and libgeos)
+union = Geometry.unary_union([poly1, poly2])
+
+# The result is a single geometry representing the union of the input polygons
+print(union.to_wkt())
 ```
 
+This operation uses `tgx` to convert `TG` geometries to `GEOS`, applies the union in `libgeos`, and converts the result back to `TG` format for further use in `ToGo`.
+
 ## Performance Considerations
 
 - Togo is optimized for speed and memory efficiency

togo-0.1.5.dist-info/RECORD

@@ -0,0 +1,8 @@
+togo.cpython-38-x86_64-linux-gnu.so,sha256=0_s1l8CE1A6M2aIJFA3Bukyddc__SdBsIAQwu8YRiwA,9413729
+togo.libs/libgcc_s-0cd532bd.so.1,sha256=yPk0-VjyKzucjnkP3mvC0vVaua6Ln17qZUJbICcXgtA,181737
+togo.libs/libstdc++-5d72f927.so.6.0.33,sha256=fogxHsmB1_D6C-a_-uHh8Ei_6Qh52a8vLlicJRM3ehk,3562401
+togo-0.1.5.dist-info/LICENSE,sha256=OfTFHFMDSt9X89g-BWUVis-GuTPWAdjplg2z9d2dBCw,1073
+togo-0.1.5.dist-info/METADATA,sha256=u3TsXridgsfSPM-9uW6cEvfXMe4pc2lB7se3D9guiOA,7683
+togo-0.1.5.dist-info/WHEEL,sha256=AtKzrIIwO6LyEQPNa-CKogjoLSeXFnST8-hqmpwwZQA,110
+togo-0.1.5.dist-info/top_level.txt,sha256=bldd6tssR8THqoSDFauQQdh_pg79DMHBDhiNKgS4ttM,5
+togo-0.1.5.dist-info/RECORD,,

togo-0.1.2.dist-info/RECORD

@@ -1,6 +0,0 @@
-togo.cpython-38-x86_64-linux-gnu.so,sha256=H_MJ0aPGj3-sVpLBX38PjiYDtBl_cJ1-466sE4RZGls,2616296
-togo-0.1.2.dist-info/LICENSE,sha256=OfTFHFMDSt9X89g-BWUVis-GuTPWAdjplg2z9d2dBCw,1073
-togo-0.1.2.dist-info/METADATA,sha256=g_-jjPQBASw6rWSrqArK8Ad9VHx14-oiegCsedd7Nm8,4897
-togo-0.1.2.dist-info/WHEEL,sha256=AtKzrIIwO6LyEQPNa-CKogjoLSeXFnST8-hqmpwwZQA,110
-togo-0.1.2.dist-info/top_level.txt,sha256=bldd6tssR8THqoSDFauQQdh_pg79DMHBDhiNKgS4ttM,5
-togo-0.1.2.dist-info/RECORD,,