abstreet/rustdoc/map_model/pathfind/index.html
2020-11-21 23:27:31 +00:00

23 lines
8.3 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="API documentation for the Rust `pathfind` mod in crate `map_model`."><meta name="keywords" content="rust, rustlang, rust-lang, pathfind"><title>map_model::pathfind - Rust</title><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="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../map_model/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module pathfind</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#reexports">Re-exports</a></li><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><p class='location'><a href='../index.html'>map_model</a></p><script>window.sidebarCurrent = {name: 'pathfind', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><span class="help-button">?</span>
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/map_model/pathfind/mod.rs.html#1-636' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>map_model</a>::<wbr><a class="mod" href=''>pathfind</a></span></h1><div class='docblock'><p>Everything related to pathfinding through a map for different types of agents.</p>
</div><h2 id='reexports' class='section-header'><a href="#reexports">Re-exports</a></h2>
<table><tr><td><code>pub use self::ch::<a class="struct" href="../../map_model/pathfind/ch/struct.ContractionHierarchyPathfinder.html" title="struct map_model::pathfind::ch::ContractionHierarchyPathfinder">ContractionHierarchyPathfinder</a>;</code></td></tr><tr><td><code>pub use self::dijkstra::<a class="fn" href="../../map_model/connectivity/fn.build_graph_for_pedestrians.html" title="fn map_model::connectivity::build_graph_for_pedestrians">build_graph_for_pedestrians</a>;</code></td></tr><tr><td><code>pub use self::dijkstra::<a class="fn" href="../../map_model/connectivity/fn.build_graph_for_vehicles.html" title="fn map_model::connectivity::build_graph_for_vehicles">build_graph_for_vehicles</a>;</code></td></tr><tr><td><code>pub use self::driving::<a class="fn" href="../../map_model/connectivity/fn.driving_cost.html" title="fn map_model::connectivity::driving_cost">driving_cost</a>;</code></td></tr><tr><td><code>pub use self::walking::<a class="fn" href="../../map_model/pathfind/walking/fn.walking_cost.html" title="fn map_model::pathfind::walking::walking_cost">walking_cost</a>;</code></td></tr><tr><td><code>pub use self::walking::<a class="enum" href="../../map_model/connectivity/enum.WalkingNode.html" title="enum map_model::connectivity::WalkingNode">WalkingNode</a>;</code></td></tr></table><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table><tr class='module-item'><td><a class="mod" href="ch/index.html" title='map_model::pathfind::ch mod'>ch</a></td><td class='docblock-short'><p>Uses https://github.com/easbar/fast_paths. Slower creation during map importing, but very fast
queries.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="dijkstra/index.html" title='map_model::pathfind::dijkstra mod'>dijkstra</a></td><td class='docblock-short'><p>Pathfinding without needing to build a separate contraction hierarchy.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="driving/index.html" title='map_model::pathfind::driving mod'>driving</a></td><td class='docblock-short'><p>Pathfinding for cars, bikes, buses, and trains using contraction hierarchies</p>
</td></tr><tr class='module-item'><td><a class="mod" href="node_map/index.html" title='map_model::pathfind::node_map mod'>node_map</a></td><td class='docblock-short'><p>Some helpers for working with fast_paths.</p>
</td></tr><tr class='module-item'><td><a class="mod" href="uber_turns/index.html" title='map_model::pathfind::uber_turns mod'>uber_turns</a></td><td class='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>
</td></tr><tr class='module-item'><td><a class="mod" href="walking/index.html" title='map_model::pathfind::walking mod'>walking</a></td><td class='docblock-short'><p>Pathfinding for pedestrians using contraction hierarchies, as well as figuring out if somebody
should use public transit.</p>
</td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.Path.html" title='map_model::pathfind::Path struct'>Path</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.PathRequest.html" title='map_model::pathfind::PathRequest struct'>PathRequest</a></td><td class='docblock-short'></td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
<table><tr class='module-item'><td><a class="enum" href="enum.PathConstraints.html" title='map_model::pathfind::PathConstraints enum'>PathConstraints</a></td><td class='docblock-short'><p>Who's asking for a path?</p>
</td></tr><tr class='module-item'><td><a class="enum" href="enum.PathStep.html" title='map_model::pathfind::PathStep enum'>PathStep</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="enum" href="enum.Pathfinder.html" title='map_model::pathfind::Pathfinder enum'>Pathfinder</a></td><td class='docblock-short'><p>Most of the time, prefer using the faster contraction hierarchies. But sometimes, callers can
explicitly opt into a slower (but preparation-free) pathfinder that just uses Dijkstra's
maneuever.</p>
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
<table><tr class='module-item'><td><a class="fn" href="fn.validate_continuity.html" title='map_model::pathfind::validate_continuity fn'>validate_continuity</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="fn" href="fn.validate_restrictions.html" title='map_model::pathfind::validate_restrictions fn'>validate_restrictions</a></td><td class='docblock-short'></td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "map_model";</script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>