abstreet/rustdoc/sim/make/index.html
2021-07-29 16:51:19 +00:00

20 lines
9.5 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="Everything needed to setup a simulation. https://a-b-street.github.io/docs/tech/trafficsim/travel_demand.html for context."><meta name="keywords" content="rust, rustlang, rust-lang, make"><title>sim::make - 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='../../sim/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><h2 class="location">Module make</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#functions">Functions</a></li></ul></div><div id="sidebar-vars" data-name="make" 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 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" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><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">sim</a>::<wbr><a class="mod" href="#">make</a><button id="copy-path" onclick="copy_path(this)" title="copy path"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item import" title="Copy item import to clipboard"></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/sim/make/mod.rs.html#1-27" 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>Everything needed to setup a simulation.
<a href="https://a-b-street.github.io/docs/tech/trafficsim/travel_demand.html">https://a-b-street.github.io/docs/tech/trafficsim/travel_demand.html</a> for context.</p>
</div></details><h2 id="reexports" class="section-header"><a href="#reexports">Re-exports</a></h2>
<table><tr class="import-item"><td><code>pub use self::external::<a class="struct" href="external/struct.ExternalPerson.html" title="struct sim::make::external::ExternalPerson">ExternalPerson</a>;</code></td><td class="docblock-short"></td></tr><tr class="import-item"><td><code>pub use self::external::<a class="struct" href="external/struct.ExternalTrip.html" title="struct sim::make::external::ExternalTrip">ExternalTrip</a>;</code></td><td class="docblock-short"></td></tr><tr class="import-item"><td><code>pub use self::external::<a class="enum" href="external/enum.ExternalTripEndpoint.html" title="enum sim::make::external::ExternalTripEndpoint">ExternalTripEndpoint</a>;</code></td><td class="docblock-short"></td></tr><tr class="import-item"><td><code>pub use self::external::<a class="struct" href="external/struct.MapBorders.html" title="struct sim::make::external::MapBorders">MapBorders</a>;</code></td><td class="docblock-short"></td></tr><tr class="import-item"><td><code>pub use self::generator::<a class="struct" href="generator/struct.BorderSpawnOverTime.html" title="struct sim::make::generator::BorderSpawnOverTime">BorderSpawnOverTime</a>;</code></td><td class="docblock-short"></td></tr><tr class="import-item"><td><code>pub use self::generator::<a class="struct" href="generator/struct.ScenarioGenerator.html" title="struct sim::make::generator::ScenarioGenerator">ScenarioGenerator</a>;</code></td><td class="docblock-short"></td></tr><tr class="import-item"><td><code>pub use self::generator::<a class="struct" href="generator/struct.SpawnOverTime.html" title="struct sim::make::generator::SpawnOverTime">SpawnOverTime</a>;</code></td><td class="docblock-short"></td></tr><tr class="import-item"><td><code>pub use self::load::<a class="struct" href="load/struct.SimFlags.html" title="struct sim::make::load::SimFlags">SimFlags</a>;</code></td><td class="docblock-short"></td></tr><tr class="import-item"><td><code>pub use self::modifier::<a class="enum" href="modifier/enum.ScenarioModifier.html" title="enum sim::make::modifier::ScenarioModifier">ScenarioModifier</a>;</code></td><td class="docblock-short"></td></tr><tr class="import-item"><td><code>pub use self::scenario::<a class="struct" href="scenario/struct.IndividTrip.html" title="struct sim::make::scenario::IndividTrip">IndividTrip</a>;</code></td><td class="docblock-short"></td></tr><tr class="import-item"><td><code>pub use self::scenario::<a class="struct" href="scenario/struct.PersonSpec.html" title="struct sim::make::scenario::PersonSpec">PersonSpec</a>;</code></td><td class="docblock-short"></td></tr><tr class="import-item"><td><code>pub use self::scenario::<a class="struct" href="scenario/struct.Scenario.html" title="struct sim::make::scenario::Scenario">Scenario</a>;</code></td><td class="docblock-short"></td></tr><tr class="import-item"><td><code>pub use self::scenario::<a class="enum" href="scenario/enum.TripPurpose.html" title="enum sim::make::scenario::TripPurpose">TripPurpose</a>;</code></td><td class="docblock-short"></td></tr><tr class="import-item"><td><code>pub use self::spawner::<a class="enum" href="spawner/enum.TripEndpoint.html" title="enum sim::make::spawner::TripEndpoint">TripEndpoint</a>;</code></td><td class="docblock-short"></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="activity_model/index.html" title="sim::make::activity_model mod">activity_model</a></td><td class="docblock-short"><p>An activity model creates “people” that follow a set schedule of activities through the day.
Each activity (like shopping, working, sleeping) lasts some time, and requires the person to go
somewhere at some time. This is an extremely simple activity model that just uses data inferred
from OSM.</p>
</td></tr><tr class="module-item"><td><a class="mod" href="external/index.html" title="sim::make::external mod">external</a></td><td class="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>
</td></tr><tr class="module-item"><td><a class="mod" href="generator/index.html" title="sim::make::generator mod">generator</a></td><td class="docblock-short"><p>This is a much more primitive way to randomly generate trips. activity_model.rs has something
more realistic.</p>
</td></tr><tr class="module-item"><td><a class="mod" href="load/index.html" title="sim::make::load mod">load</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="modifier/index.html" title="sim::make::modifier mod">modifier</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="scenario/index.html" title="sim::make::scenario mod">scenario</a></td><td class="docblock-short"></td></tr><tr class="module-item"><td><a class="mod" href="spawner/index.html" title="sim::make::spawner mod">spawner</a></td><td class="docblock-short"><p>Intermediate structures used to instantiate a Scenario. Badly needs simplification:
https://github.com/a-b-street/abstreet/issues/258</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.fork_rng.html" title="sim::make::fork_rng fn">fork_rng</a></td><td class="docblock-short"><p>Need to explain this trick basically keeps consistency between two different simulations when
each one might make slightly different sequences of calls to the RNG.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="sim" data-search-index-js="../../search-index.js" data-search-js="../../search.js"></div><script src="../../main.js"></script></body></html>