ELEC60015-HLP-CW/docs/reference/global-simulationrunner.html

245 lines
9.7 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8"/>
<title>SimulationRunner - issie</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<meta name="description" content=""/>
<meta name="author" content="tomcl"/>
<script src="https://code.jquery.com/jquery-1.8.0.js"></script>
<script src="https://code.jquery.com/ui/1.8.23/jquery-ui.js"></script>
<script src="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/js/bootstrap.min.js"></script>
<link href="https://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.1/css/bootstrap-combined.min.css" rel="stylesheet"/>
<link type="text/css" rel="stylesheet" href="https://tomcl.github.io/issie//content/style.css" />
<script type="text/javascript" src="https://tomcl.github.io/issie//content/tips.js"></script>
<!-- HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<![endif]-->
</head>
<body>
<div class="container">
<div class="masthead">
<ul class="nav nav-pills pull-right">
<li><a href="http://fsharp.org">fsharp.org</a></li>
</ul>
<h3 class="muted"><a href="https://tomcl.github.io/issie//index.html">issie</a></h3>
</div>
<hr />
<div class="row">
<div class="span9" id="main">
<h1>SimulationRunner</h1>
<p>
<span>Namespace: global</span><br />
</p>
<div class="xmldoc">
</div>
<!-- Render nested types and modules, if there are any -->
<h3>Functions and values</h3>
<table class="table table-bordered member-list">
<thead>
<tr><td>Function or value</td><td>Description</td></tr>
</thead>
<tbody>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '79', 79)" onmouseover="showTip(event, '79', 79)">
diffReducerInputsOrOutputs newIO oldIO
</code>
<div class="tip" id="79">
<strong>Signature:</strong> newIO:Map&lt;&#39;a,WireData&gt; -&gt; oldIO:Map&lt;&#39;a,WireData&gt; -&gt; Map&lt;&#39;a,WireData&gt;<br />
<strong>Type parameters:</strong> 'a </div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Simulator/Runner.fs#L20-20" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Function to determine what reducer inputs or outputs have changed.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '80', 80)" onmouseover="showTip(event, '80', 80)">
extractIncompleteSimulationIOs(...)
</code>
<div class="tip" id="80">
<strong>Signature:</strong> simulationIOs:SimulationIO list -&gt; graph:SimulationGraph -&gt; (SimulationIO * WireData) list<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Simulator/Runner.fs#L195-195" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Simlar to extractSimulationIOs, but do not fail if a bit is not set, just
ignore it.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '81', 81)" onmouseover="showTip(event, '81', 81)">
extractSimulationIOs simulationIOs graph
</code>
<div class="tip" id="81">
<strong>Signature:</strong> simulationIOs:SimulationIO list -&gt; graph:SimulationGraph -&gt; (SimulationIO * WireData) list<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Simulator/Runner.fs#L179-179" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Given a list of IO nodes (i.e. Inputs or outputs) extract their value.
If they dont all have a value, an error is thrown.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '82', 82)" onmouseover="showTip(event, '82', 82)">
feedClockTick(graph)
</code>
<div class="tip" id="82">
<strong>Signature:</strong> graph:SimulationGraph -&gt; SimulationGraph<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Simulator/Runner.fs#L113-113" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Send one global clock tick to all clocked components, and return the updated
simulationGraph.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '83', 83)" onmouseover="showTip(event, '83', 83)">
feedSimulationInput(...)
</code>
<div class="tip" id="83">
<strong>Signature:</strong> graph:SimulationGraph -&gt; inputId:ComponentId -&gt; wireData:WireData -&gt; SimulationGraph<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Simulator/Runner.fs#L158-158" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Feed zero to a simulation input.
This function is supposed to be used with Components of type Input.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '84', 84)" onmouseover="showTip(event, '84', 84)">
getSimulationIOs(components)
</code>
<div class="tip" id="84">
<strong>Signature:</strong> components:Component list -&gt; SimulationIO list * SimulationIO list<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Simulator/Runner.fs#L211-211" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Get ComponentIds, ComponentLabels and wire widths of all input and output
nodes.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '85', 85)" onmouseover="showTip(event, '85', 85)">
getSimulationIOsFromGraph(graph)
</code>
<div class="tip" id="85">
<strong>Signature:</strong> graph:SimulationGraph -&gt; SimulationIO list * SimulationIO list<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Simulator/Runner.fs#L223-223" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Get ComponentIds, ComponentLabels and wire widths of all input and output
nodes in a simulationGraph.</p>
</td>
</tr>
<tr>
<td class="member-name">
<code onmouseout="hideTip(event, '86', 86)" onmouseover="showTip(event, '86', 86)">
InitialiseGraphWithZeros inputIds graph
</code>
<div class="tip" id="86">
<strong>Signature:</strong> inputIds:SimulationIO list -&gt; graph:SimulationGraph -&gt; SimulationGraph<br />
</div>
</td>
<td class="xmldoc">
<a href="https://github.com/tomcl/ISSIE/tree/master/src/Simulator/Runner.fs#L164-164" class="github-link">
<img src="../content/img/github.png" class="normal" />
<img src="../content/img/github-blue.png" class="hover" />
</a>
<p>Feed zeros to all simulation inputs, and feed a single clock tick.
This way all combinational logic has been touched once and had produced its
outputs.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="span3">
<ul class="nav nav-list" id="menu" style="margin-top: 20px;">
<li class="nav-header">issie</li>
<li class="divider"></li>
<li><a href="https://github.com/tomcl/ISSIE">Source Code</a></li>
<li><a href="https://tomcl.github.io/issie//release-notes.html">Release Notes</a></li>
<li><a href="https://tomcl.github.io/issie//contributing.html">Contributing</a></li>
<li class="nav-header">Documentation</li>
<li><a href="https://tomcl.github.io/issie//index.html">Introduction</a></li>
<li class="divider"></li>
<li><a href="https://tomcl.github.io/issie//community.html">Community</a></li>
<li class="nav-header">Reference</li>
<li><a href="https://tomcl.github.io/issie//reference/index.html">API Reference</a></li>
</ul>
</div>
</div>
</div>
</body>
</html>