update documentation
This commit is contained in:
1 parent
8d06165979
commit
e44529007a
250 files changed
+8487
-5511
No files matched your search
@@ -103,24 +103,46 @@ $(document).ready(function(){initNavTree('multiplexing_8h_source.html',''); init
|
||||
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#define MULTIPLEXING_H</span></div>
|
||||
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
|
||||
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include <cstdint></span></div>
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">enum class</span> MultiplexRole {</div>
|
||||
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> Unconditional,</div>
|
||||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> Selector,</div>
|
||||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> Branch</div>
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span>};</div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
||||
<div class="foldopen" id="foldopen00015" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="structMultiplexing.html"> 15</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structMultiplexing.html">Multiplexing</a> {</div>
|
||||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="structMultiplexing.html#a62b70a0e3f2a9c7a457b3694ce8625c3"> 16</a></span> MultiplexRole <a class="code hl_variable" href="structMultiplexing.html#a62b70a0e3f2a9c7a457b3694ce8625c3">role</a> = MultiplexRole::Unconditional; </div>
|
||||
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="structMultiplexing.html#a79158d4fdbfd68a3d51a8ce79d34fd67"> 17</a></span> std::uint64_t <a class="code hl_variable" href="structMultiplexing.html#a79158d4fdbfd68a3d51a8ce79d34fd67">value</a> = 0U; </div>
|
||||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>};</div>
|
||||
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include <string></span></div>
|
||||
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include <vector></span></div>
|
||||
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
|
||||
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="keyword">enum class</span> MultiplexRole {</div>
|
||||
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span> Unconditional,</div>
|
||||
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> Selector,</div>
|
||||
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> Branch,</div>
|
||||
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> BranchSelector</div>
|
||||
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span>};</div>
|
||||
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
||||
<div class="foldopen" id="foldopen00018" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="structMultiplexRange.html"> 18</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structMultiplexRange.html">MultiplexRange</a> {</div>
|
||||
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> std::uint64_t minimum = 0U;</div>
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> std::uint64_t maximum = 0U;</div>
|
||||
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span>};</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
|
||||
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="preprocessor">#endif</span></div>
|
||||
<div class="ttc" id="astructMultiplexing_html"><div class="ttname"><a href="structMultiplexing.html">Multiplexing</a></div><div class="ttdef"><b>Definition</b> <a href="multiplexing_8h_source.html#l00015">multiplexing.h:15</a></div></div>
|
||||
<div class="ttc" id="astructMultiplexing_html_a62b70a0e3f2a9c7a457b3694ce8625c3"><div class="ttname"><a href="structMultiplexing.html#a62b70a0e3f2a9c7a457b3694ce8625c3">Multiplexing::role</a></div><div class="ttdeci">MultiplexRole role</div><div class="ttdef"><b>Definition</b> <a href="multiplexing_8h_source.html#l00016">multiplexing.h:16</a></div></div>
|
||||
<div class="ttc" id="astructMultiplexing_html_a79158d4fdbfd68a3d51a8ce79d34fd67"><div class="ttname"><a href="structMultiplexing.html#a79158d4fdbfd68a3d51a8ce79d34fd67">Multiplexing::value</a></div><div class="ttdeci">std::uint64_t value</div><div class="ttdef"><b>Definition</b> <a href="multiplexing_8h_source.html#l00017">multiplexing.h:17</a></div></div>
|
||||
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
|
||||
<div class="foldopen" id="foldopen00024" data-start="{" data-end="};">
|
||||
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"><a class="line" href="structMultiplexing.html"> 24</a></span><span class="keyword">struct </span><a class="code hl_struct" href="structMultiplexing.html">Multiplexing</a> {</div>
|
||||
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> MultiplexRole role = MultiplexRole::Unconditional;</div>
|
||||
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"><a class="line" href="structMultiplexing.html#a79158d4fdbfd68a3d51a8ce79d34fd67"> 26</a></span> std::uint64_t <a class="code hl_variable" href="structMultiplexing.html#a79158d4fdbfd68a3d51a8ce79d34fd67">value</a> = 0U; </div>
|
||||
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="structMultiplexing.html#aa91e54403c78a663686b2fd22282afaf"> 27</a></span> std::string <a class="code hl_variable" href="structMultiplexing.html#aa91e54403c78a663686b2fd22282afaf">selector</a>; </div>
|
||||
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="structMultiplexing.html#aa174ac4a3af9b361d2de7517dfd4b69e"> 28</a></span> std::vector<MultiplexRange> <a class="code hl_variable" href="structMultiplexing.html#aa174ac4a3af9b361d2de7517dfd4b69e">ranges</a>; </div>
|
||||
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span>};</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> </div>
|
||||
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="keyword">inline</span> <span class="keywordtype">bool</span> IsMultiplexSelector(MultiplexRole role) {</div>
|
||||
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> <span class="keywordflow">return</span> role == MultiplexRole::Selector || role == MultiplexRole::BranchSelector;</div>
|
||||
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span>}</div>
|
||||
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
|
||||
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="keyword">inline</span> <span class="keywordtype">bool</span> IsMultiplexBranch(MultiplexRole role) {</div>
|
||||
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="keywordflow">return</span> role == MultiplexRole::Branch || role == MultiplexRole::BranchSelector;</div>
|
||||
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span>}</div>
|
||||
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> </div>
|
||||
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="preprocessor">#endif</span></div>
|
||||
<div class="ttc" id="astructMultiplexRange_html"><div class="ttname"><a href="structMultiplexRange.html">MultiplexRange</a></div><div class="ttdoc">Inclusive raw selector range, without expanding individual values.</div><div class="ttdef"><b>Definition</b> <a href="multiplexing_8h_source.html#l00018">multiplexing.h:18</a></div></div>
|
||||
<div class="ttc" id="astructMultiplexing_html"><div class="ttname"><a href="structMultiplexing.html">Multiplexing</a></div><div class="ttdoc">Basic markers and optional explicit extended multiplexing condition.</div><div class="ttdef"><b>Definition</b> <a href="multiplexing_8h_source.html#l00024">multiplexing.h:24</a></div></div>
|
||||
<div class="ttc" id="astructMultiplexing_html_a79158d4fdbfd68a3d51a8ce79d34fd67"><div class="ttname"><a href="structMultiplexing.html#a79158d4fdbfd68a3d51a8ce79d34fd67">Multiplexing::value</a></div><div class="ttdeci">std::uint64_t value</div><div class="ttdef"><b>Definition</b> <a href="multiplexing_8h_source.html#l00026">multiplexing.h:26</a></div></div>
|
||||
<div class="ttc" id="astructMultiplexing_html_aa174ac4a3af9b361d2de7517dfd4b69e"><div class="ttname"><a href="structMultiplexing.html#aa174ac4a3af9b361d2de7517dfd4b69e">Multiplexing::ranges</a></div><div class="ttdeci">std::vector< MultiplexRange > ranges</div><div class="ttdef"><b>Definition</b> <a href="multiplexing_8h_source.html#l00028">multiplexing.h:28</a></div></div>
|
||||
<div class="ttc" id="astructMultiplexing_html_aa91e54403c78a663686b2fd22282afaf"><div class="ttname"><a href="structMultiplexing.html#aa91e54403c78a663686b2fd22282afaf">Multiplexing::selector</a></div><div class="ttdeci">std::string selector</div><div class="ttdef"><b>Definition</b> <a href="multiplexing_8h_source.html#l00027">multiplexing.h:27</a></div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
|
||||
Reference in new issue
Block a user