abstreet/rustdoc/synthpop/index.html
2022-02-03 14:29:22 +00:00

26 lines
9.8 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="This crate describes a synthetic population that exist in a map. Currently each persons travel behavior is modelled, but in the future, demographic and health attributes may be added. Theres a variety of ways to create these populations, scattered in other crates."><meta name="keywords" content="rust, rustlang, rust-lang, synthpop"><title>synthpop - 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><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"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod crate"><!--[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='../synthpop/index.html'><div class='logo-container rust-logo'><img src='../rust-logo.png' alt='logo'></div></a><h2 class="location">Crate synthpop</h2><div class="block version"><div class="narrow-helper"></div><p>Version 0.1.0</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all synthpop's items</p></a><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></ul></div><div id="sidebar-vars" data-name="synthpop" 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" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></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" autocomplete="off" spellcheck="false" placeholder="Click or press S to search, ? for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">synthpop</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><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/synthpop/lib.rs.html#1-118" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This crate describes a synthetic population that exist in a map. Currently each persons travel
behavior is modelled, but in the future, demographic and health attributes may be added.
Theres a variety of ways to create these populations, scattered in other crates.</p>
<p>Note that “scenario” is the term currently used to describe the population. This will be
renamed “soon.”</p>
</div></details><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="borders/index.html" title="synthpop::borders mod">borders</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="counts/index.html" title="synthpop::counts mod">counts</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="endpoint/index.html" title="synthpop::endpoint mod">endpoint</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="external/index.html" title="synthpop::external mod">external</a></div><div class="item-right docblock-short"><p>Some users of the API (https://a-b-street.github.io/docs/tech/dev/api.html) have their own
simulation input data; import it here.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="modifier/index.html" title="synthpop::modifier mod">modifier</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="scenario/index.html" title="synthpop::scenario mod">scenario</a></div><div class="item-right docblock-short"></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.ExternalPerson.html" title="synthpop::ExternalPerson struct">ExternalPerson</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ExternalTrip.html" title="synthpop::ExternalTrip struct">ExternalTrip</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IndividTrip.html" title="synthpop::IndividTrip struct">IndividTrip</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MapBorder.html" title="synthpop::MapBorder struct">MapBorder</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.MapBorders.html" title="synthpop::MapBorders struct">MapBorders</a></div><div class="item-right docblock-short"><p>Lists all border intersections of the map, broken down by mode and whether they support
incoming or outgoing traffic.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OrigPersonID.html" title="synthpop::OrigPersonID struct">OrigPersonID</a></div><div class="item-right docblock-short"><p>This is an ID used by Seattle soundcast. Originally it was preserved for debugging, but that
hasnt happened in a long time. Also the format is tied to Soundcast. Consider deleting /
changing.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.PersonSpec.html" title="synthpop::PersonSpec struct">PersonSpec</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Scenario.html" title="synthpop::Scenario struct">Scenario</a></div><div class="item-right docblock-short"><p>A Scenario describes all the input to a simulation. Usually a scenario covers one day.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.TrafficCounts.html" title="synthpop::TrafficCounts struct">TrafficCounts</a></div><div class="item-right docblock-short"><p>This represents the number of vehicles (or trips, or something else) crossing roads and
intersections over some span of time. The data could represent real observations or something
from a simulation.</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.ExternalTripEndpoint.html" title="synthpop::ExternalTripEndpoint enum">ExternalTripEndpoint</a></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.ScenarioModifier.html" title="synthpop::ScenarioModifier enum">ScenarioModifier</a></div><div class="item-right docblock-short"><p>Transforms an existing Scenario before instantiating it.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.TripEndpoint.html" title="synthpop::TripEndpoint enum">TripEndpoint</a></div><div class="item-right docblock-short"><p>Specifies where a trip begins or ends.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.TripMode.html" title="synthpop::TripMode enum">TripMode</a></div><div class="item-right docblock-short"><p>How does a trip primarily happen?</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.TripPurpose.html" title="synthpop::TripPurpose enum">TripPurpose</a></div><div class="item-right docblock-short"><p>Lifted from Seattles Soundcast model, but seems general enough to use anyhere.</p>
</div></div></div></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../" data-current-crate="synthpop" data-search-index-js="../search-index.js" data-search-js="../search.js"></div>
</body></html>