annotated.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.13"/>
  7. <meta name="viewport" content="width=device-width, initial-scale=1"/>
  8. <title>TTTT Analysis: Class List</title>
  9. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  13. <script type="text/javascript" src="search/searchdata.js"></script>
  14. <script type="text/javascript" src="search/search.js"></script>
  15. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  16. </head>
  17. <body>
  18. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  19. <div id="titlearea">
  20. <table cellspacing="0" cellpadding="0">
  21. <tbody>
  22. <tr style="height: 56px;">
  23. <td id="projectalign" style="padding-left: 0.5em;">
  24. <div id="projectname">TTTT Analysis
  25. &#160;<span id="projectnumber">0.1</span>
  26. </div>
  27. </td>
  28. </tr>
  29. </tbody>
  30. </table>
  31. </div>
  32. <!-- end header part -->
  33. <!-- Generated by Doxygen 1.8.13 -->
  34. <script type="text/javascript">
  35. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  36. </script>
  37. <script type="text/javascript" src="menudata.js"></script>
  38. <script type="text/javascript" src="menu.js"></script>
  39. <script type="text/javascript">
  40. $(function() {
  41. initMenu('',true,false,'search.php','Search');
  42. $(document).ready(function() { init_search(); });
  43. });
  44. </script>
  45. <div id="main-nav"></div>
  46. </div><!-- top -->
  47. <!-- window showing the filter options -->
  48. <div id="MSearchSelectWindow"
  49. onmouseover="return searchBox.OnSearchSelectShow()"
  50. onmouseout="return searchBox.OnSearchSelectHide()"
  51. onkeydown="return searchBox.OnSearchSelectKey(event)">
  52. </div>
  53. <!-- iframe showing the search results (closed by default) -->
  54. <div id="MSearchResultsWindow">
  55. <iframe src="javascript:void(0)" frameborder="0"
  56. name="MSearchResults" id="MSearchResults">
  57. </iframe>
  58. </div>
  59. <div class="header">
  60. <div class="headertitle">
  61. <div class="title">Class List</div> </div>
  62. </div><!--header-->
  63. <div class="contents">
  64. <div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
  65. <div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
  66. <tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacefv.html" target="_self">fv</a></td><td class="desc">The namespace containing all filval classes and functions </td></tr>
  67. <tr id="row_0_0_"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_0_" class="arrow" onclick="toggleFolder('0_0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><b>root</b></td><td class="desc"></td></tr>
  68. <tr id="row_0_0_0_" class="even"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1root_1_1Counter.html" target="_self">Counter</a></td><td class="desc">A <a class="el" href="classfv_1_1root_1_1Counter.html" title="A Counter that keeps a mapping of the number of occurances of each input value. ">Counter</a> that keeps a mapping of the number of occurances of each input value </td></tr>
  69. <tr id="row_0_0_1_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1root_1_1CounterMany.html" target="_self">CounterMany</a></td><td class="desc">Same as <a class="el" href="classfv_1_1root_1_1Counter.html" title="A Counter that keeps a mapping of the number of occurances of each input value. ">Counter</a> but accepts multiple values per fill </td></tr>
  70. <tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Apply_3_01Ret_07ArgTypes_8_8_8_08_4.html" target="_self">Apply&lt; Ret(ArgTypes...)&gt;</a></td><td class="desc">Applies a function to a tuple of values and returns a value </td></tr>
  71. <tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1BoundValue.html" target="_self">BoundValue</a></td><td class="desc">A generic value owning only a function object </td></tr>
  72. <tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1CartProduct.html" target="_self">CartProduct</a></td><td class="desc">Calculate the cartesian product of two input vectors </td></tr>
  73. <tr id="row_0_4_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Combinations.html" target="_self">Combinations</a></td><td class="desc">Find combinations of items from an input vector </td></tr>
  74. <tr id="row_0_5_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1ConstantValue.html" target="_self">ConstantValue</a></td><td class="desc">A <a class="el" href="classfv_1_1Value.html" title="A templated value. ">Value</a> which always returns the same value, supplied in the constructor </td></tr>
  75. <tr id="row_0_6_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Container.html" target="_self">Container</a></td><td class="desc">A class that is used to "hold" values </td></tr>
  76. <tr id="row_0_7_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1ContainerMean.html" target="_self">ContainerMean</a></td><td class="desc">Calculate the <a class="el" href="classfv_1_1Mean.html" title="Calculate the mean value of a vector. ">Mean</a> of a <a class="el" href="classfv_1_1Value.html" title="A templated value. ">Value</a> over a series of observations </td></tr>
  77. <tr id="row_0_8_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Count.html" target="_self">Count</a></td><td class="desc">Returns the count of elements in the input vector passing a test function </td></tr>
  78. <tr id="row_0_9_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1DerivedValue.html" target="_self">DerivedValue</a></td><td class="desc">A <a class="el" href="classfv_1_1Value.html" title="A templated value. ">Value</a> derived from some other Values, not directly from the dataset </td></tr>
  79. <tr id="row_0_10_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1DeTup.html" target="_self">DeTup</a></td><td class="desc">Gets the Nth element from a tuple value </td></tr>
  80. <tr id="row_0_11_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1DeTupVector.html" target="_self">DeTupVector</a></td><td class="desc">Creates a vector of extracting the Nth value from each entry in a vector of tuples </td></tr>
  81. <tr id="row_0_12_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1ElementOf.html" target="_self">ElementOf</a></td><td class="desc">Extract the element at a specific index from a vector </td></tr>
  82. <tr id="row_0_13_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Filter.html" target="_self">Filter</a></td><td class="desc">Returns the elements in a vector that pass a test function </td></tr>
  83. <tr id="row_0_14_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Function_3_01R_07ArgTypes_8_8_8_08_4.html" target="_self">Function&lt; R(ArgTypes...)&gt;</a></td><td class="desc">In order to enable proper provenance tracking, and at the same time keep the ability to embed functions into values, the Function class should be used </td></tr>
  84. <tr id="row_0_15_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1GenContainer.html" target="_self">GenContainer</a></td><td class="desc">Generic, untyped parent class of <a class="el" href="classfv_1_1Container.html" title="A class that is used to &quot;hold&quot; values. ">Container</a> </td></tr>
  85. <tr id="row_0_16_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1GenFunction.html" target="_self">GenFunction</a></td><td class="desc">Parent class to all Function classes </td></tr>
  86. <tr id="row_0_17_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Map_3_01Ret_07ArgTypes_8_8_8_08_4.html" target="_self">Map&lt; Ret(ArgTypes...)&gt;</a></td><td class="desc">Maps a function over an input vector </td></tr>
  87. <tr id="row_0_18_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Max.html" target="_self">Max</a></td><td class="desc">Find and return the maximum value of a vector </td></tr>
  88. <tr id="row_0_19_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1MaxIndex.html" target="_self">MaxIndex</a></td><td class="desc">Find and return the maximum value of a vector and its index </td></tr>
  89. <tr id="row_0_20_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Mean.html" target="_self">Mean</a></td><td class="desc">Calculate the mean value of a vector </td></tr>
  90. <tr id="row_0_21_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Min.html" target="_self">Min</a></td><td class="desc">Find and return the minimum value of a vector </td></tr>
  91. <tr id="row_0_22_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1MinIndex.html" target="_self">MinIndex</a></td><td class="desc">Find and return the minimum value of a vector and its index </td></tr>
  92. <tr id="row_0_23_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1ObservedValue.html" target="_self">ObservedValue</a></td><td class="desc">A value supplied by the dataset, not derived </td></tr>
  93. <tr id="row_0_24_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Pair.html" target="_self">Pair</a></td><td class="desc">Creates a std::pair type from a two other <a class="el" href="classfv_1_1Value.html" title="A templated value. ">Value</a> objects </td></tr>
  94. <tr id="row_0_25_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1PointerValue.html" target="_self">PointerValue</a></td><td class="desc">A <a class="el" href="classfv_1_1Value.html" title="A templated value. ">Value</a> of a pointer </td></tr>
  95. <tr id="row_0_26_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Range.html" target="_self">Range</a></td><td class="desc">Calculate the range of the values in a vector </td></tr>
  96. <tr id="row_0_27_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Reduce.html" target="_self">Reduce</a></td><td class="desc"><a class="el" href="classfv_1_1Reduce.html" title="Reduce a Value of type vector&lt;T&gt; to just a T. ">Reduce</a> a <a class="el" href="classfv_1_1Value.html" title="A templated value. ">Value</a> of type vector&lt;T&gt; to just a T </td></tr>
  97. <tr id="row_0_28_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1ReduceIndex.html" target="_self">ReduceIndex</a></td><td class="desc">Similar to <a class="el" href="classfv_1_1Reduce.html" title="Reduce a Value of type vector&lt;T&gt; to just a T. ">Reduce</a>, but returns a pair of a T and an int </td></tr>
  98. <tr id="row_0_29_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1TupFilter.html" target="_self">TupFilter</a></td><td class="desc">Returns the elements in a vector that pass a test function </td></tr>
  99. <tr id="row_0_30_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Tuple.html" target="_self">Tuple</a></td><td class="desc">Takes a series of <a class="el" href="classfv_1_1Value.html" title="A templated value. ">Value</a> objects and bundles them together into a std::tuple object </td></tr>
  100. <tr id="row_0_31_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Value.html" target="_self">Value</a></td><td class="desc">A templated value </td></tr>
  101. <tr id="row_0_32_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1WrapperVector.html" target="_self">WrapperVector</a></td><td class="desc">A std::vector wrapper around a C-style array </td></tr>
  102. <tr id="row_0_33_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classfv_1_1Zip.html" target="_self">Zip</a></td><td class="desc">Zips a series of vectors together </td></tr>
  103. </table>
  104. </div><!-- directory -->
  105. </div><!-- contents -->
  106. <!-- start footer part -->
  107. <hr class="footer"/><address class="footer"><small>
  108. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  109. <img class="footer" src="doxygen.png" alt="doxygen"/>
  110. </a> 1.8.13
  111. </small></address>
  112. </body>
  113. </html>