phasicFlow/doc/code-documentation/html/classpFlow_1_1bitTransfer.html

365 lines
17 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.17"/>
<title>PhasicFlow: bitTransfer Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="customdoxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname"><a href="https://cemf.ir">PhasicFlow</a>
&#160;<span id="projectnumber"><a href="https://cemf.ir">v0.1</a></span>
</div>
<div id="projectbrief"><a href="www.github.com/PhasicFlow">www.cemf.ir</a></div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('classpFlow_1_1bitTransfer.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-static-attribs">Static Protected Attributes</a> &#124;
<a href="classpFlow_1_1bitTransfer-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">bitTransfer Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a42e1e28c03fe21ce6e5f7c1d83b02f7d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1bitTransfer.html#a42e1e28c03fe21ce6e5f7c1d83b02f7d">bitTransfer</a> ()</td></tr>
<tr class="separator:a42e1e28c03fe21ce6e5f7c1d83b02f7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1b1b2b0ded7afe4ae57bad9f5c6bebfc"><td class="memItemLeft" align="right" valign="top">unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1bitTransfer.html#a1b1b2b0ded7afe4ae57bad9f5c6bebfc">operator()</a> (const unit3 &amp;int3)</td></tr>
<tr class="separator:a1b1b2b0ded7afe4ae57bad9f5c6bebfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9c90dfdef3d1b19b4b2f722d9579173"><td class="memItemLeft" align="right" valign="top">unit3&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1bitTransfer.html#ab9c90dfdef3d1b19b4b2f722d9579173">operator()</a> (const unsigned long &amp;ul)</td></tr>
<tr class="separator:ab9c90dfdef3d1b19b4b2f722d9579173"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr class="memitem:a19da95c59109cb04d7ca455ffbc5bc50"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1bitTransfer.html#a19da95c59109cb04d7ca455ffbc5bc50">numBits_</a> = 21</td></tr>
<tr class="separator:a19da95c59109cb04d7ca455ffbc5bc50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a80db50e5c10165949f1e5c35ef148731"><td class="memItemLeft" align="right" valign="top">static const int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1bitTransfer.html#a80db50e5c10165949f1e5c35ef148731">numBits2_</a> = 2 * <a class="el" href="classpFlow_1_1bitTransfer.html#a19da95c59109cb04d7ca455ffbc5bc50">numBits_</a></td></tr>
<tr class="separator:a80db50e5c10165949f1e5c35ef148731"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a785c36f8d99f0ef5c3ad93e324646bf2"><td class="memItemLeft" align="right" valign="top">static const unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1bitTransfer.html#a785c36f8d99f0ef5c3ad93e324646bf2">mask1_</a> = 0x000000000001FFFFF</td></tr>
<tr class="separator:a785c36f8d99f0ef5c3ad93e324646bf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae99c146a6a128157b865cebe376973e3"><td class="memItemLeft" align="right" valign="top">static const unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1bitTransfer.html#ae99c146a6a128157b865cebe376973e3">mask2_</a> = 0x0000003FFFFE00000</td></tr>
<tr class="separator:ae99c146a6a128157b865cebe376973e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a95facdcb88cd0d2c38573f971e6b6b40"><td class="memItemLeft" align="right" valign="top">static const unsigned long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1bitTransfer.html#a95facdcb88cd0d2c38573f971e6b6b40">mask3_</a> = 0x07FFFFC0000000000</td></tr>
<tr class="separator:a95facdcb88cd0d2c38573f971e6b6b40"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
<p class="definition">Definition at line <a class="el" href="bitTransfer_8hpp_source.html#l00035">35</a> of file <a class="el" href="bitTransfer_8hpp_source.html">bitTransfer.hpp</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a42e1e28c03fe21ce6e5f7c1d83b02f7d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a42e1e28c03fe21ce6e5f7c1d83b02f7d">&#9670;&nbsp;</a></span>bitTransfer()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classpFlow_1_1bitTransfer.html">bitTransfer</a> </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bitTransfer_8hpp_source.html#l00047">47</a> of file <a class="el" href="bitTransfer_8hpp_source.html">bitTransfer.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a1b1b2b0ded7afe4ae57bad9f5c6bebfc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1b1b2b0ded7afe4ae57bad9f5c6bebfc">&#9670;&nbsp;</a></span>operator()() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unsigned long operator() </td>
<td>(</td>
<td class="paramtype">const unit3 &amp;&#160;</td>
<td class="paramname"><em>int3</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bitTransfer_8hpp_source.html#l00049">49</a> of file <a class="el" href="bitTransfer_8hpp_source.html">bitTransfer.hpp</a>.</p>
<p class="reference">References <a class="el" href="bitTransfer_8hpp_source.html#l00040">bitTransfer::numBits2_</a>, and <a class="el" href="bitTransfer_8hpp_source.html#l00039">bitTransfer::numBits_</a>.</p>
</div>
</div>
<a id="ab9c90dfdef3d1b19b4b2f722d9579173"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab9c90dfdef3d1b19b4b2f722d9579173">&#9670;&nbsp;</a></span>operator()() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">unit3 operator() </td>
<td>(</td>
<td class="paramtype">const unsigned long &amp;&#160;</td>
<td class="paramname"><em>ul</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bitTransfer_8hpp_source.html#l00057">57</a> of file <a class="el" href="bitTransfer_8hpp_source.html">bitTransfer.hpp</a>.</p>
<p class="reference">References <a class="el" href="bitTransfer_8hpp_source.html#l00041">bitTransfer::mask1_</a>, <a class="el" href="bitTransfer_8hpp_source.html#l00042">bitTransfer::mask2_</a>, <a class="el" href="bitTransfer_8hpp_source.html#l00043">bitTransfer::mask3_</a>, <a class="el" href="bitTransfer_8hpp_source.html#l00040">bitTransfer::numBits2_</a>, and <a class="el" href="bitTransfer_8hpp_source.html#l00039">bitTransfer::numBits_</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a19da95c59109cb04d7ca455ffbc5bc50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19da95c59109cb04d7ca455ffbc5bc50">&#9670;&nbsp;</a></span>numBits_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int numBits_ = 21</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bitTransfer_8hpp_source.html#l00039">39</a> of file <a class="el" href="bitTransfer_8hpp_source.html">bitTransfer.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitTransfer_8hpp_source.html#l00049">bitTransfer::operator()()</a>.</p>
</div>
</div>
<a id="a80db50e5c10165949f1e5c35ef148731"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a80db50e5c10165949f1e5c35ef148731">&#9670;&nbsp;</a></span>numBits2_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const int numBits2_ = 2 * <a class="el" href="classpFlow_1_1bitTransfer.html#a19da95c59109cb04d7ca455ffbc5bc50">numBits_</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bitTransfer_8hpp_source.html#l00040">40</a> of file <a class="el" href="bitTransfer_8hpp_source.html">bitTransfer.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitTransfer_8hpp_source.html#l00049">bitTransfer::operator()()</a>.</p>
</div>
</div>
<a id="a785c36f8d99f0ef5c3ad93e324646bf2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a785c36f8d99f0ef5c3ad93e324646bf2">&#9670;&nbsp;</a></span>mask1_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const unsigned long mask1_ = 0x000000000001FFFFF</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bitTransfer_8hpp_source.html#l00041">41</a> of file <a class="el" href="bitTransfer_8hpp_source.html">bitTransfer.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitTransfer_8hpp_source.html#l00057">bitTransfer::operator()()</a>.</p>
</div>
</div>
<a id="ae99c146a6a128157b865cebe376973e3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae99c146a6a128157b865cebe376973e3">&#9670;&nbsp;</a></span>mask2_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const unsigned long mask2_ = 0x0000003FFFFE00000</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bitTransfer_8hpp_source.html#l00042">42</a> of file <a class="el" href="bitTransfer_8hpp_source.html">bitTransfer.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitTransfer_8hpp_source.html#l00057">bitTransfer::operator()()</a>.</p>
</div>
</div>
<a id="a95facdcb88cd0d2c38573f971e6b6b40"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a95facdcb88cd0d2c38573f971e6b6b40">&#9670;&nbsp;</a></span>mask3_</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const unsigned long mask3_ = 0x07FFFFC0000000000</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="bitTransfer_8hpp_source.html#l00043">43</a> of file <a class="el" href="bitTransfer_8hpp_source.html">bitTransfer.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="bitTransfer_8hpp_source.html#l00057">bitTransfer::operator()()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/phasicFlow/structuredData/trisurfaceStructure/<a class="el" href="bitTransfer_8hpp_source.html">bitTransfer.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespacepFlow.html">pFlow</a></li><li class="navelem"><a class="el" href="classpFlow_1_1bitTransfer.html">bitTransfer</a></li>
<li class="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
</ul>
</div>
</body>
</html>