abstreet/rustdoc/map_model/connectivity/index.html

22 lines
6.5 KiB
HTML
Raw Normal View History

<!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 `connectivity` mod in crate `map_model`."><meta name="keywords" content="rust, rustlang, rust-lang, connectivity"><title>map_model::connectivity - 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 id="default-settings"></script><script src="../../storage.js"></script><script src="../../crates.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 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#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 connectivity</p><div class="sidebar-elems"><div class="block items"><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><p class="location"><a href="../index.html">map_model</a></p><div id="sidebar-vars" data-name="connectivity" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" height="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><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><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" height="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">map_model</a>::<wbr><a class="mod" href="">connectivity</a><button id="copy-path" onclick="copy_path(this)"></button></span><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/connectivity/mod.rs.html#3-167" title="goto source code">[src]</a></span></h1><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2>
<table><tr class="module-item"><td><a class="mod" href="walking/index.html" title="map_model::connectivity::walking mod">walking</a></td><td class="docblock-short"></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.Item.html" title="map_model::connectivity::Item struct">Item</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.WalkingOptions.html" title="map_model::connectivity::WalkingOptions struct">WalkingOptions</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.Spot.html" title="map_model::connectivity::Spot enum">Spot</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="enum" href="enum.WalkingNode.html" title="map_model::connectivity::WalkingNode enum">WalkingNode</a></td><td class="docblock-short"></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.all_vehicle_costs_from.html" title="map_model::connectivity::all_vehicle_costs_from fn">all_vehicle_costs_from</a></td><td class="docblock-short"><p>Starting from some initial spot, calculate the cost to all buildings. If a destination isnt
reachable, it wont be included in the results. Ignore results greater than the time_limit
away.</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.all_walking_costs_from.html" title="map_model::connectivity::all_walking_costs_from fn">all_walking_costs_from</a></td><td class="docblock-short"><p>Starting from some initial buildings, calculate the cost to all others. If a destination isnt
reachable, it wont be included in the results. Ignore results greater than the time_limit
away.</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.find_scc.html" title="map_model::connectivity::find_scc fn">find_scc</a></td><td class="docblock-short"><p>Calculate the strongly connected components (SCC) of the part of the map accessible by
constraints (ie, the graph of sidewalks or driving+bike lanes). The largest component is the
“main” graph; the rest is disconnected. Returns (lanes in the largest “main” component, all
other disconnected lanes)</p>
</td></tr><tr class="module-item"><td><a class="fn" href="fn.vehicle_cost.html" title="map_model::connectivity::vehicle_cost fn">vehicle_cost</a></td><td class="docblock-short"><p>This returns the pathfinding cost of crossing one road and turn. This is also expressed in
units of time. It factors in the ideal time to cross the space, along with penalties for
entering an access-restricted zone, taking an unprotected turn, and so on.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="map_model" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div>
<script src="../../main.js"></script></body></html>