abstreet/rustdoc/map_model/pathfind/index.html
2022-05-21 16:24:57 +00:00

25 lines
12 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Everything related to pathfinding through a map for different types of agents."><meta name="keywords" content="rust, rustlang, rust-lang, pathfind"><title>map_model::pathfind - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script src="../../crates.js"></script><script defer src="../../main.js"></script>
<noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../map_model/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"></h2>
</nav>
<nav class="sidebar"><a class="sidebar-logo" href="../../map_model/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div>
</a><h2 class="location"><a href="#">Module pathfind</a></h2><div class="sidebar-elems"><section><div class="block"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li></ul></div></section><div id="sidebar-vars" data-name="pathfind" data-ty="mod" data-relpath="./"></div><script defer src="./sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../map_model/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">Module <a href="../index.html">map_model</a>::<wbr><a class="mod" href="#">pathfind</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span></h1><span class="out-of-band"><a class="srclink" href="../../src/map_model/pathfind/mod.rs.html#1-230">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Everything related to pathfinding through a map for different types of agents.</p>
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left import-item"><code>pub use self::engine::<a class="enum" href="engine/enum.CreateEngine.html" title="enum map_model::pathfind::engine::CreateEngine">CreateEngine</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use self::pathfinder::<a class="struct" href="pathfinder/struct.Pathfinder.html" title="struct map_model::pathfind::pathfinder::Pathfinder">Pathfinder</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use self::pathfinder::<a class="struct" href="pathfinder/struct.PathfinderCache.html" title="struct map_model::pathfind::pathfinder::PathfinderCache">PathfinderCache</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use self::pathfinder::<a class="enum" href="pathfinder/enum.PathfinderCaching.html" title="enum map_model::pathfind::pathfinder::PathfinderCaching">PathfinderCaching</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use self::v1::<a class="struct" href="v1/struct.Path.html" title="struct map_model::pathfind::v1::Path">Path</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use self::v1::<a class="struct" href="v1/struct.PathRequest.html" title="struct map_model::pathfind::v1::PathRequest">PathRequest</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use self::v1::<a class="enum" href="v1/enum.PathStep.html" title="enum map_model::pathfind::v1::PathStep">PathStep</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use self::v2::<a class="enum" href="v2/enum.PathStepV2.html" title="enum map_model::pathfind::v2::PathStepV2">PathStepV2</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use self::v2::<a class="struct" href="v2/struct.PathV2.html" title="struct map_model::pathfind::v2::PathV2">PathV2</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use self::vehicles::<a class="fn" href="../connectivity/fn.vehicle_cost.html" title="fn map_model::connectivity::vehicle_cost">vehicle_cost</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use self::walking::<a class="enum" href="../connectivity/enum.WalkingNode.html" title="enum map_model::connectivity::WalkingNode">WalkingNode</a>;</code></div><div class="item-right docblock-short"></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="engine/index.html" title="map_model::pathfind::engine mod">engine</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="node_map/index.html" title="map_model::pathfind::node_map mod">node_map</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"><p>Some helpers for working with fast_paths.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="pathfinder/index.html" title="map_model::pathfind::pathfinder mod">pathfinder</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="uber_turns/index.html" title="map_model::pathfind::uber_turns mod">uber_turns</a></div><div class="item-right docblock-short"><p>To deal with complicated intersections and short roads in OSM, cluster intersections close
together and then calculate UberTurns that string together several turns.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="v1/index.html" title="map_model::pathfind::v1 mod">v1</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="v2/index.html" title="map_model::pathfind::v2 mod">v2</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"><p>Structures related to the new road-based pathfinding
(https://github.com/a-b-street/abstreet/issues/555) live here. When the transition is done,
things here will probably move into pathfind/mod.rs.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="vehicles/index.html" title="map_model::pathfind::vehicles mod">vehicles</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"><p>Pathfinding for cars, bikes, buses, and trains using contraction hierarchies</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="walking/index.html" title="map_model::pathfind::walking mod">walking</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"><p>Pathfinding for pedestrians, as well as figuring out if somebody should use public transit.</p>
</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RoutingParams.html" title="map_model::pathfind::RoutingParams struct">RoutingParams</a></div><div class="item-right docblock-short"><p>Tuneable parameters for all types of routing.</p>
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.PathConstraints.html" title="map_model::pathfind::PathConstraints enum">PathConstraints</a></div><div class="item-right docblock-short"><p>Whos asking for a path?</p>
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.round.html" title="map_model::pathfind::round fn">round</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.unround.html" title="map_model::pathfind::unround fn">unround</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.zone_cost.html" title="map_model::pathfind::zone_cost fn">zone_cost</a><span title="Restricted Visibility">&nbsp;🔒</span> </div><div class="item-right docblock-short"><p>Heavily penalize crossing into an access-restricted zone that doesnt allow this mode.</p>
</div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="map_model" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.61.0 (fe5b13d68 2022-05-18)" ></div>
</body></html>