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

@ -262,23 +262,23 @@ $(document).ready(function(){initNavTree('combinedRange_8hpp_source.html',''); i
<div class="ttc" id="aclasspFlow_1_1intervalRange_html_a7ac715f3b53f18c60bd73169fe9be2bc"><div class="ttname"><a href="classpFlow_1_1intervalRange.html#a7ac715f3b53f18c60bd73169fe9be2bc">pFlow::intervalRange::parseRange</a></div><div class="ttdeci">static bool parseRange(const word &amp;rangeString, T &amp;begin, T &amp;end)</div><div class="ttdef"><b>Definition:</b> <a href="intervalRange_8hpp_source.html#l00080">intervalRange.hpp:80</a></div></div>
<div class="ttc" id="aclasspFlow_1_1combinedRange_html_aadfbb6c22305cf1e35b4beaf382aca5a"><div class="ttname"><a href="classpFlow_1_1combinedRange.html#aadfbb6c22305cf1e35b4beaf382aca5a">pFlow::combinedRange::individuals_</a></div><div class="ttdeci">Set&lt; T &gt; individuals_</div><div class="ttdef"><b>Definition:</b> <a href="combinedRange_8hpp_source.html#l00050">combinedRange.hpp:50</a></div></div>
<div class="ttc" id="aclasspFlow_1_1List_html"><div class="ttname"><a href="classpFlow_1_1List.html">pFlow::List</a></div><div class="ttdef"><b>Definition:</b> <a href="List_8hpp_source.html#l00039">List.hpp:39</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a7463754e5378482488abf35490c46dd2"><div class="ttname"><a href="namespacepFlow.html#a7463754e5378482488abf35490c46dd2">pFlow::readValue</a></div><div class="ttdeci">bool readValue(const word &amp;w, real &amp;val)</div><div class="ttdef"><b>Definition:</b> <a href="bTypesFunctions_8hpp_source.html#l00140">bTypesFunctions.hpp:140</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a7463754e5378482488abf35490c46dd2"><div class="ttname"><a href="namespacepFlow.html#a7463754e5378482488abf35490c46dd2">pFlow::readValue</a></div><div class="ttdeci">bool readValue(const word &amp;w, real &amp;val)</div><div class="ttdef"><b>Definition:</b> <a href="bTypesFunctions_8hpp_source.html#l00191">bTypesFunctions.hpp:191</a></div></div>
<div class="ttc" id="aLists_8hpp_html"><div class="ttname"><a href="Lists_8hpp.html">Lists.hpp</a></div></div>
<div class="ttc" id="aerror_8hpp_html_aad22a1cd3b45a97ac8cd195f06fe61fe"><div class="ttname"><a href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">fatalExit</a></div><div class="ttdeci">#define fatalExit</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00057">error.hpp:57</a></div></div>
<div class="ttc" id="aerror_8hpp_html_aad22a1cd3b45a97ac8cd195f06fe61fe"><div class="ttname"><a href="error_8hpp.html#aad22a1cd3b45a97ac8cd195f06fe61fe">fatalExit</a></div><div class="ttdeci">#define fatalExit</div><div class="ttdoc">Fatal exit.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00098">error.hpp:98</a></div></div>
<div class="ttc" id="aSet_8hpp_html"><div class="ttname"><a href="Set_8hpp.html">Set.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1combinedRange_html_a2174415fd682f88846895dafefee9d31"><div class="ttname"><a href="classpFlow_1_1combinedRange.html#a2174415fd682f88846895dafefee9d31">pFlow::combinedRange::addStridedRange</a></div><div class="ttdeci">bool addStridedRange(const word &amp;strRange)</div><div class="ttdef"><b>Definition:</b> <a href="combinedRange_8hpp_source.html#l00080">combinedRange.hpp:80</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00063">builtinTypes.hpp:63</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a5a3972b374b884e9021d78ba9ea58014"><div class="ttname"><a href="namespacepFlow.html#a5a3972b374b884e9021d78ba9ea58014">pFlow::Set</a></div><div class="ttdeci">std::set&lt; Key, std::less&lt; Key &gt;, std::allocator&lt; Key &gt; &gt; Set</div><div class="ttdef"><b>Definition:</b> <a href="Set_8hpp_source.html#l00031">Set.hpp:31</a></div></div>
<div class="ttc" id="aclasspFlow_1_1stridedRange_html"><div class="ttname"><a href="classpFlow_1_1stridedRange.html">pFlow::stridedRange</a></div><div class="ttdef"><b>Definition:</b> <a href="stridedRange_8hpp_source.html#l00033">stridedRange.hpp:33</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a0ebe792a293e8c717bddf60070c0fe99"><div class="ttname"><a href="namespacepFlow.html#a0ebe792a293e8c717bddf60070c0fe99">pFlow::word</a></div><div class="ttdeci">std::string word</div><div class="ttdef"><b>Definition:</b> <a href="builtinTypes_8hpp_source.html#l00064">builtinTypes.hpp:64</a></div></div>
<div class="ttc" id="anamespacepFlow_html_a5a3972b374b884e9021d78ba9ea58014"><div class="ttname"><a href="namespacepFlow.html#a5a3972b374b884e9021d78ba9ea58014">pFlow::Set</a></div><div class="ttdeci">std::set&lt; Key, std::less&lt; Key &gt;, std::allocator&lt; Key &gt; &gt; Set</div><div class="ttdef"><b>Definition:</b> <a href="Set_8hpp_source.html#l00033">Set.hpp:33</a></div></div>
<div class="ttc" id="aclasspFlow_1_1stridedRange_html"><div class="ttname"><a href="classpFlow_1_1stridedRange.html">pFlow::stridedRange</a></div><div class="ttdef"><b>Definition:</b> <a href="stridedRange_8hpp_source.html#l00034">stridedRange.hpp:34</a></div></div>
<div class="ttc" id="aclasspFlow_1_1combinedRange_html_a504ecdaa95ec099d8d9d90f11e361141"><div class="ttname"><a href="classpFlow_1_1combinedRange.html#a504ecdaa95ec099d8d9d90f11e361141">pFlow::combinedRange::addIndividual</a></div><div class="ttdeci">bool addIndividual(const word &amp;strVal)</div><div class="ttdef"><b>Definition:</b> <a href="combinedRange_8hpp_source.html#l00121">combinedRange.hpp:121</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream &amp; endl(iOstream &amp;os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00320">iOstream.hpp:320</a></div></div>
<div class="ttc" id="anamespacepFlow_html_aba8f0c455a3fdb4b05ad33a25b13b189"><div class="ttname"><a href="namespacepFlow.html#aba8f0c455a3fdb4b05ad33a25b13b189">pFlow::endl</a></div><div class="ttdeci">iOstream &amp; endl(iOstream &amp;os)</div><div class="ttdoc">Add newline and flush stream.</div><div class="ttdef"><b>Definition:</b> <a href="iOstream_8hpp_source.html#l00341">iOstream.hpp:341</a></div></div>
<div class="ttc" id="aclasspFlow_1_1combinedRange_html_a107f494afd1b456c2659468157d69d5f"><div class="ttname"><a href="classpFlow_1_1combinedRange.html#a107f494afd1b456c2659468157d69d5f">pFlow::combinedRange::combinedRange</a></div><div class="ttdeci">combinedRange(const std::vector&lt; word &gt; &amp;strRanges)</div><div class="ttdef"><b>Definition:</b> <a href="combinedRange_8hpp_source.html#l00056">combinedRange.hpp:56</a></div></div>
<div class="ttc" id="anamespacepFlow_html"><div class="ttname"><a href="namespacepFlow.html">pFlow</a></div><div class="ttdef"><b>Definition:</b> <a href="demComponent_8hpp_source.html#l00028">demComponent.hpp:28</a></div></div>
<div class="ttc" id="anamespacepFlow_html"><div class="ttname"><a href="namespacepFlow.html">pFlow</a></div><div class="ttdef"><b>Definition:</b> <a href="demGeometry_8hpp_source.html#l00027">demGeometry.hpp:27</a></div></div>
<div class="ttc" id="aclasspFlow_1_1combinedRange_html_a8c798d9aa1b7ae340589bb9574b0b78f"><div class="ttname"><a href="classpFlow_1_1combinedRange.html#a8c798d9aa1b7ae340589bb9574b0b78f">pFlow::combinedRange::combinedRange</a></div><div class="ttdeci">combinedRange()</div><div class="ttdef"><b>Definition:</b> <a href="combinedRange_8hpp_source.html#l00054">combinedRange.hpp:54</a></div></div>
<div class="ttc" id="aclasspFlow_1_1combinedRange_html"><div class="ttname"><a href="classpFlow_1_1combinedRange.html">pFlow::combinedRange</a></div><div class="ttdef"><b>Definition:</b> <a href="combinedRange_8hpp_source.html#l00036">combinedRange.hpp:36</a></div></div>
<div class="ttc" id="aclasspFlow_1_1combinedRange_html_a59ec953d3d9b171d79c9f11b16f9c26d"><div class="ttname"><a href="classpFlow_1_1combinedRange.html#a59ec953d3d9b171d79c9f11b16f9c26d">pFlow::combinedRange::addIntervalRange</a></div><div class="ttdeci">bool addIntervalRange(const word &amp;strRange)</div><div class="ttdef"><b>Definition:</b> <a href="combinedRange_8hpp_source.html#l00097">combinedRange.hpp:97</a></div></div>
<div class="ttc" id="astridedRange_8hpp_html"><div class="ttname"><a href="stridedRange_8hpp.html">stridedRange.hpp</a></div></div>
<div class="ttc" id="aerror_8hpp_html_aca9aa547c8441e4410a65a2ce7c21554"><div class="ttname"><a href="error_8hpp.html#aca9aa547c8441e4410a65a2ce7c21554">fatalErrorInFunction</a></div><div class="ttdeci">#define fatalErrorInFunction</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00042">error.hpp:42</a></div></div>
<div class="ttc" id="aerror_8hpp_html_aca9aa547c8441e4410a65a2ce7c21554"><div class="ttname"><a href="error_8hpp.html#aca9aa547c8441e4410a65a2ce7c21554">fatalErrorInFunction</a></div><div class="ttdeci">#define fatalErrorInFunction</div><div class="ttdoc">Report a fatal error and function name and exit the application.</div><div class="ttdef"><b>Definition:</b> <a href="error_8hpp_source.html#l00077">error.hpp:77</a></div></div>
<div class="ttc" id="aclasspFlow_1_1combinedRange_html_adbbd1401a0edfb24f13accc47e8c85b9"><div class="ttname"><a href="classpFlow_1_1combinedRange.html#adbbd1401a0edfb24f13accc47e8c85b9">pFlow::combinedRange::addRanges</a></div><div class="ttdeci">bool addRanges(const std::vector&lt; word &gt; &amp;strRanges)</div><div class="ttdef"><b>Definition:</b> <a href="combinedRange_8hpp_source.html#l00064">combinedRange.hpp:64</a></div></div>
<div class="ttc" id="aclasspFlow_1_1combinedRange_html_a3a79e0cba51ba81ae2b0b13faeb00c3d"><div class="ttname"><a href="classpFlow_1_1combinedRange.html#a3a79e0cba51ba81ae2b0b13faeb00c3d">pFlow::combinedRange::addIndividual</a></div><div class="ttdeci">bool addIndividual(const T &amp;val)</div><div class="ttdef"><b>Definition:</b> <a href="combinedRange_8hpp_source.html#l00115">combinedRange.hpp:115</a></div></div>
<div class="ttc" id="aclasspFlow_1_1combinedRange_html_a5a3c06690014c015f02ad827514b8954"><div class="ttname"><a href="classpFlow_1_1combinedRange.html#a5a3c06690014c015f02ad827514b8954">pFlow::combinedRange::isMember</a></div><div class="ttdeci">bool isMember(T val) const</div><div class="ttdef"><b>Definition:</b> <a href="combinedRange_8hpp_source.html#l00131">combinedRange.hpp:131</a></div></div>
@ -288,7 +288,7 @@ $(document).ready(function(){initNavTree('combinedRange_8hpp_source.html',''); i
<div class="ttc" id="aclasspFlow_1_1combinedRange_html_ac028c434f72c1cb5fe0bfae4dcc3f069"><div class="ttname"><a href="classpFlow_1_1combinedRange.html#ac028c434f72c1cb5fe0bfae4dcc3f069">pFlow::combinedRange::addIntervalRange</a></div><div class="ttdeci">bool addIntervalRange(T begin, T end)</div><div class="ttdef"><b>Definition:</b> <a href="combinedRange_8hpp_source.html#l00109">combinedRange.hpp:109</a></div></div>
<div class="ttc" id="aclasspFlow_1_1combinedRange_html_a7a0d90a77dd06f2b1cde85ce12c47c9d"><div class="ttname"><a href="classpFlow_1_1combinedRange.html#a7a0d90a77dd06f2b1cde85ce12c47c9d">pFlow::combinedRange::addStridedRange</a></div><div class="ttdeci">bool addStridedRange(T begin, T end, T stride)</div><div class="ttdef"><b>Definition:</b> <a href="combinedRange_8hpp_source.html#l00091">combinedRange.hpp:91</a></div></div>
<div class="ttc" id="aintervalRange_8hpp_html"><div class="ttname"><a href="intervalRange_8hpp.html">intervalRange.hpp</a></div></div>
<div class="ttc" id="aclasspFlow_1_1stridedRange_html_a862698fba81c111cbfaca5ea0528e5dd"><div class="ttname"><a href="classpFlow_1_1stridedRange.html#a862698fba81c111cbfaca5ea0528e5dd">pFlow::stridedRange::parseRange</a></div><div class="ttdeci">static bool parseRange(const word &amp;rangeString, T &amp;begin, T &amp;end, T &amp;stride)</div><div class="ttdef"><b>Definition:</b> <a href="stridedRange_8hpp_source.html#l00109">stridedRange.hpp:109</a></div></div>
<div class="ttc" id="aclasspFlow_1_1stridedRange_html_a862698fba81c111cbfaca5ea0528e5dd"><div class="ttname"><a href="classpFlow_1_1stridedRange.html#a862698fba81c111cbfaca5ea0528e5dd">pFlow::stridedRange::parseRange</a></div><div class="ttdeci">static bool parseRange(const word &amp;rangeString, T &amp;begin, T &amp;end, T &amp;stride)</div><div class="ttdef"><b>Definition:</b> <a href="stridedRange_8hpp_source.html#l00121">stridedRange.hpp:121</a></div></div>
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_cd7a5046d028e114fc17b2ebc2bd02d2.html">phasicFlow</a></li><li class="navelem"><a class="el" href="dir_ec044aca4011302dcfd8183b03594e30.html">ranges</a></li><li class="navelem"><a class="el" href="combinedRange_8hpp.html">combinedRange.hpp</a></li>