documentation for v1.0

This commit is contained in:
HRN
2025-01-10 13:02:07 +03:30
parent 53c7b23728
commit 0acd52f1b1
16893 changed files with 448346 additions and 285977 deletions

View File

@ -115,10 +115,6 @@ $(document).ready(function(){initNavTree('classpFlow_1_1IncludeMask.html',''); i
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1IncludeMask__inherit__graph.png" border="0" usemap="#IncludeMask_3_01T_00_01Operator_01_4_inherit__map" alt="Inheritance graph"/></div>
<map name="IncludeMask_3_01T_00_01Operator_01_4_inherit__map" id="IncludeMask_3_01T_00_01Operator_01_4_inherit__map">
<area shape="rect" title=" " alt="" coords="5,80,212,107"/>
<area shape="rect" href="classpFlow_1_1includeMask.html" title=" " alt="" coords="57,5,161,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for IncludeMask&lt; T, Operator &gt;:</div>
@ -126,23 +122,20 @@ $(document).ready(function(){initNavTree('classpFlow_1_1IncludeMask.html',''); i
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classpFlow_1_1IncludeMask__coll__graph.png" border="0" usemap="#IncludeMask_3_01T_00_01Operator_01_4_coll__map" alt="Collaboration graph"/></div>
<map name="IncludeMask_3_01T_00_01Operator_01_4_coll__map" id="IncludeMask_3_01T_00_01Operator_01_4_coll__map">
<area shape="rect" title=" " alt="" coords="23,95,230,121"/>
<area shape="rect" href="classpFlow_1_1includeMask.html" title=" " alt="" coords="5,5,109,32"/>
<area shape="rect" href="classpFlow_1_1pointField.html" title=" " alt="" coords="134,5,258,32"/>
</map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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:a987babac16091c970f2cc833d91b3323"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IncludeMask.html#a987babac16091c970f2cc833d91b3323">TypeInfoTemplate2</a> (&quot;IncludeMask&quot;, T, Operator)</td></tr>
<tr class="separator:a987babac16091c970f2cc833d91b3323"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4c77096f8f8cd5766e825246c6ebf956"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IncludeMask.html#a4c77096f8f8cd5766e825246c6ebf956">TypeInfoTemplate12</a> (&quot;IncludeMask&quot;, T, Operator)</td></tr>
<tr class="separator:a4c77096f8f8cd5766e825246c6ebf956"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f679d1acbad477b836fa28c7290d7d5"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IncludeMask.html#a7f679d1acbad477b836fa28c7290d7d5">IncludeMask</a> (const <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a> &amp;dict, const <a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a> &amp;opType, <a class="el" href="classpFlow_1_1readFromTimeFolder.html">readFromTimeFolder</a> &amp;<a class="el" href="classpFlow_1_1timeFolder.html">timeFolder</a>)</td></tr>
<tr class="separator:a7f679d1acbad477b836fa28c7290d7d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a32e97523f38d476c86349e806ba3263d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IncludeMask.html#a32e97523f38d476c86349e806ba3263d">add_vCtor</a> (<a class="el" href="classpFlow_1_1includeMask.html">includeMask</a>, <a class="el" href="classpFlow_1_1IncludeMask.html">IncludeMask</a>, <a class="el" href="classpFlow_1_1dictionary.html">dictionary</a>)</td></tr>
<tr class="separator:a32e97523f38d476c86349e806ba3263d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a521bdd7b143fd354716eb8dd62d5cf95"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IncludeMask.html#a521bdd7b143fd354716eb8dd62d5cf95">isIncluded</a> (<a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a> <a class="el" href="NBSLoop_8hpp.html#aad8b608072a1b6dcd9e91de38ee2925f">n</a>) const override</td></tr>
<tr class="memitem:a521bdd7b143fd354716eb8dd62d5cf95"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IncludeMask.html#a521bdd7b143fd354716eb8dd62d5cf95">isIncluded</a> (<a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a> <a class="el" href="NBSLoop_8hpp.html#a58f1256fe216b2e84819aa621b683de1">n</a>) const override</td></tr>
<tr class="separator:a521bdd7b143fd354716eb8dd62d5cf95"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afe7e8e9646618d94bc2bbf4a59f35017"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IncludeMask.html#afe7e8e9646618d94bc2bbf4a59f35017">size</a> () const override</td></tr>
<tr class="separator:afe7e8e9646618d94bc2bbf4a59f35017"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_classpFlow_1_1includeMask"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classpFlow_1_1includeMask')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="classpFlow_1_1includeMask.html">includeMask</a></td></tr>
<tr class="memitem:a68b501eeb8345be33aa1d6ebd7933eb5 inherit pub_methods_classpFlow_1_1includeMask"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1includeMask.html#a68b501eeb8345be33aa1d6ebd7933eb5">TypeInfo</a> (&quot;includeMask&quot;)</td></tr>
<tr class="separator:a68b501eeb8345be33aa1d6ebd7933eb5 inherit pub_methods_classpFlow_1_1includeMask"><td class="memSeparator" colspan="2">&#160;</td></tr>
@ -160,15 +153,17 @@ Public Member Functions</h2></td></tr>
<tr class="separator:a360295877cf6a9d51a73406b897fa64d inherit pub_methods_classpFlow_1_1includeMask"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a42adc93db9ba55e4379221279ee3fd9b inherit pub_methods_classpFlow_1_1includeMask"><td class="memItemLeft" align="right" valign="top">auto &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1includeMask.html#a42adc93db9ba55e4379221279ee3fd9b">timeFolder</a> ()</td></tr>
<tr class="separator:a42adc93db9ba55e4379221279ee3fd9b inherit pub_methods_classpFlow_1_1includeMask"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a84a44bb3dbfa00e7c5ae635b1eb1bd9e inherit pub_methods_classpFlow_1_1includeMask"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1includeMask.html#a84a44bb3dbfa00e7c5ae635b1eb1bd9e">operator()</a> (<a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a> <a class="el" href="NBSLoop_8hpp.html#aad8b608072a1b6dcd9e91de38ee2925f">n</a>) const</td></tr>
<tr class="memitem:a84a44bb3dbfa00e7c5ae635b1eb1bd9e inherit pub_methods_classpFlow_1_1includeMask"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1includeMask.html#a84a44bb3dbfa00e7c5ae635b1eb1bd9e">operator()</a> (<a class="el" href="namespacepFlow.html#aae6ad039f09c0676db11bd114136a3fa">int32</a> <a class="el" href="NBSLoop_8hpp.html#a58f1256fe216b2e84819aa621b683de1">n</a>) const</td></tr>
<tr class="separator:a84a44bb3dbfa00e7c5ae635b1eb1bd9e inherit pub_methods_classpFlow_1_1includeMask"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a7a783a4ad2478110c9c7903ee1895d35"><td class="memItemLeft" align="right" valign="top">Operator&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IncludeMask.html#a7a783a4ad2478110c9c7903ee1895d35">operator_</a></td></tr>
<tr class="separator:a7a783a4ad2478110c9c7903ee1895d35"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa7484adb662fefbf7a44511753787f13"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a09c79f0e74d5dd4336dca6ab67c032c3">pointField_H</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IncludeMask.html#aa7484adb662fefbf7a44511753787f13">field_</a></td></tr>
<tr class="separator:aa7484adb662fefbf7a44511753787f13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebe51f4313d13dab635fdf5ec428f1e7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classpFlow_1_1uniquePtr.html">uniquePtr</a>&lt; <a class="el" href="namespacepFlow.html#a298b83b09449b5123ed12206f026784d">pointField_H</a>&lt; T &gt; &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IncludeMask.html#aebe51f4313d13dab635fdf5ec428f1e7">fieldPtr_</a></td></tr>
<tr class="separator:aebe51f4313d13dab635fdf5ec428f1e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7263a0a0567dbf5a86546ec41d925be2"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#ad53198ba4452d5fdc966d861583fc70f">hostViewType1D</a>&lt; T &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1IncludeMask.html#a7263a0a0567dbf5a86546ec41d925be2">field_</a></td></tr>
<tr class="separator:a7263a0a0567dbf5a86546ec41d925be2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pro_attribs_classpFlow_1_1includeMask"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classpFlow_1_1includeMask')"><img src="closed.png" alt="-"/>&#160;Protected Attributes inherited from <a class="el" href="classpFlow_1_1includeMask.html">includeMask</a></td></tr>
<tr class="memitem:a84505e826985ad10d53f4063d43128ea inherit pro_attribs_classpFlow_1_1includeMask"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">word</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classpFlow_1_1includeMask.html#a84505e826985ad10d53f4063d43128ea">fieldName_</a></td></tr>
<tr class="separator:a84505e826985ad10d53f4063d43128ea inherit pro_attribs_classpFlow_1_1includeMask"><td class="memSeparator" colspan="2">&#160;</td></tr>
@ -235,19 +230,19 @@ class pFlow::IncludeMask&lt; T, Operator &gt;</h3>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IncludeMask_8hpp_source.html#l00195">195</a> of file <a class="el" href="IncludeMask_8hpp_source.html">IncludeMask.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IncludeMask_8hpp_source.html#l00196">196</a> of file <a class="el" href="IncludeMask_8hpp_source.html">IncludeMask.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a987babac16091c970f2cc833d91b3323"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a987babac16091c970f2cc833d91b3323">&#9670;&nbsp;</a></span>TypeInfoTemplate2()</h2>
<a id="a4c77096f8f8cd5766e825246c6ebf956"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4c77096f8f8cd5766e825246c6ebf956">&#9670;&nbsp;</a></span>TypeInfoTemplate12()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">TypeInfoTemplate2 </td>
<td class="memname">TypeInfoTemplate12 </td>
<td>(</td>
<td class="paramtype">&quot;IncludeMask&lt; T, Operator &gt;&quot;&#160;</td>
<td class="paramname">, </td>
@ -334,9 +329,40 @@ class pFlow::IncludeMask&lt; T, Operator &gt;</h3>
<p>Implements <a class="el" href="classpFlow_1_1includeMask.html#a5a10e8220d7eafbc617b1b1614cc4994">includeMask</a>.</p>
<p class="definition">Definition at line <a class="el" href="IncludeMask_8hpp_source.html#l00210">210</a> of file <a class="el" href="IncludeMask_8hpp_source.html">IncludeMask.hpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="IncludeMask_8hpp_source.html#l00213">213</a> of file <a class="el" href="IncludeMask_8hpp_source.html">IncludeMask.hpp</a>.</p>
<p class="reference">References <a class="el" href="IncludeMask_8hpp_source.html#l00189">IncludeMask&lt; T, Operator &gt;::field_</a>, <a class="el" href="NBSCrossLoop_8hpp_source.html#l00024">n</a>, and <a class="el" href="IncludeMask_8hpp_source.html#l00187">IncludeMask&lt; T, Operator &gt;::operator_</a>.</p>
<p class="reference">References <a class="el" href="IncludeMask_8hpp_source.html#l00191">IncludeMask&lt; T, Operator &gt;::field_</a>, <a class="el" href="NBSLoop_8hpp_source.html#l00024">n</a>, and <a class="el" href="IncludeMask_8hpp_source.html#l00187">IncludeMask&lt; T, Operator &gt;::operator_</a>.</p>
</div>
</div>
<a id="afe7e8e9646618d94bc2bbf4a59f35017"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afe7e8e9646618d94bc2bbf4a59f35017">&#9670;&nbsp;</a></span>size()</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="namespacepFlow.html#abd01e8e67e3d94cab04ecaaf4f85ac1b">uint32</a> size </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">override</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Implements <a class="el" href="classpFlow_1_1includeMask.html#a186b30b9dfd8acd23958c14faaf92101">includeMask</a>.</p>
<p class="definition">Definition at line <a class="el" href="IncludeMask_8hpp_source.html#l00218">218</a> of file <a class="el" href="IncludeMask_8hpp_source.html">IncludeMask.hpp</a>.</p>
<p class="reference">References <a class="el" href="IncludeMask_8hpp_source.html#l00191">IncludeMask&lt; T, Operator &gt;::field_</a>.</p>
</div>
</div>
@ -363,12 +389,12 @@ class pFlow::IncludeMask&lt; T, Operator &gt;</h3>
<p class="definition">Definition at line <a class="el" href="IncludeMask_8hpp_source.html#l00187">187</a> of file <a class="el" href="IncludeMask_8hpp_source.html">IncludeMask.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="IncludeMask_8hpp_source.html#l00210">IncludeMask&lt; T, Operator &gt;::isIncluded()</a>.</p>
<p class="reference">Referenced by <a class="el" href="IncludeMask_8hpp_source.html#l00213">IncludeMask&lt; T, Operator &gt;::isIncluded()</a>.</p>
</div>
</div>
<a id="aa7484adb662fefbf7a44511753787f13"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa7484adb662fefbf7a44511753787f13">&#9670;&nbsp;</a></span>field_</h2>
<a id="aebe51f4313d13dab635fdf5ec428f1e7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebe51f4313d13dab635fdf5ec428f1e7">&#9670;&nbsp;</a></span>fieldPtr_</h2>
<div class="memitem">
<div class="memproto">
@ -377,7 +403,7 @@ class pFlow::IncludeMask&lt; T, Operator &gt;</h3>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="namespacepFlow.html#a09c79f0e74d5dd4336dca6ab67c032c3">pointField_H</a>&lt;T&gt; field_</td>
<td class="memname"><a class="el" href="classpFlow_1_1uniquePtr.html">uniquePtr</a>&lt;<a class="el" href="namespacepFlow.html#a298b83b09449b5123ed12206f026784d">pointField_H</a>&lt;T&gt; &gt; fieldPtr_</td>
</tr>
</table>
</td>
@ -389,7 +415,31 @@ class pFlow::IncludeMask&lt; T, Operator &gt;</h3>
<p class="definition">Definition at line <a class="el" href="IncludeMask_8hpp_source.html#l00189">189</a> of file <a class="el" href="IncludeMask_8hpp_source.html">IncludeMask.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="IncludeMask_8hpp_source.html#l00210">IncludeMask&lt; T, Operator &gt;::isIncluded()</a>.</p>
</div>
</div>
<a id="a7263a0a0567dbf5a86546ec41d925be2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7263a0a0567dbf5a86546ec41d925be2">&#9670;&nbsp;</a></span>field_</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="namespacepFlow.html#ad53198ba4452d5fdc966d861583fc70f">hostViewType1D</a>&lt;T&gt; field_</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p class="definition">Definition at line <a class="el" href="IncludeMask_8hpp_source.html#l00191">191</a> of file <a class="el" href="IncludeMask_8hpp_source.html">IncludeMask.hpp</a>.</p>
<p class="reference">Referenced by <a class="el" href="IncludeMask_8hpp_source.html#l00213">IncludeMask&lt; T, Operator &gt;::isIncluded()</a>, and <a class="el" href="IncludeMask_8hpp_source.html#l00218">IncludeMask&lt; T, Operator &gt;::size()</a>.</p>
</div>
</div>