mirror of
https://github.com/a-b-street/abstreet.git
synced 2024-11-24 01:15:12 +03:00
31 lines
11 KiB
HTML
31 lines
11 KiB
HTML
<!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 person’s travel behavior is modelled, but in the future, demographic and health attributes may be added. There’s 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="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 crate"><!--[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">☰</button><a class="sidebar-logo" href="../synthpop/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="../synthpop/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div>
|
||
</a><h2 class="location"><a href="#">Crate synthpop</a></h2><div class="sidebar-elems"><div class="block"><ul><li class="version">Version 0.1.0</li><li><a id="all-types" href="all.html">All Items</a></li></div></ul><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></ul></div></section><div id="sidebar-vars" data-name="synthpop" 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="../synthpop/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">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></h1><span class="out-of-band"><a class="srclink" href="../src/synthpop/lib.rs.html#1-118">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><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 person’s travel
|
||
behavior is modelled, but in the future, demographic and health attributes may be added.
|
||
There’s 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><span title="Restricted Visibility"> 🔒</span> </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><span title="Restricted Visibility"> 🔒</span> </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><span title="Restricted Visibility"> 🔒</span> </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><span title="Restricted Visibility"> 🔒</span> </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><span title="Restricted Visibility"> 🔒</span> </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><span title="Restricted Visibility"> 🔒</span> </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
|
||
hasn’t 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 Seattle’s Soundcast model, but seems general enough to use anyhere.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="synthpop" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.61.0 (fe5b13d68 2022-05-18)" ></div>
|
||
</body></html> |