<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> <title>PolyBoRi: polybori::CVariableNames Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body> <!-- Generated by Doxygen 1.5.9 --> <div class="navigation" id="top"> <div class="tabs"> <ul> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <div class="navpath"><a class="el" href="namespacepolybori.html">polybori</a>::<a class="el" href="classpolybori_1_1CVariableNames.html">CVariableNames</a> </div> </div> <div class="contents"> <h1>polybori::CVariableNames Class Reference</h1><!-- doxytag: class="polybori::CVariableNames" --><code>#include <<a class="el" href="CVariableNames_8h_source.html">CVariableNames.h</a>></code> <p> <p> <a href="classpolybori_1_1CVariableNames-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> <tr><td></td></tr> <tr><td colspan="2"><br><h2>Public Types</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="structpolybori_1_1CAuxTypes.html#5064c96eafe7bcf2b716dacb8b63113d">CTypes::vartext_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CVariableNames.html#b4d052de04c2a82d53bb4951ca7be645">vartext_type</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Define type for setting/getting names of variables. <a href="#b4d052de04c2a82d53bb4951ca7be645"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CVariableNames.html#25e63830cf6e66d047bd1ac0e4572d58">varname_type</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Define type for storing names of variables. <a href="#25e63830cf6e66d047bd1ac0e4572d58"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector< <a class="el" href="classpolybori_1_1CVariableNames.html#25e63830cf6e66d047bd1ac0e4572d58">varname_type</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CVariableNames.html#cb0b581ed35c08ed94ed329b6ec7330f">storage_type</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Define type for storing names of variables. <a href="#cb0b581ed35c08ed94ed329b6ec7330f"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef storage_type::reference </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CVariableNames.html#0b0cc0478ed476d10e2ba33a94144d2d">reference</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Define type for write accessing elements. <a href="#0b0cc0478ed476d10e2ba33a94144d2d"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classpolybori_1_1CVariableNames.html#b4d052de04c2a82d53bb4951ca7be645">vartext_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CVariableNames.html#8a5e6b1affc37227dc3610a2d676da5c">const_reference</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Define type for outputing variable names. <a href="#8a5e6b1affc37227dc3610a2d676da5c"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classpolybori_1_1CVariableNames.html">CVariableNames</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CVariableNames.html#677e0e783e7cdc3cc52c12fa24568034">self</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Define type of *this. <a href="#677e0e783e7cdc3cc52c12fa24568034"></a><br></td></tr> <tr><td colspan="2"><div class="groupHeader">adopt global type definitions</div></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="structpolybori_1_1CAuxTypes.html#0e254f927049b57061437ac57ea5c2cd">CTypes::size_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CVariableNames.html#d1d10e3378cc1dffa9a18b6e4bf9e2f4">size_type</a></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="structpolybori_1_1CAuxTypes.html#8c170014c637d9ecf5950063ca30ef46">CTypes::idx_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CVariableNames.html#5311a2f0d4a2ace68fe66dcd25c1826e">idx_type</a></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CVariableNames.html#1625c7e8d8b6abda63e4e2e8aa38f95b">CVariableNames</a> (<a class="el" href="classpolybori_1_1CVariableNames.html#d1d10e3378cc1dffa9a18b6e4bf9e2f4">size_type</a> nvars)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#1625c7e8d8b6abda63e4e2e8aa38f95b"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CVariableNames.html#e61363a9f6c937845a624e1c12fd7b4d">CVariableNames</a> (const <a class="el" href="classpolybori_1_1CVariableNames.html">self</a> &rhs)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Copy Constructor. <a href="#e61363a9f6c937845a624e1c12fd7b4d"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CVariableNames.html#a361186f914f5ba1973fd231640f1bb9">reset</a> (<a class="el" href="classpolybori_1_1CVariableNames.html#5311a2f0d4a2ace68fe66dcd25c1826e">idx_type</a> idx=0)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set default variable names. <a href="#a361186f914f5ba1973fd231640f1bb9"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classpolybori_1_1CVariableNames.html#8a5e6b1affc37227dc3610a2d676da5c">const_reference</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CVariableNames.html#aba77792c14b084119427806c3c8c4c1">operator[]</a> (<a class="el" href="classpolybori_1_1CVariableNames.html#5311a2f0d4a2ace68fe66dcd25c1826e">idx_type</a> idx) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get name of variable with index idx. <a href="#aba77792c14b084119427806c3c8c4c1"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CVariableNames.html#3c7e1b543fcad299a4dc646db26d63ac">set</a> (<a class="el" href="classpolybori_1_1CVariableNames.html#5311a2f0d4a2ace68fe66dcd25c1826e">idx_type</a> idx, const <a class="el" href="classpolybori_1_1CVariableNames.html#25e63830cf6e66d047bd1ac0e4572d58">varname_type</a> &varname)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get writable reference to name of variable with index idx. <a href="#3c7e1b543fcad299a4dc646db26d63ac"></a><br></td></tr> <tr><td colspan="2"><br><h2>Static Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classpolybori_1_1CVariableNames.html#8a5e6b1affc37227dc3610a2d676da5c">const_reference</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classpolybori_1_1CVariableNames.html#0b3ab85c0ee81044d1d2d83f449db157">undefName</a> ()</td></tr> </table> <hr><h2>Member Typedef Documentation</h2> <a class="anchor" name="8a5e6b1affc37227dc3610a2d676da5c"></a><!-- doxytag: member="polybori::CVariableNames::const_reference" ref="8a5e6b1affc37227dc3610a2d676da5c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="classpolybori_1_1CVariableNames.html#b4d052de04c2a82d53bb4951ca7be645">vartext_type</a> <a class="el" href="classpolybori_1_1CVariableNames.html#8a5e6b1affc37227dc3610a2d676da5c">polybori::CVariableNames::const_reference</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Define type for outputing variable names. <p> </div> </div><p> <a class="anchor" name="5311a2f0d4a2ace68fe66dcd25c1826e"></a><!-- doxytag: member="polybori::CVariableNames::idx_type" ref="5311a2f0d4a2ace68fe66dcd25c1826e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="structpolybori_1_1CAuxTypes.html#8c170014c637d9ecf5950063ca30ef46">CTypes::idx_type</a> <a class="el" href="classpolybori_1_1CVariableNames.html#5311a2f0d4a2ace68fe66dcd25c1826e">polybori::CVariableNames::idx_type</a> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="0b0cc0478ed476d10e2ba33a94144d2d"></a><!-- doxytag: member="polybori::CVariableNames::reference" ref="0b0cc0478ed476d10e2ba33a94144d2d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef storage_type::reference <a class="el" href="classpolybori_1_1CVariableNames.html#0b0cc0478ed476d10e2ba33a94144d2d">polybori::CVariableNames::reference</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Define type for write accessing elements. <p> </div> </div><p> <a class="anchor" name="677e0e783e7cdc3cc52c12fa24568034"></a><!-- doxytag: member="polybori::CVariableNames::self" ref="677e0e783e7cdc3cc52c12fa24568034" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="classpolybori_1_1CVariableNames.html">CVariableNames</a> <a class="el" href="classpolybori_1_1CVariableNames.html">polybori::CVariableNames::self</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Define type of *this. <p> </div> </div><p> <a class="anchor" name="d1d10e3378cc1dffa9a18b6e4bf9e2f4"></a><!-- doxytag: member="polybori::CVariableNames::size_type" ref="d1d10e3378cc1dffa9a18b6e4bf9e2f4" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="structpolybori_1_1CAuxTypes.html#0e254f927049b57061437ac57ea5c2cd">CTypes::size_type</a> <a class="el" href="classpolybori_1_1CVariableNames.html#d1d10e3378cc1dffa9a18b6e4bf9e2f4">polybori::CVariableNames::size_type</a> </td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <a class="anchor" name="cb0b581ed35c08ed94ed329b6ec7330f"></a><!-- doxytag: member="polybori::CVariableNames::storage_type" ref="cb0b581ed35c08ed94ed329b6ec7330f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef std::vector<<a class="el" href="classpolybori_1_1CVariableNames.html#25e63830cf6e66d047bd1ac0e4572d58">varname_type</a>> <a class="el" href="classpolybori_1_1CVariableNames.html#cb0b581ed35c08ed94ed329b6ec7330f">polybori::CVariableNames::storage_type</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Define type for storing names of variables. <p> </div> </div><p> <a class="anchor" name="25e63830cf6e66d047bd1ac0e4572d58"></a><!-- doxytag: member="polybori::CVariableNames::varname_type" ref="25e63830cf6e66d047bd1ac0e4572d58" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef std::string <a class="el" href="classpolybori_1_1CVariableNames.html#25e63830cf6e66d047bd1ac0e4572d58">polybori::CVariableNames::varname_type</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Define type for storing names of variables. <p> </div> </div><p> <a class="anchor" name="b4d052de04c2a82d53bb4951ca7be645"></a><!-- doxytag: member="polybori::CVariableNames::vartext_type" ref="b4d052de04c2a82d53bb4951ca7be645" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef <a class="el" href="structpolybori_1_1CAuxTypes.html#5064c96eafe7bcf2b716dacb8b63113d">CTypes::vartext_type</a> <a class="el" href="classpolybori_1_1CVariableNames.html#b4d052de04c2a82d53bb4951ca7be645">polybori::CVariableNames::vartext_type</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Define type for setting/getting names of variables. <p> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="1625c7e8d8b6abda63e4e2e8aa38f95b"></a><!-- doxytag: member="polybori::CVariableNames::CVariableNames" ref="1625c7e8d8b6abda63e4e2e8aa38f95b" args="(size_type nvars)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">polybori::CVariableNames::CVariableNames </td> <td>(</td> <td class="paramtype"><a class="el" href="classpolybori_1_1CVariableNames.html#d1d10e3378cc1dffa9a18b6e4bf9e2f4">size_type</a> </td> <td class="paramname"> <em>nvars</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Constructor. <p> </div> </div><p> <a class="anchor" name="e61363a9f6c937845a624e1c12fd7b4d"></a><!-- doxytag: member="polybori::CVariableNames::CVariableNames" ref="e61363a9f6c937845a624e1c12fd7b4d" args="(const self &rhs)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">polybori::CVariableNames::CVariableNames </td> <td>(</td> <td class="paramtype">const <a class="el" href="classpolybori_1_1CVariableNames.html">self</a> & </td> <td class="paramname"> <em>rhs</em> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Copy Constructor. <p> </div> </div><p> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="aba77792c14b084119427806c3c8c4c1"></a><!-- doxytag: member="polybori::CVariableNames::operator[]" ref="aba77792c14b084119427806c3c8c4c1" args="(idx_type idx) const " --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classpolybori_1_1CVariableNames.html#8a5e6b1affc37227dc3610a2d676da5c">const_reference</a> polybori::CVariableNames::operator[] </td> <td>(</td> <td class="paramtype"><a class="el" href="classpolybori_1_1CVariableNames.html#5311a2f0d4a2ace68fe66dcd25c1826e">idx_type</a> </td> <td class="paramname"> <em>idx</em> </td> <td> ) </td> <td> const<code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get name of variable with index idx. <p> <p>References <a class="el" href="pbori__defs_8h_source.html#l00175">UNLIKELY</a>.</p> </div> </div><p> <a class="anchor" name="a361186f914f5ba1973fd231640f1bb9"></a><!-- doxytag: member="polybori::CVariableNames::reset" ref="a361186f914f5ba1973fd231640f1bb9" args="(idx_type idx=0)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void polybori::CVariableNames::reset </td> <td>(</td> <td class="paramtype"><a class="el" href="classpolybori_1_1CVariableNames.html#5311a2f0d4a2ace68fe66dcd25c1826e">idx_type</a> </td> <td class="paramname"> <em>idx</em> = <code>0</code> </td> <td> ) </td> <td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Set default variable names. <p> </div> </div><p> <a class="anchor" name="3c7e1b543fcad299a4dc646db26d63ac"></a><!-- doxytag: member="polybori::CVariableNames::set" ref="3c7e1b543fcad299a4dc646db26d63ac" args="(idx_type idx, const varname_type &varname)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void polybori::CVariableNames::set </td> <td>(</td> <td class="paramtype"><a class="el" href="classpolybori_1_1CVariableNames.html#5311a2f0d4a2ace68fe66dcd25c1826e">idx_type</a> </td> <td class="paramname"> <em>idx</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classpolybori_1_1CVariableNames.html#25e63830cf6e66d047bd1ac0e4572d58">varname_type</a> & </td> <td class="paramname"> <em>varname</em></td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Get writable reference to name of variable with index idx. <p> <p>References <a class="el" href="pbori__defs_8h_source.html#l00175">UNLIKELY</a>.</p> </div> </div><p> <a class="anchor" name="0b3ab85c0ee81044d1d2d83f449db157"></a><!-- doxytag: member="polybori::CVariableNames::undefName" ref="0b3ab85c0ee81044d1d2d83f449db157" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">static <a class="el" href="classpolybori_1_1CVariableNames.html#8a5e6b1affc37227dc3610a2d676da5c">const_reference</a> polybori::CVariableNames::undefName </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td><code> [inline, static, protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p> </div> </div><p> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="CVariableNames_8h_source.html">CVariableNames.h</a></ul> </div> <hr size="1"><address style="text-align: right;"><small>Generated on Wed Sep 9 14:31:03 2009 for PolyBoRi by <a href="http://www.doxygen.org/index.html"> <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.9 </small></address> </body> </html>