<linkrel="alternate icon"type="image/png"href="../favicon-32x32.png"><styletype="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><bodyclass="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="sidebar"><divclass="sidebar-menu">☰</div><ahref='../geom/index.html'><divclass='logo-container rust-logo'><imgsrc='../rust-logo.png'alt='logo'></div></a><pclass="location">Struct FindClosest</p><divclass="sidebar-elems"><divclass="block items"><aclass="sidebar-title"href="#fields">Fields</a><divclass="sidebar-links"><ahref="#structfield.geometries">geometries</a><ahref="#structfield.quadtree">quadtree</a></div><aclass="sidebar-title"href="#implementations">Methods</a><divclass="sidebar-links"><ahref="#method.add">add</a><ahref="#method.all_close_pts">all_close_pts</a><ahref="#method.closest_pt">closest_pt</a><ahref="#method.new">new</a></div><aclass="sidebar-title"href="#synthetic-implementations">Auto Trait Implementations</a><divclass="sidebar-links"><ahref="#impl-RefUnwindSafe">RefUnwindSafe</a><ahref="#impl-Send">Send</a><ahref="#impl-Sync">Sync</a><ahref="#impl-Unpin">Unpin</a><ahref="#impl-UnwindSafe">UnwindSafe</a></div><aclass="sidebar-title"href="#blanket-implementations">Blanket Implementations</a><divclass="sidebar-links"><ahref="#impl-Any">Any</a><ahref="#impl-Borrow%3CT%3E">Borrow<T></a><ahref="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><ahref="#impl-From%3CT%3E">From<T></a><ahref="#impl-Into%3CU%3E">Into<U></a><ahref="#impl-Same%3CT%3E">Same<T></a><ahref="#impl-TryFrom%3CU%3E">TryFrom<U></a><ahref="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><pclass="location"><ahref="index.html">geom</a></p><divid="sidebar-vars"data-name="FindClosest"data-ty="struct"data-relpath=""></div><scriptdefersrc="sidebar-items.js"></script></div></nav><divclass="theme-picker"><buttonid="theme-picker"aria-label="Pick another theme!"aria-haspopup="menu"><imgsrc="../brush.svg"width="18"alt="Pick another theme!"></button><divid="theme-choices"role="menu"></div></div><scriptsrc="../theme.js"></script><navclass="sub"><formclass="search-form"><divclass="search-container"><div><selectid="crate-search"><optionvalue="All crates">All crates</option></select><inputclass="search-input"name="search"disabledautocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"></div><buttontype="button"class="help-button">?</button>
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/nightly/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/nightly/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><h3id="impl"class="impl"><codeclass="in-band">impl<K><aclass="struct"href="../geom/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/nightly/core/clone/trait.Clone.html"title="trait core::clone::Clone">Clone</a> + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html"title="trait core::cmp::Ord">Ord</a> + <aclass="trait"href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html"title="trait core::fmt::Debug">Debug</a>, </span></code><ahref="#impl"class="anchor"></a><aclass="srclink"href="../src/geom/find_closest.rs.html#19-87"title="goto source code">[src]</a></h3><divclass="impl-items"><h4id="method.new"class="method"><code>pub fn <ahref="#method.new"class="fnname">new</a>(bounds: &<aclass="struct"href="../geom/bounds/struct.Bounds.html"title="struct geom::bounds::Bounds">Bounds</a>) -><aclass="struct"href="../geom/find_closest/struct.FindClosest.html"title="struct geom::find_closest::FindClosest">FindClosest</a><K></code><aclass="srclink"href="../src/geom/find_closest.rs.html#24-29"title="goto source code">[src]</a></h4><divclass="docblock"><p>Creates the quad-tree, limited to points contained in the boundary.</p>
</div><h4id="method.add"class="method"><code>pub fn <ahref="#method.add"class="fnname">add</a>(&mut self, key: K, pts: &<aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><<aclass="struct"href="../geom/pt/struct.Pt2D.html"title="struct geom::pt::Pt2D">Pt2D</a>>)</code><aclass="srclink"href="../src/geom/find_closest.rs.html#32-36"title="goto source code">[src]</a></h4><divclass="docblock"><p>Add an object to the quadtree, remembering some key associated with the points.</p>
</div><h4id="method.all_close_pts"class="method"><code>pub fn <ahref="#method.all_close_pts"class="fnname">all_close_pts</a>(<br> &self, <br> query_pt: <aclass="struct"href="../geom/pt/struct.Pt2D.html"title="struct geom::pt::Pt2D">Pt2D</a>, <br> max_dist_away: <aclass="struct"href="../geom/distance/struct.Distance.html"title="struct geom::distance::Distance">Distance</a><br>) -><aclass="struct"href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html"title="struct alloc::vec::Vec">Vec</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>K, <aclass="struct"href="../geom/pt/struct.Pt2D.html"title="struct geom::pt::Pt2D">Pt2D</a>, <aclass="struct"href="../geom/distance/struct.Distance.html"title="struct geom::distance::Distance">Distance</a><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><aclass="srclink"href="../src/geom/find_closest.rs.html#40-78"title="goto source code">[src]</a></h4><divclass="docblock"><p>For every object within some distance of a query point, return the (object's key, point on
</div><h4id="method.closest_pt"class="method"><code>pub fn <ahref="#method.closest_pt"class="fnname">closest_pt</a>(<br> &self, <br> query_pt: <aclass="struct"href="../geom/pt/struct.Pt2D.html"title="struct geom::pt::Pt2D">Pt2D</a>, <br> max_dist_away: <aclass="struct"href="../geom/distance/struct.Distance.html"title="struct geom::distance::Distance">Distance</a><br>) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html"title="enum core::option::Option">Option</a><<aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>K, <aclass="struct"href="../geom/pt/struct.Pt2D.html"title="struct geom::pt::Pt2D">Pt2D</a><aclass="primitive"href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>></code><aclass="srclink"href="../src/geom/find_closest.rs.html#81-86"title="goto source code">[src]</a></h4><divclass="docblock"><p>Finds the closest point on the existing geometry to the query pt.</p>
</div></div><h3id="impl-Same%3CT%3E"class="impl"><codeclass="in-band">impl<T> Same<T> for T</code><ahref="#impl-Same%3CT%3E"class="anchor"></a></h3><divclass="impl-items"><h4id="associatedtype.Output"class="type"><code>type <ahref="#associatedtype.Output"class="type">Output</a> = T</code></h4><divclass='docblock'><p>Should always be <code>Self</code></p>
</div></div><h3id="impl-TryFrom%3CU%3E"class="impl"><codeclass="in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.Into.html"title="trait core::convert::Into">Into</a><T>, </span></code><ahref="#impl-TryFrom%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#582-591"title="goto source code">[src]</a></h3><divclass="impl-items"><h4id="associatedtype.Error"class="type"><code>type <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"class="type">Error</a> = <aclass="enum"href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html"title="enum core::convert::Infallible">Infallible</a></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id="method.try_from"class="method hidden"><code>pub fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from"class="fnname">try_from</a>(value: U) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><T, <T as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><U>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#588"title="goto source code">[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3id="impl-TryInto%3CU%3E"class="impl"><codeclass="in-band">impl<T, U><aclass="trait"href="https://doc.rust-lang.org/nightly/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/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><ahref="#impl-TryInto%3CU%3E"class="anchor"></a><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#568-577"title="goto source code">[src]</a></h3><divclass="impl-items"><h4id="associatedtype.Error-1"class="type"><code>type <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error"class="type">Error</a> = <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a></code></h4><divclass='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4id="method.try_into"class="method hidden"><code>pub fn <ahref="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into"class="fnname">try_into</a>(self) -><aclass="enum"href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html"title="enum core::result::Result">Result</a><U, <U as <aclass="trait"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html"title="trait core::convert::TryFrom">TryFrom</a><T>>::<aclass="type"href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error"title="type core::convert::TryFrom::Error">Error</a>></code><aclass="srclink"href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#574"title="goto source code">[src]</a></h4><divclass='docblock hidden'><p>Performs the conversion.</p>