Home Explore Help
Register Sign In
devn00b
/
EQ2EMu
9
3
Fork 0
Files Issues 59 Pull Requests 0 Wiki
Tree: 65109b0d5d
Branches Tags
EQ2EMu
/
EQ2
/
source
/
depends
/
boost_1_72_0
/
libs
/
spirit
/
classic
/
phoenix
/
doc
/
tuples.html

tuples.html 8.3 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103 
  1. <html>
    2. 

  2. <head>
    3. 

  3. <!-- Generated by the Spirit (http://spirit.sf.net) QuickDoc -->
    4. 

  4. <title>Tuples</title>
    5. 

  5. <link rel="stylesheet" href="theme/style.css" type="text/css">
    6. 

  6. <link rel="prev" href="inside_phoenix.html">
    7. 

  7. <link rel="next" href="actors_revisited.html">
    8. 

  8. </head>
    9. 

  9. <body>
    10. 

  10. <table width="100%" height="48" border="0" background="theme/bkd2.gif" cellspacing="2">
    11. 

  11.   <tr>
    12. 

  12.     <td width="10">
    13. 

  13.     </td>
    14. 

  14.     <td width="85%">
    15. 

  15.       <font size="6" face="Verdana, Arial, Helvetica, sans-serif"><b>Tuples</b></font>
    16. 

  16.     </td>
    17. 

  17.     <td width="112"><a href="http://spirit.sf.net"><img src="theme/spirit.gif" align="right" border="0"></a></td>
    18. 

  18.   </tr>
    19. 

  19. </table>
    20. 

  20. <br>
    21. 

  21. <table border="0">
    22. 

  22.   <tr>
    23. 

  23.     <td width="30"><a href="../index.html"><img src="theme/u_arr.gif" border="0"></a></td>
    24. 

  24.     <td width="30"><a href="inside_phoenix.html"><img src="theme/l_arr.gif" border="0"></a></td>
    25. 

  25.     <td width="20"><a href="actors_revisited.html"><img src="theme/r_arr.gif" border="0"></a></td>
    26. 

  26.    </tr>
    27. 

  27. </table>
    28. 

  28. <p>
    29. 

  29. Tuples are the most basic infrastructure that the framework builds with. This sub-library provides a mechanism to bundle objects of arbitrary types in a single structure. Tuples hold heterogeneous types up to a predefined maximum.</p>
    30. 

  30. <p>
    31. 

  31. Only the most basic functionality needed are provided. This is a straight-forward and extremely lean and mean library. Unlike other recursive list-like tuple implementations, this tuple library implementation uses simple structs similar to std::pair with specialization for 0 to N tuple elements, where N is a predefined constant. There are only 4 tuple operations to learn:</p>
    32. 

  32. <p>
    33. 

  33. 1)  Construction</p>
    34. 

  34. <p>
    35. 

  35. Here are examples on how to construct tuples:</p>
    36. 

  36. <code><pre>
    37. 

  37.     <span class=keyword>typedef </span><span class=identifier>tuple</span><span class=special>&lt;</span><span class=keyword>int</span><span class=special>, </span><span class=keyword>char</span><span class=special>&gt; </span><span class=identifier>t1_t</span><span class=special>;
    38. 

  38.     </span><span class=keyword>typedef </span><span class=identifier>tuple</span><span class=special>&lt;</span><span class=keyword>int</span><span class=special>, </span><span class=identifier>std</span><span class=special>::</span><span class=identifier>string</span><span class=special>, </span><span class=keyword>double</span><span class=special>&gt; </span><span class=identifier>t2_t</span><span class=special>;
    39. 

  39. 

  40.     //  </span><span class=keyword>this </span><span class=identifier>tuple </span><span class=identifier>has </span><span class=identifier>an </span><span class=keyword>int </span><span class=keyword>and </span><span class=keyword>char </span><span class=identifier>members
    41. 

  41.     </span><span class=identifier>t1_t </span><span class=identifier>t1</span><span class=special>(</span><span class=number>3</span><span class=special>, </span><span class=literal>'c'</span><span class=special>);
    42. 

  42. 

  43.     //  </span><span class=keyword>this </span><span class=identifier>tuple </span><span class=identifier>has </span><span class=identifier>an </span><span class=keyword>int</span><span class=special>, </span><span class=identifier>std</span><span class=special>::</span><span class=identifier>string </span><span class=keyword>and </span><span class=keyword>double </span><span class=identifier>members
    44. 

  44.     </span><span class=identifier>t2_t </span><span class=identifier>t2</span><span class=special>(</span><span class=number>3</span><span class=special>, </span><span class=string>&quot;hello&quot;</span><span class=special>, </span><span class=number>3.14</span><span class=special>);
    45. 

  45. </span></pre></code>
    46. 

  46. <p>
    47. 

  47. 2)  Member access</p>
    48. 

  48. <p>
    49. 

  49. A member in a tuple can be accessed using the tuple's  operator by specifying the Nth tuple_index. Here are some examples:</p>
    50. 

  50. <code><pre>
    51. 

  51.     <span class=identifier>tuple_index</span><span class=special>&lt;</span><span class=number>0</span><span class=special>&gt; </span><span class=identifier>ix0</span><span class=special>; // </span><span class=number>0</span><span class=identifier>th </span><span class=identifier>index </span><span class=special>== </span><span class=number>1</span><span class=identifier>st </span><span class=identifier>item
    52. 

  52.     </span><span class=identifier>tuple_index</span><span class=special>&lt;</span><span class=number>1</span><span class=special>&gt; </span><span class=identifier>ix1</span><span class=special>; // </span><span class=number>1</span><span class=identifier>st </span><span class=identifier>index </span><span class=special>== </span><span class=number>2</span><span class=identifier>nd </span><span class=identifier>item
    53. 

  53.     </span><span class=identifier>tuple_index</span><span class=special>&lt;</span><span class=number>2</span><span class=special>&gt; </span><span class=identifier>ix2</span><span class=special>; // </span><span class=number>2</span><span class=identifier>nd </span><span class=identifier>index </span><span class=special>== </span><span class=number>3</span><span class=identifier>rd </span><span class=identifier>item
    54. 

  54. 

  55.     </span><span class=comment>//  Note zero based indexing. 0 = 1st item, 1 = 2nd item
    56. 

  56. 

  57.     </span><span class=identifier>t1</span><span class=special>[</span><span class=identifier>ix0</span><span class=special>] = </span><span class=number>33</span><span class=special>;       // </span><span class=identifier>sets </span><span class=identifier>the </span><span class=keyword>int </span><span class=identifier>member </span><span class=identifier>of </span><span class=identifier>the </span><span class=identifier>tuple </span><span class=identifier>t1
    58. 

  58.     </span><span class=identifier>t2</span><span class=special>[</span><span class=identifier>ix2</span><span class=special>] = </span><span class=number>6e6</span><span class=special>;      // </span><span class=identifier>sets </span><span class=identifier>the </span><span class=keyword>double </span><span class=identifier>member </span><span class=identifier>of </span><span class=identifier>the </span><span class=identifier>tuple </span><span class=identifier>t2
    59. 

  59.     </span><span class=identifier>t1</span><span class=special>[</span><span class=identifier>ix1</span><span class=special>] = </span><span class=literal>'a'</span><span class=special>;      // </span><span class=identifier>sets </span><span class=identifier>the </span><span class=keyword>char </span><span class=identifier>member </span><span class=identifier>of </span><span class=identifier>the </span><span class=identifier>tuple </span><span class=identifier>t1
    60. 

  60. </span></pre></code>
    61. 

  61. <p>
    62. 

  62. Access to out of bound indexes returns a nil_t value.</p>
    63. 

  63. <p>
    64. 

  64. 3)  Member type inquiry</p>
    65. 

  65. <p>
    66. 

  66. The type of an individual member can be queried. Example:</p>
    67. 

  67. <code><pre>
    68. 

  68.     <span class=identifier>tuple_element</span><span class=special>&lt;</span><span class=number>1</span><span class=special>, </span><span class=identifier>t2_t</span><span class=special>&gt;::</span><span class=identifier>type
    69. 

  69. </span></pre></code>
    70. 

  70. <p>
    71. 

  71. Refers to the type of the second member (again note zero based indexing, hence 0 = 1st item, 1 = 2nd item) of the tuple.</p>
    72. 

  72. <p>
    73. 

  73. Access to out of bound indexes returns a nil_t type.</p>
    74. 

  74. <p>
    75. 

  75. 4)  Tuple length</p>
    76. 

  76. <p>
    77. 

  77. The number of elements in a tuple can be queried. Example:</p>
    78. 

  78. <code><pre>
    79. 

  79.     <span class=keyword>int </span><span class=identifier>n </span><span class=special>= </span><span class=identifier>t1</span><span class=special>.</span><span class=identifier>length</span><span class=special>;
    80. 

  80. </span></pre></code>
    81. 

  81. <p>
    82. 

  82. gets the number of elements in tuple t1.</p>
    83. 

  83. <p>
    84. 

  84. length is a static constant. Thus, TupleT::length also works. Example:</p>
    85. 

  85. <code><pre>
    86. 

  86.     <span class=keyword>int </span><span class=identifier>n </span><span class=special>= </span><span class=identifier>t1_t</span><span class=special>::</span><span class=identifier>length</span><span class=special>;
    87. 

  87. </span></pre></code>
    88. 

  88. <table border="0">
    89. 

  89.   <tr>
    90. 

  90.     <td width="30"><a href="../index.html"><img src="theme/u_arr.gif" border="0"></a></td>
    91. 

  91.     <td width="30"><a href="inside_phoenix.html"><img src="theme/l_arr.gif" border="0"></a></td>
    92. 

  92.     <td width="20"><a href="actors_revisited.html"><img src="theme/r_arr.gif" border="0"></a></td>
    93. 

  93.    </tr>
    94. 

  94. </table>
    95. 

  95. <br>
    96. 

  96. <hr size="1">
    97. 

  97. <p class="copyright">Copyright &copy; 2001-2002 Joel de Guzman<br>
    98. 

  98.   <br>
    99. 

  99. <font size="2">Use, modification and distribution is subject to the Boost Software
    100. 

  100.     License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
    101. 

  101.     http://www.boost.org/LICENSE_1_0.txt) </font> </p>
    102. 

  102. </body>
    103. 

  103. </html>
    104.