|
4 | 4 | //!
|
5 | 5 | //! # Types
|
6 | 6 | //!
|
7 |
| -//! - **[`Coord`]**: A two-dimensional coordinate. All geometry types are composed of [`Coord`]s, though [`Coord`] itself is not a [`Geometry`] type. |
| 7 | +//! - **[`Coord`]**: A two-dimensional coordinate. All geometry types are composed of [`Coord`]s, though [`Coord`] itself is not a [`Geometry`] type |
8 | 8 | //! - **[`Point`]**: A single point represented by one [`Coord`]
|
9 | 9 | //! - **[`MultiPoint`]**: A collection of [`Point`]s
|
10 | 10 | //! - **[`Line`]**: A line segment represented by two [`Coord`]s
|
|
87 | 87 | //! - **[`ClosestPoint`]**: Find the point on a geometry
|
88 | 88 | //! closest to a given point
|
89 | 89 | //! - **[`HaversineClosestPoint`]**: Find the point on a geometry
|
90 |
| -//! closest to a given point on a sphere using spherical coordinates and lines being great arcs. |
| 90 | +//! closest to a given point on a sphere using spherical coordinates and lines being great arcs |
91 | 91 | //! - **[`IsConvex`]**: Calculate the convexity of a
|
92 | 92 | //! [`LineString`]
|
93 | 93 | //! - **[`LineInterpolatePoint`]**:
|
|
106 | 106 | //! - **[`Intersects`]**: Calculate if a geometry intersects
|
107 | 107 | //! another geometry
|
108 | 108 | //! - **[`line_intersection`]**: Calculates the
|
109 |
| -//! intersection, if any, between two lines. |
| 109 | +//! intersection, if any, between two lines |
110 | 110 | //! - **[`Relate`]**: Topologically relate two geometries based on
|
111 |
| -//! [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM) semantics. |
112 |
| -//! - **[`Within`]**: Calculate if a geometry lies completely within another geometry. |
| 111 | +//! [DE-9IM](https://en.wikipedia.org/wiki/DE-9IM) semantics |
| 112 | +//! - **[`Within`]**: Calculate if a geometry lies completely within another geometry |
113 | 113 | //!
|
114 | 114 | //! ## Triangulation
|
115 | 115 | //!
|
116 |
| -//! - **[`TriangulateEarcut`](triangulate_earcut)**: Triangulate polygons using the earcut algorithm. Requires the `"earcutr"` feature, which is enabled by default. |
| 116 | +//! - **[`TriangulateEarcut`](triangulate_earcut)**: Triangulate polygons using the earcut algorithm. Requires the `"earcutr"` feature, which is enabled by default |
117 | 117 | //!
|
118 | 118 | //! ## Winding
|
119 | 119 | //!
|
|
154 | 154 | //!
|
155 | 155 | //! - **[`Convert`]**: Convert (infalliby) the numeric type of a geometry’s coordinate value
|
156 | 156 | //! - **[`TryConvert`]**: Convert (falliby) the numeric type of a geometry’s coordinate value
|
157 |
| -//! - **[`ToDegrees`]**: Radians to degrees coordinate transforms for a given geometry. |
158 |
| -//! - **[`ToRadians`]**: Degrees to radians coordinate transforms for a given geometry. |
| 157 | +//! - **[`ToDegrees`]**: Radians to degrees coordinate transforms for a given geometry |
| 158 | +//! - **[`ToRadians`]**: Degrees to radians coordinate transforms for a given geometry |
159 | 159 | //!
|
160 | 160 | //! ## Miscellaneous
|
161 | 161 | //!
|
162 | 162 | //! - **[`Centroid`]**: Calculate the centroid of a geometry
|
163 |
| -//! - **[`ChaikinSmoothing`]**: Smoothen `LineString`, `Polygon`, `MultiLineString` and `MultiPolygon` using Chaikin's algorithm. |
| 163 | +//! - **[`ChaikinSmoothing`]**: Smoothen `LineString`, `Polygon`, `MultiLineString` and `MultiPolygon` using Chaikin's algorithm |
164 | 164 | //! - **[`proj`]**: Project geometries with the `proj` crate (requires the `use-proj` feature)
|
165 |
| -//! - **[`LineStringSegmentize`]**: Segment a LineString into `n` segments. |
166 |
| -//! - **[`LineStringSegmentizeHaversine`]**: Segment a LineString using Haversine distance. |
167 |
| -//! - **[`Transform`]**: Transform a geometry using Proj. |
168 |
| -//! - **[`RemoveRepeatedPoints`]**: Remove repeated points from a geometry. |
| 165 | +//! - **[`LineStringSegmentize`]**: Segment a LineString into `n` segments |
| 166 | +//! - **[`LineStringSegmentizeHaversine`]**: Segment a LineString using Haversine distance |
| 167 | +//! - **[`Transform`]**: Transform a geometry using Proj |
| 168 | +//! - **[`RemoveRepeatedPoints`]**: Remove repeated points from a geometry |
169 | 169 | //!
|
170 | 170 | //! # Spatial Indexing
|
171 | 171 | //!
|
|
179 | 179 | //! The following optional [Cargo features] are available:
|
180 | 180 | //!
|
181 | 181 | //! - `earcutr`:
|
182 |
| -//! - Enables the `earcutr` crate, which provides triangulation of polygons using the earcut algorithm. |
183 |
| -//! - ☑ Enabled by default. |
| 182 | +//! - Enables the `earcutr` crate, which provides triangulation of polygons using the earcut algorithm |
| 183 | +//! - ☑ Enabled by default |
184 | 184 | //! - `proj-network`:
|
185 |
| -//! - Enables [network grid] support for the [`proj` crate]. |
| 185 | +//! - Enables [network grid] support for the [`proj` crate] |
186 | 186 | //! - After enabling this feature, [further configuration][proj crate file download] is required to use the network grid.
|
187 |
| -//! - ☐ Disabled by default. |
| 187 | +//! - ☐ Disabled by default |
188 | 188 | //! - `use-proj`:
|
189 | 189 | //! - Enables coordinate conversion and transformation of `Point` geometries using the [`proj` crate]
|
190 |
| -//! - ☐ Disabled by default. |
| 190 | +//! - ☐ Disabled by default |
191 | 191 | //! - `use-serde`:
|
192 |
| -//! - Allows geometry types to be serialized and deserialized with [Serde]. |
193 |
| -//! - ☐ Disabled by default. |
| 192 | +//! - Allows geometry types to be serialized and deserialized with [Serde] |
| 193 | +//! - ☐ Disabled by default |
194 | 194 | //! - `multithreading`:
|
195 | 195 | //! - Enables multithreading support (via Rayon), and activates the `multithreading` flag
|
196 |
| -//! in `geo-types`, enabling multi-threaded iteration over `Multi*` geometries. |
197 |
| -//! - ☑ Enabled by default. |
| 196 | +//! in `geo-types`, enabling multi-threaded iteration over `Multi*` geometries |
| 197 | +//! - ☑ Enabled by default |
198 | 198 | //!
|
199 | 199 | //! # Ecosystem
|
200 | 200 | //!
|
|
0 commit comments