Files
pip/doc/html/picontainers_8h.html

253 lines
15 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.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>PIP: src_main/containers/picontainers.h File 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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(initResizable);
/* @license-end */</script>
<link href="doxygen.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">PIP
&#160;<span id="projectnumber">1.7.1</span>
</div>
<div id="projectbrief">Platform-Independent Primitives</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',false,false,'search.php','Search');
});
/* @license-end */</script>
<div id="main-nav"></div>
</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('picontainers_8h.html','');});
/* @license-end */
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">picontainers.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Base for generic containers.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aa579232460ca92efa5c1befd41d923ba"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="picontainers_8h.html#aa579232460ca92efa5c1befd41d923ba">piForeach</a>(i, c)</td></tr>
<tr class="memdesc:aa579232460ca92efa5c1befd41d923ba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macro for iterate any container. <a href="#aa579232460ca92efa5c1befd41d923ba">More...</a><br /></td></tr>
<tr class="separator:aa579232460ca92efa5c1befd41d923ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a807914d038e5a193d2e36b4b82b6df96"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="picontainers_8h.html#a807914d038e5a193d2e36b4b82b6df96">piForeachC</a>(i, c)</td></tr>
<tr class="memdesc:a807914d038e5a193d2e36b4b82b6df96"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macro for iterate any container only for read. <a href="#a807914d038e5a193d2e36b4b82b6df96">More...</a><br /></td></tr>
<tr class="separator:a807914d038e5a193d2e36b4b82b6df96"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e968bf591ab05721d5ef2ce201e09ed"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="picontainers_8h.html#a0e968bf591ab05721d5ef2ce201e09ed">piForeachR</a>(i, c)</td></tr>
<tr class="memdesc:a0e968bf591ab05721d5ef2ce201e09ed"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macro for iterate any container with reverse direction. <a href="#a0e968bf591ab05721d5ef2ce201e09ed">More...</a><br /></td></tr>
<tr class="separator:a0e968bf591ab05721d5ef2ce201e09ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad2685d4ca04df1f2154844e5984b41d8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="picontainers_8h.html#ad2685d4ca04df1f2154844e5984b41d8">piForeachCR</a>(i, c)</td></tr>
<tr class="memdesc:ad2685d4ca04df1f2154844e5984b41d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macro for iterate any container only for read with reverse direction. <a href="#ad2685d4ca04df1f2154844e5984b41d8">More...</a><br /></td></tr>
<tr class="separator:ad2685d4ca04df1f2154844e5984b41d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa315501e5bd9c279ad09fd39dccdea4d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="picontainers_8h.html#aa315501e5bd9c279ad09fd39dccdea4d">piBreak</a></td></tr>
<tr class="memdesc:aa315501e5bd9c279ad09fd39dccdea4d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Macro for break from any piForeach* loop. <a href="#aa315501e5bd9c279ad09fd39dccdea4d">More...</a><br /></td></tr>
<tr class="separator:aa315501e5bd9c279ad09fd39dccdea4d"><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>Base for generic containers. </p>
<p>This file declare all containers and useful macros to use them </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aa579232460ca92efa5c1befd41d923ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa579232460ca92efa5c1befd41d923ba">&#9670;&nbsp;</a></span>piForeach</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define piForeach</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">i, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">c&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Macro for iterate any container. </p>
<p>Use this macros instead of standard "for" to get read/write access to each element of container. Pass direction is direct <br />
Example: </p><div class="fragment"><div class="line"><a class="code" href="class_p_i_vector.html">PIVector&lt;int&gt;</a> vec;</div><div class="line">vec &lt;&lt; 1 &lt;&lt; 2 &lt;&lt; 3;</div><div class="line"><a class="code" href="picontainers_8h.html#aa579232460ca92efa5c1befd41d923ba">piForeach</a> (<span class="keywordtype">int</span> &amp; i, vec)</div><div class="line"> cout &lt;&lt; i &lt;&lt; <span class="stringliteral">&quot;, &quot;</span>;</div><div class="line"><span class="comment">// 1, 2, 3, </span></div><div class="line"><a class="code" href="picontainers_8h.html#aa579232460ca92efa5c1befd41d923ba">piForeach</a> (<span class="keywordtype">int</span> &amp; i, vec)</div><div class="line"> i++;</div><div class="line"><a class="code" href="picontainers_8h.html#aa579232460ca92efa5c1befd41d923ba">piForeach</a> (<span class="keywordtype">int</span> &amp; i, vec)</div><div class="line"> cout &lt;&lt; i &lt;&lt; <span class="stringliteral">&quot;, &quot;</span>;</div><div class="line"><span class="comment">// 2, 3, 4, </span></div></div><!-- fragment -->
</div>
</div>
<a id="a807914d038e5a193d2e36b4b82b6df96"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a807914d038e5a193d2e36b4b82b6df96">&#9670;&nbsp;</a></span>piForeachC</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define piForeachC</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">i, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">c&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Macro for iterate any container only for read. </p>
<p>Use this macros instead of standard "for" to get read access to each element of container. Pass direction is direct <br />
Example: </p><div class="fragment"><div class="line"><a class="code" href="class_p_i_vector.html">PIVector&lt;int&gt;</a> vec;</div><div class="line">vec &lt;&lt; 1 &lt;&lt; 2 &lt;&lt; 3;</div><div class="line"><a class="code" href="picontainers_8h.html#a807914d038e5a193d2e36b4b82b6df96">piForeachC</a> (<span class="keywordtype">int</span> &amp; i, vec)</div><div class="line"> cout &lt;&lt; i &lt;&lt; <span class="stringliteral">&quot;, &quot;</span>;</div><div class="line"><span class="comment">// 1, 2, 3, </span></div><div class="line"><a class="code" href="picontainers_8h.html#a807914d038e5a193d2e36b4b82b6df96">piForeachC</a> (<span class="keywordtype">int</span> &amp; i, vec)</div><div class="line"> i++; <span class="comment">// ERROR! const iterator</span></div></div><!-- fragment -->
</div>
</div>
<a id="a0e968bf591ab05721d5ef2ce201e09ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e968bf591ab05721d5ef2ce201e09ed">&#9670;&nbsp;</a></span>piForeachR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define piForeachR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">i, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">c&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Macro for iterate any container with reverse direction. </p>
<p>Use this macros instead of standard "for" to get read/write access to each element of container. Pass direction is reverse <br />
Example: </p><div class="fragment"><div class="line"><a class="code" href="class_p_i_vector.html">PIVector&lt;int&gt;</a> vec;</div><div class="line">vec &lt;&lt; 1 &lt;&lt; 2 &lt;&lt; 3;</div><div class="line"><a class="code" href="picontainers_8h.html#a0e968bf591ab05721d5ef2ce201e09ed">piForeachR</a> (<span class="keywordtype">int</span> &amp; i, vec)</div><div class="line"> cout &lt;&lt; i &lt;&lt; <span class="stringliteral">&quot;, &quot;</span>;</div><div class="line"><span class="comment">// 3, 2, 1, </span></div><div class="line"><a class="code" href="picontainers_8h.html#a0e968bf591ab05721d5ef2ce201e09ed">piForeachR</a> (<span class="keywordtype">int</span> &amp; i, vec)</div><div class="line"> i++;</div><div class="line"><a class="code" href="picontainers_8h.html#a0e968bf591ab05721d5ef2ce201e09ed">piForeachR</a> (<span class="keywordtype">int</span> &amp; i, vec)</div><div class="line"> cout &lt;&lt; i &lt;&lt; <span class="stringliteral">&quot;, &quot;</span>;</div><div class="line"><span class="comment">// 4, 3, 2, </span></div></div><!-- fragment -->
</div>
</div>
<a id="ad2685d4ca04df1f2154844e5984b41d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2685d4ca04df1f2154844e5984b41d8">&#9670;&nbsp;</a></span>piForeachCR</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define piForeachCR</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">i, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">c&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Macro for iterate any container only for read with reverse direction. </p>
<p>Use this macros instead of standard "for" to get read access to each element of container. Pass direction is reverse <br />
Example: </p><div class="fragment"><div class="line"><a class="code" href="class_p_i_vector.html">PIVector&lt;int&gt;</a> vec;</div><div class="line">vec &lt;&lt; 1 &lt;&lt; 2 &lt;&lt; 3;</div><div class="line"><a class="code" href="picontainers_8h.html#ad2685d4ca04df1f2154844e5984b41d8">piForeachCR</a> (<span class="keywordtype">int</span> &amp; i, vec)</div><div class="line"> cout &lt;&lt; i &lt;&lt; <span class="stringliteral">&quot;, &quot;</span>;</div><div class="line"><span class="comment">// 3, 2, 1, </span></div><div class="line"><a class="code" href="picontainers_8h.html#ad2685d4ca04df1f2154844e5984b41d8">piForeachCR</a> (<span class="keywordtype">int</span> &amp; i, vec)</div><div class="line"> i++; <span class="comment">// ERROR! const iterator</span></div></div><!-- fragment -->
</div>
</div>
<a id="aa315501e5bd9c279ad09fd39dccdea4d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa315501e5bd9c279ad09fd39dccdea4d">&#9670;&nbsp;</a></span>piBreak</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define piBreak</td>
</tr>
</table>
</div><div class="memdoc">
<p>Macro for break from any piForeach* loop. </p>
<dl class="section warning"><dt>Warning</dt><dd>C++ ordinary "break" doesn`t work inside piForeach* loops! Always use "piBreak" instead! </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_c39d941190e65058370f775069a7d692.html">src_main</a></li><li class="navelem"><a class="el" href="dir_dcbbaf0efdc7c0424cf380791c96d727.html">containers</a></li><li class="navelem"><a class="el" href="picontainers_8h.html">picontainers.h</a></li>
<li class="footer">Generated on Tue Jul 17 2018 14:25:00 for PIP by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
</div>
</body>
</html>