<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="A quad-tree to quickly find the closest points to some polylines."><metaname="keywords"content="rust, rustlang, rust-lang, FindClosest"><title>FindClosest in geom - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Regular.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../FiraSans-Medium.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Regular.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceSerif4-Bold.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../SourceCodePro-Semibold.ttf.woff2"><linkrel="stylesheet"type="text/css"href="../normalize.css"><linkrel="stylesheet"type="text/css"href="../rustdoc.css"id="mainThemeStyle"><linkrel="stylesheet"type="text/css"href="../ayu.css"disabled><linkrel="stylesheet"type="text/css"href="../dark.css"disabled><linkrel="stylesheet"type="text/css"href="../light.css"id="themeStyle"><scriptid="default-settings"></script><scriptsrc="../storage.js"></script><scriptsrc="../crates.js"></script><scriptdefersrc="../main.js"></script>
<noscript><linkrel="stylesheet"href="../noscript.css"></noscript><linkrel="alternate icon"type="image/png"href="../favicon-16x16.png"><linkrel="alternate icon"type="image/png"href="../favicon-32x32.png"><linkrel="icon"type="image/svg+xml"href="../favicon.svg"></head><bodyclass="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle">☰</button><aclass="sidebar-logo"href="../geom/index.html"><divclass="logo-container"><imgclass="rust-logo"src="../rust-logo.svg"alt="logo"></div>
</a><h2class="location"><ahref="#">FindClosest</a></h2><divclass="sidebar-elems"><section><divclass="block"><h3class="sidebar-title"><ahref="#fields">Fields</a></h3><ul><li><ahref="#structfield.geometries">geometries</a></li><li><ahref="#structfield.quadtree">quadtree</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#implementations">Methods</a></h3><ul><li><ahref="#method.add">add</a></li><li><ahref="#method.all_close_pts">all_close_pts</a></li><li><ahref="#method.closest_pt">closest_pt</a></li><li><ahref="#method.new">new</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#synthetic-implementations">Auto Trait Implementations</a></h3><ul><li><ahref="#impl-RefUnwindSafe">RefUnwindSafe</a></li><li><ahref="#impl-Send">Send</a></li><li><ahref="#impl-Sync">Sync</a></li><li><ahref="#impl-Unpin">Unpin</a></li><li><ahref="#impl-UnwindSafe">UnwindSafe</a></li></ul></div><divclass="block"><h3class="sidebar-title"><ahref="#blanket-implementations">Blanket Implementations</a></h3><ul><li><ahref="#impl-Any">Any</a></li><li><ahref="#impl-Borrow%3CT%3E">Borrow<T></a></li><li><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a></li><li><ahref="#impl-From%3CT%3E">From<T></a></li><li><ahref="#impl-Into%3CU%3E">Into<U></a></li><li><ahref="#impl-Same%3CT%3E">Same<T></a></li><li><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a></li><li><ahref="#impl-TryInto%3CU%3E">TryInto<U></a></li></ul></div></section><h2class="location"><ahref="index.html">In geom</a></h2><divid="sidebar-vars"data-name="FindClosest"data-ty="struct"data-relpath=""></div><scriptdefersrc="sidebar-items.js"></script></div></nav><main><divclass="width-limiter"><divclass="sub-container"><aclass="sub-logo-container"href="../geom/index.html"><imgclass="rust-logo"src="../rust-logo.svg"alt="logo"></a><navclass="sub"><divclass="theme-picker hidden"><buttonid="theme-picker"aria-label="Pick another theme!"aria-haspopup="menu"title="themes"><imgwidth="22"height="22"alt="Pick another theme!"src="../brush.svg"></button><divid="theme-choices"role="menu"></div></div><formclass="search-form"><divclass="search-container"><span></span><inputclass="search-input"name="search"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><buttontype="button"id="help-button"title="help">?</button><aid="settings-menu"href="../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../wheel.svg"></a></div></form></nav></div><sectionid="main-content"class="content"><divclass="main-heading">
}</code></pre></div><detailsclass="rustdoc-toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>A quad-tree to quickly find the closest points to some polylines.</p>
</div></details><h2id="fields"class="fields small-section-header">Fields<ahref="#fields"class="anchor"></a></h2><spanid="structfield.geometries"class="structfield small-section-header"><ahref="#structfield.geometries"class="anchor field"></a><code>geometries: <aclass="struct"href="https://doc.rust-lang.org/1.61.0/alloc/collections/btree/map/struct.BTreeMap.html"title="struct alloc::collections::btree::map::BTreeMap">BTreeMap</a><K, LineString<<aclass="primitive"href="https://doc.rust-lang.org/1.61.0/std/primitive.f64.html">f64</a>>></code></span><spanid="structfield.quadtree"class="structfield small-section-header"><ahref="#structfield.quadtree"class="anchor field"></a><code>quadtree: QuadTree<K></code></span><h2id="implementations"class="small-section-header">Implementations<ahref="#implementations"class="anchor"></a></h2><divid="implementations-list"><detailsclass="rustdoc-toggle implementors-toggle"open><summary><sectionid="impl"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/geom/find_closest.rs.html#19-89">source</a></span><ahref="#impl"class="anchor"></a><h3class="code-header in-band">impl<K><aclass="struct"href="find_closest/struct.FindClosest.html"title="struct geom::find_closest::FindClosest">FindClosest</a><K><spanclass="where fmt-newline">where<br> K: <aclass="trait"href="https://doc.rust-lang.org/1.61.0/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> + <aclass="trait"href="https://doc.rust-lang.org/1.61.0/core/cmp/trait.Ord.html"title="trait core::cmp::Ord">Ord</a> + <aclass="trait"href="https://doc.rust-lang.org/1.61.0/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.new"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/geom/find_closest.rs.html#24-29">source</a></span><ahref="#method.new"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.new"class="fnname">new</a>(bounds: &<aclass="struct"href="bounds/struct.Bounds.html"title="struct geom::bounds::Bounds">Bounds</a>) -><aclass="struct"href="find_closest/struct.FindClosest.html"title="struct geom::find_closest::FindClosest">FindClosest</a><K></h4></section></summary><divclass="docblock"><p>Creates the quad-tree, limited to points contained in the boundary.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.add"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/geom/find_closest.rs.html#34-38">source</a></span><ahref="#method.add"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.add"class="fnname">add</a>(&mut self, key: K, pts: <aclass="primitive"href="https://doc.rust-lang.org/1.61.0/std/primitive.slice.html">&[</a><aclass="struct"href="pt/struct.Pt2D.html"title="struct geom::pt::Pt2D">Pt2D</a><aclass="primitive"href="https://doc.rust-lang.org/1.61.0/std/primitive.slice.html">]</a>)</h4></section></summary><divclass="docblock"><p>Add an object to the quadtree, remembering some key associated with the points.
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.all_close_pts"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/geom/find_closest.rs.html#42-80">source</a></span><ahref="#method.all_close_pts"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.all_close_pts"class="fnname">all_close_pts</a>(<br> &self, <br> query_pt: <aclass="struct"href="pt/struct.Pt2D.html"title="struct geom::pt::Pt2D">Pt2D</a>, <br> max_dist_away: <aclass="struct"href="distance/struct.Distance.html"title="struct geom::distance::Distance">Distance</a><br>) -><aclass="struct"href="https://doc.rust-lang.org/1.61.0/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><<aclass="primitive"href="https://doc.rust-lang.org/1.61.0/std/primitive.tuple.html">(</a>K, <aclass="struct"href="pt/struct.Pt2D.html"title="struct geom::pt::Pt2D">Pt2D</a>, <aclass="struct"href="distance/struct.Distance.html"title="struct geom::distance::Distance">Distance</a><aclass="primitive"href="https://doc.rust-lang.org/1.61.0/std/primitive.tuple.html">)</a>><spanclass="notable-traits"><spanclass="notable-traits-tooltip">ⓘ<spanclass="notable-traits-tooltiptext"><spanclass="docblock"><spanclass="notable">Notable traits for <aclass="struct"href="https://doc.rust-lang.org/1.61.0/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><<aclass="primitive"href="https://doc.rust-lang.org/1.61.0/std/primitive.u8.html">u8</a>, A></span><codeclass="content"><spanclass="where fmt-newline">impl<A><aclass="trait"href="https://doc.rust-lang.org/1.61.0/std/io/trait.Write.html"title="trait std::io::Write">Write</a> for <aclass="struct"href="https://doc.rust-lang.org/1.61.0/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><<aclass="primitive"href="https://doc.rust-lang.org/1.61.0/std/primitive.u8.html">u8</a>, A><spanclass="where fmt-newline">where<br> A: <aclass="trait"href="https://doc.rust-lang.org/1.61.0/core/alloc/trait.Allocator.html"title="trait core::alloc::Allocator">Allocator</a>, </span></span></code></span></span></span></span></h4></section></summary><divclass="docblock"><p>For every object within some distance of a query point, return the (object’s key, point on
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.closest_pt"class="method has-srclink"><spanclass="rightside"><aclass="srclink"href="../src/geom/find_closest.rs.html#83-88">source</a></span><ahref="#method.closest_pt"class="anchor"></a><h4class="code-header">pub fn <ahref="#method.closest_pt"class="fnname">closest_pt</a>(<br> &self, <br> query_pt: <aclass="struct"href="pt/struct.Pt2D.html"title="struct geom::pt::Pt2D">Pt2D</a>, <br> max_dist_away: <aclass="struct"href="distance/struct.Distance.html"title="struct geom::distance::Distance">Distance</a><br>) -><aclass="enum"href="https://doc.rust-lang.org/1.61.0/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="primitive"href="https://doc.rust-lang.org/1.61.0/std/primitive.tuple.html">(</a>K, <aclass="struct"href="pt/struct.Pt2D.html"title="struct geom::pt::Pt2D">Pt2D</a><aclass="primitive"href="https://doc.rust-lang.org/1.61.0/std/primitive.tuple.html">)</a>></h4></section></summary><divclass="docblock"><p>Finds the closest point on the existing geometry to the query pt.</p>
<code><ahref="https://doc.rust-lang.org/1.61.0/core/convert/trait.From.html"title="From">From</a><T> for U</code> chooses to do.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-Same%3CT%3E"class="impl has-srclink"><ahref="#impl-Same%3CT%3E"class="anchor"></a><h3class="code-header in-band">impl<T> Same<T> for T</h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Output"class="type trait-impl has-srclink"><ahref="#associatedtype.Output"class="anchor"></a><h4class="code-header">type <ahref="#associatedtype.Output"class="associatedtype">Output</a> = T</h4></section></summary><divclass='docblock'><p>Should always be <code>Self</code></p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-TryFrom%3CU%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.61.0/src/core/convert/mod.rs.html#598-607">source</a></span><ahref="#impl-TryFrom%3CU%3E"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.61.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.61.0/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error"class="type trait-impl has-srclink"><ahref="#associatedtype.Error"class="anchor"></a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.61.0/core/convert/trait.TryFrom.html#associatedtype.Error"class="associatedtype">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/1.61.0/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></h4></section></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.try_from"class="method trait-impl has-srclink"><spanclass="rightside"><spanclass="since"title="const unstable">const: <ahref="https://github.com/rust-lang/rust/issues/88674"title="Tracking issue for const_convert">unstable</a></span> · <aclass="srclink"href="https://doc.rust-lang.org/1.61.0/src/core/convert/mod.rs.html#604">source</a></span><ahref="#method.try_from"class="anchor"></a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.61.0/core/convert/trait.TryFrom.html#tymethod.try_from"class="fnname">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/1.61.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/1.61.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.61.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'><p>Performs the conversion.</p>
</div></details></div></details><detailsclass="rustdoc-toggle implementors-toggle"><summary><sectionid="impl-TryInto%3CU%3E"class="impl has-srclink"><spanclass="rightside"><aclass="srclink"href="https://doc.rust-lang.org/1.61.0/src/core/convert/mod.rs.html#583-592">source</a></span><ahref="#impl-TryInto%3CU%3E"class="anchor"></a><h3class="code-header in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/1.61.0/core/convert/trait.TryInto.html"title="trait core::convert::TryInto">TryInto</a><U> for T <spanclass="where fmt-newline">where<br> U: <aclass="trait"href="https://doc.rust-lang.org/1.61.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></h3></section></summary><divclass="impl-items"><detailsclass="rustdoc-toggle"open><summary><sectionid="associatedtype.Error-1"class="type trait-impl has-srclink"><ahref="#associatedtype.Error-1"class="anchor"></a><h4class="code-header">type <ahref="https://doc.rust-lang.org/1.61.0/core/convert/trait.TryInto.html#associatedtype.Error"class="associatedtype">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/1.61.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.61.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div></details><detailsclass="rustdoc-toggle method-toggle"open><summary><sectionid="method.try_into"class="method trait-impl has-srclink"><spanclass="rightside"><spanclass="since"title="const unstable">const: <ahref="https://github.com/rust-lang/rust/issues/88674"title="Tracking issue for const_convert">unstable</a></span> · <aclass="srclink"href="https://doc.rust-lang.org/1.61.0/src/core/convert/mod.rs.html#589">source</a></span><ahref="#method.try_into"class="anchor"></a><h4class="code-header">fn <ahref="https://doc.rust-lang.org/1.61.0/core/convert/trait.TryInto.html#tymethod.try_into"class="fnname">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/1.61.0/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/1.61.0/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="associatedtype"href="https://doc.rust-lang.org/1.61.0/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><divclass='docblock'><p>Performs the conversion.</p>
