Structure a prepared folder

Co-authored-by: Rafael Schouten <rafael.schouten@gmail.com>

Author: asinghvi17

src/GeometryOps.jl

@@ -46,10 +46,15 @@ include("utils/LoopStateMachine/LoopStateMachine.jl") # Utils for functions that
 include("utils/SpatialTreeInterface/SpatialTreeInterface.jl") # Utils for spatial trees
 include("utils/NaturalIndexing.jl") # Utils for natural indexing
 include("utils/utils.jl") # More general utility functions
-
 # Load utility modules in
 using .NaturalIndexing, .SpatialTreeInterface, .LoopStateMachine
 
+# Preparations and prepared geometry
+include("preparations/preparations.jl")
+include("preparations/monotone_chain.jl")
+
+# Methods - things that don't change the contents
+# of the geometry
 include("methods/angles.jl")
 include("methods/area.jl")
 include("methods/barycentric.jl")
@@ -78,6 +83,8 @@ include("methods/geom_relations/within.jl")
 include("methods/orientation.jl")
 include("methods/polygonize.jl")
 
+# Transformations - things that return a copy of the input geometry,
+# but transformed in some way.
 include("transformations/extent.jl")
 include("transformations/flip.jl")
 include("transformations/reproject.jl")

src/preparations/monotone_chain.jl

@@ -0,0 +1,10 @@
+#=
+# Monotone chain
+
+A monotone chain is a continuous list of edges whose slopes are _monotonic_, i.e. all oriented towards the same quadrant.
+
+This speeds up polygon set operations and boolean ops tremendously, since it allows us to skip a lot of the expensive `O(n^2)` operations.
+
+## Example
+=#
+

src/preparations/preparations.jl

@@ -0,0 +1,56 @@
+struct Prepared{Pa,Pr}
+    parent::Pa
+    preparations::Pr
+end
+
+Base.parent(x::Prepared) = x.parent
+@inline getprep(p::Prepared, x::Symbol) = getproperty(p.preparations, x)
+
+GI.trait(p::Prepared) = GI.trait(parent(p))
+GI.geomtrait(p::Prepared) = GI.geomtrait(parent(p))
+
+GI.isgeometry(::Type{<:Prepared{T}}) where {T} = GI.isgeometry(T)
+GI.isfeature(::Type{<:Prepared{T}}) where {T} = GI.isfeature(T)
+GI.isfeaturecollection(::Type{<:Prepared{T}}) where {T} = GI.isfeaturecollection(T)
+
+GI.geometry(x::Prepared) = GI.geometry(parent(x))
+GI.properties(x::Prepared) = GI.properties(parent(x)) 
+
+for f in (:extent, :crs)
+    @eval GI.$f(t::GI.AbstractTrait, x::Prepared) = GI.$f(t, parent(x))
+end
+for f in (:coordnames, :is3d, :ismeasured, :isempty, :coordinates, :getgeom)
+    @eval GI.$f(t::GI.AbstractGeometryTrait, geom::Prepared, args...) = GI.$f(t, parent(geom), args...)
+end
+
+for f in (:x, :y, :z, :m, :coordinates, :getcoord, :ngeom, :getgeom)
+    @eval GI.$f(t::GI.AbstractPointTrait, geom::Prepared, args...) = GI.$f(t, parent(geom), args...)
+end
+for f in (:npoint, :getpoint, :startpoint, :endpoint, :npoint, :issimple, :isclosed, :isring)
+    @eval GI.$f(t::GI.AbstractCurveTrait, geom::Prepared, args...) = GI.$f(t, parent(geom), args...)
+end
+for f in (:nring, :getring, :getexterior, :nhole, :gethole, :npoint, :getpoint, :startpoint, :endpoint)
+    @eval GI.$f(t::GI.AbstractPolygonTrait, geom::Prepared, args...) = GI.$f(t, parent(geom), args...)
+end
+for f in (:npoint, :getpoint, :issimple)
+    @eval GI.$f(t::GI.AbstractMultiPointTrait, geom::Prepared, args...) = GI.$f(t, parent(geom), args...)
+    @eval GI.$f(t::GI.AbstractMultiCurveTrait, geom::Prepared, args...) = GI.$f(t, parent(geom), args...)
+end
+for f in (:nring, :getring, :npoint, :getpoint)
+    @eval GI.$f(t::GI.AbstractMultiPolygonTrait, geom::Prepared, args...) = GI.$f(t, parent(geom), args...)
+end
+
+getpoint(t::GI.AbstractPolyhedralSurfaceTrait, geom::Prepared) = GI.getpoint(t, parent(geom))
+isclosed(t::GI.AbstractMultiCurveTrait, geom::Prepared) = GI.isclosed(t, parent(geom))
+
+for f in (:getfeature, :coordinates)
+    @eval GI.$f(t::GI.AbstractFeatureTrait, geom::Prepared, args...) = $f(t, parent(geom), args...)
+end
+
+# Ambiguity
+for T in (:LineTrait, :TriangleTrait, :PentagonTrait, :HexagonTrait, :RectangleTrait, :QuadTrait)
+    @eval GI.npoint(t::GI.$T, geom::Prepared) = GI.npoint(t, parent(geom))
+end
+for T in (:RectangleTrait, :QuadTrait, :PentagonTrait, :HexagonTrait, :TriangleTrait)
+    @eval GI.nring(t::GI.$T, geom::Prepared) = GI.nring(t, parent(geom))
+end

src/preparations/rtree.jl

@@ -0,0 +1,7 @@
+#=
+# RTree/STRtree
+
+An interface for any arbitrary RTree/STRtree.  This should allow reconstruction from SQL like databases.
+
+Applicable to geometrycollections, multi geometries, and feature collections.
+=#

src/preparations/sorted_edge_list.jl

@@ -0,0 +1,7 @@
+#=
+# Sorted edge list
+
+Soted edge lists are essentially the edges of the linestring, linearring, or polygon, sorted by the initial `y` coordinate.
+
+## Example
+=#