abstreet/rustdoc/popdat/od/index.html

20 lines
5.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 `od` mod in crate `popdat`."><meta name="keywords" content="rust, rustlang, rust-lang, od"><title>popdat::od - 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><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='../../popdat/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module od</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class="location"><a href="../index.html">popdat</a></p><div id="sidebar-vars" data-name="od" 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" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></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><button type="button" class="help-button">?</button>
<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="in-band">Module <a href="../index.html">popdat</a>::<wbr><a class="mod" href="">od</a></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/popdat/od.rs.html#1-283" title="goto source code">[src]</a></span></h1><div class="docblock"><p>This is an alternative pipeline for generating a Scenario, starting from origin-destination
data (also called desire lines), which gives a count of commuters between two zones, breaking
down by mode.</p>
<p>Maybe someday, we'll merge the two approaches, and make the first generate DesireLines as an
intermediate step.</p>
</div><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.DesireLine.html" title="popdat::od::DesireLine struct">DesireLine</a></td><td class="docblock-short"><p>This describes some number of commuters living in some named zone, working in another (or the
same zone), and commuting using some mode.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.NormalDistribution.html" title="popdat::od::NormalDistribution struct">NormalDistribution</a></td><td class="docblock-short"><p>A normal distribution of Durations.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Options.html" title="popdat::od::Options struct">Options</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="struct" href="struct.Zone.html" title="popdat::od::Zone struct">Zone</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.create_zones.html" title="popdat::od::create_zones fn">create_zones</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="fn" href="fn.disaggregate.html" title="popdat::od::disaggregate fn">disaggregate</a></td><td class="docblock-short"><p>Generates a scenario from aggregated origin/destination data (DesireLines). The input describes
an exact number of people, who live in one zone and work in another (possibly the same) and
commute using some mode. For each of them, we just need to pick a specific home and workplace
from the zones, and use the Options to pick departure times. We'll wind up creating people who
just take two trips daily: home -&gt; work -&gt; home.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="popdat"></div>
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>