container_8hpp_source.html 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  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: /home/caleb/Sources/TTTT/filval/container.hpp Source File</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. <!-- window showing the filter options -->
  47. <div id="MSearchSelectWindow"
  48. onmouseover="return searchBox.OnSearchSelectShow()"
  49. onmouseout="return searchBox.OnSearchSelectHide()"
  50. onkeydown="return searchBox.OnSearchSelectKey(event)">
  51. </div>
  52. <!-- iframe showing the search results (closed by default) -->
  53. <div id="MSearchResultsWindow">
  54. <iframe src="javascript:void(0)" frameborder="0"
  55. name="MSearchResults" id="MSearchResults">
  56. </iframe>
  57. </div>
  58. <div id="nav-path" class="navpath">
  59. <ul>
  60. <li class="navelem"><a class="el" href="dir_b2e1228fdb7fe80fc606210a4045f658.html">filval</a></li> </ul>
  61. </div>
  62. </div><!-- top -->
  63. <div class="header">
  64. <div class="headertitle">
  65. <div class="title">container.hpp</div> </div>
  66. </div><!--header-->
  67. <div class="contents">
  68. <a href="container_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="preprocessor">#ifndef container_hpp</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#define container_hpp</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#include &lt;typeindex&gt;</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#include &lt;map&gt;</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#include &quot;value.hpp&quot;</span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#include &quot;filter.hpp&quot;</span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keyword">template</span> <span class="keyword">class </span>std::vector&lt;std::vector&lt;float&gt; &gt;;</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="keyword">template</span> <span class="keyword">class </span>std::vector&lt;std::vector&lt;int&gt; &gt;;</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacefv_1_1util.html">fv::util</a>{</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;std::string get_type_name(<span class="keyword">const</span> std::type_index&amp; index){</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; std::map&lt;std::type_index, std::string&gt; _map;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="comment">// Add to this list as needed :)</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; _map[<span class="keyword">typeid</span>(int)]=<span class="stringliteral">&quot;int&quot;</span>;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; _map[<span class="keyword">typeid</span>(<span class="keywordtype">unsigned</span> int)]=<span class="stringliteral">&quot;unsigned int&quot;</span>;</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; _map[<span class="keyword">typeid</span>(float)]=<span class="stringliteral">&quot;float&quot;</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; _map[<span class="keyword">typeid</span>(double)]=<span class="stringliteral">&quot;double&quot;</span>;</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160; _map[<span class="keyword">typeid</span>(std::vector&lt;int&gt;)]=<span class="stringliteral">&quot;std::vector&lt;int&gt;&quot;</span>;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; _map[<span class="keyword">typeid</span>(std::vector&lt;float&gt;)]=<span class="stringliteral">&quot;std::vector&lt;float&gt;&quot;</span>;</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; <span class="keywordflow">if</span> (_map[index] == <span class="stringliteral">&quot;&quot;</span>){</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; CRITICAL(<span class="stringliteral">&quot;Cannot lookup type name of \&quot;&quot;</span> &lt;&lt; index.name() &lt;&lt; <span class="stringliteral">&quot;\&quot;&quot;</span>,-1);</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; }</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160; <span class="keywordflow">return</span> _map[index];</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;}</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;}</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacefv.html">fv</a>{</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160;</div><div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="namespacefv.html#a16a191c4b8935d4c7c5aad79fc4ea97e"> 67</a></span>&#160;<span class="keyword">enum</span> <a class="code" href="namespacefv.html#a16a191c4b8935d4c7c5aad79fc4ea97e">SaveOption</a>{</div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; PNG = 0,</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; PDF = 1,</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; ROOT = 2</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160;};</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="classfv_1_1GenContainer.html"> 77</a></span>&#160;<span class="keyword">class </span><a class="code" href="classfv_1_1GenContainer.html">GenContainer</a>{</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; std::string name;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160; std::string desc;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160; std::vector&lt;ObsFilter*&gt; filters;</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160; <span class="keyword">protected</span>:</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> _fill() = 0;</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; <a class="code" href="classfv_1_1GenContainer.html">GenContainer</a>(<span class="keyword">const</span> std::string name, <span class="keyword">const</span> std::string&amp; desc)</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; :name(name),desc(desc) { }</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; <a class="code" href="classfv_1_1GenContainer.html">GenContainer</a>(<span class="keyword">const</span> std::string name)</div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; :<a class="code" href="classfv_1_1GenContainer.html">GenContainer</a>(name,<span class="stringliteral">&quot;N/A&quot;</span>){ }</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160; <a class="code" href="classfv_1_1GenContainer.html">GenContainer</a>* add_filter(GenValue* filter){</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160; filters.push_back(dynamic_cast&lt;ObsFilter*&gt;(filter));</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160; <span class="keywordflow">return</span> <span class="keyword">this</span>;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160; }</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160;</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160; <span class="keywordtype">void</span> fill(){</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; <span class="keywordflow">for</span> (<span class="keyword">auto</span> filter : filters){</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; <span class="keywordflow">if</span> (!filter-&gt;get_value()) <span class="keywordflow">return</span>;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160; }</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160; _fill();</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160; }</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>&#160; <span class="keywordtype">void</span> set_description(<span class="keyword">const</span> std::string&amp; description){</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span>&#160; desc = description;</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>&#160; }</div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span>&#160; <span class="keyword">const</span> std::string&amp; get_name(){</div><div class="line"><a name="l00107"></a><span class="lineno"> 107</span>&#160; <span class="keywordflow">return</span> name;</div><div class="line"><a name="l00108"></a><span class="lineno"> 108</span>&#160; }</div><div class="line"><a name="l00109"></a><span class="lineno"> 109</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> save_as(<span class="keyword">const</span> std::string&amp; fname, <span class="keyword">const</span> <a class="code" href="namespacefv.html#a16a191c4b8935d4c7c5aad79fc4ea97e">SaveOption</a>&amp; option) = 0;</div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span>&#160; <span class="keyword">virtual</span> <span class="keywordtype">void</span> save(<span class="keyword">const</span> <a class="code" href="namespacefv.html#a16a191c4b8935d4c7c5aad79fc4ea97e">SaveOption</a>&amp; option=SaveOption::PNG) {</div><div class="line"><a name="l00111"></a><span class="lineno"> 111</span>&#160; save_as(get_name(), option);</div><div class="line"><a name="l00112"></a><span class="lineno"> 112</span>&#160; }</div><div class="line"><a name="l00113"></a><span class="lineno"> 113</span>&#160;};</div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>&#160;</div><div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> H&gt;</div><div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="classfv_1_1Container.html"> 123</a></span>&#160;<span class="keyword">class </span><a class="code" href="classfv_1_1Container.html">Container</a> : <span class="keyword">public</span> <a class="code" href="classfv_1_1GenContainer.html">GenContainer</a>{</div><div class="line"><a name="l00124"></a><span class="lineno"> 124</span>&#160; <span class="keyword">protected</span>:</div><div class="line"><a name="l00125"></a><span class="lineno"> 125</span>&#160; H* container;</div><div class="line"><a name="l00126"></a><span class="lineno"> 126</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00127"></a><span class="lineno"> 127</span>&#160; <a class="code" href="classfv_1_1Container.html">Container</a>(<span class="keyword">const</span> std::string&amp; name, H* container)</div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span>&#160; :<a class="code" href="classfv_1_1GenContainer.html">GenContainer</a>(name),</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span>&#160; container(container){ }</div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>&#160; <span class="keyword">virtual</span> H* get_container(){</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; <span class="keywordflow">return</span> container;</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; }</div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span>&#160;</div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span>&#160;};</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span>&#160;</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00145"></a><span class="lineno"><a class="line" href="classfv_1_1ContainerMean.html"> 145</a></span>&#160;<span class="keyword">class </span><a class="code" href="classfv_1_1ContainerMean.html">ContainerMean</a> : <span class="keyword">public</span> <a class="code" href="classfv_1_1Container.html">Container</a>&lt;T&gt;{</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <span class="keyword">private</span>:</div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <a class="code" href="classfv_1_1Value.html">Value&lt;T&gt;</a>* value;</div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; <span class="keywordtype">int</span> count;</div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160; T sum;</div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>&#160;</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span>&#160; <span class="keywordtype">void</span> _fill(){</div><div class="line"><a name="l00152"></a><span class="lineno"> 152</span>&#160; count++;</div><div class="line"><a name="l00153"></a><span class="lineno"> 153</span>&#160; sum += value-&gt;<a class="code" href="classfv_1_1Value.html#a4cc70444ceaf5d7651922adf9b7beeff">get_value</a>();</div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span>&#160; }</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span>&#160; <a class="code" href="classfv_1_1ContainerMean.html">ContainerMean</a>(<span class="keyword">const</span> std::string&amp; name, <a class="code" href="classfv_1_1Value.html">Value&lt;T&gt;</a>* value)</div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>&#160; :<a class="code" href="classfv_1_1Container.html">Container&lt;std::vector&lt;T&gt;</a> &gt;(name, <span class="keyword">nullptr</span>),</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; value(value){</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; this-&gt;container = <span class="keyword">new</span> T();</div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; }</div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160;</div><div class="line"><a name="l00162"></a><span class="lineno"> 162</span>&#160; T* get_container(){</div><div class="line"><a name="l00163"></a><span class="lineno"> 163</span>&#160; *(this-&gt;container) = sum/count;</div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>&#160; <span class="keywordflow">return</span> (this-&gt;container);</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span>&#160; }</div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>&#160; <span class="keywordtype">void</span> save_as(<span class="keyword">const</span> std::string&amp; fname) {</div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span>&#160; WARNING(<span class="stringliteral">&quot;Saving of ContainerMean objects not supported&quot;</span>);</div><div class="line"><a name="l00168"></a><span class="lineno"> 168</span>&#160; }</div><div class="line"><a name="l00169"></a><span class="lineno"> 169</span>&#160;};</div><div class="line"><a name="l00170"></a><span class="lineno"> 170</span>&#160;</div><div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160;}</div><div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;<span class="preprocessor">#endif // container_hpp</span></div><div class="ttc" id="namespacefv_1_1util_html"><div class="ttname"><a href="namespacefv_1_1util.html">fv::util</a></div><div class="ttdef"><b>Definition:</b> argparse.hpp:39</div></div>
  69. <div class="ttc" id="namespacefv_html_a16a191c4b8935d4c7c5aad79fc4ea97e"><div class="ttname"><a href="namespacefv.html#a16a191c4b8935d4c7c5aad79fc4ea97e">fv::SaveOption</a></div><div class="ttdeci">SaveOption</div><div class="ttdoc">Enumeration of different options that can be used to save Containers. </div><div class="ttdef"><b>Definition:</b> container.hpp:67</div></div>
  70. <div class="ttc" id="classfv_1_1ContainerMean_html"><div class="ttname"><a href="classfv_1_1ContainerMean.html">fv::ContainerMean</a></div><div class="ttdoc">Calculate the Mean of a Value over a series of observations. </div><div class="ttdef"><b>Definition:</b> container.hpp:145</div></div>
  71. <div class="ttc" id="namespacefv_html"><div class="ttname"><a href="namespacefv.html">fv</a></div><div class="ttdoc">The namespace containing all filval classes and functions. </div><div class="ttdef"><b>Definition:</b> api.hpp:6</div></div>
  72. <div class="ttc" id="classfv_1_1Value_html"><div class="ttname"><a href="classfv_1_1Value.html">fv::Value</a></div><div class="ttdoc">A generic value. </div><div class="ttdef"><b>Definition:</b> value.hpp:352</div></div>
  73. <div class="ttc" id="classfv_1_1GenContainer_html"><div class="ttname"><a href="classfv_1_1GenContainer.html">fv::GenContainer</a></div><div class="ttdoc">Generic, untyped parent class of Container. </div><div class="ttdef"><b>Definition:</b> container.hpp:77</div></div>
  74. <div class="ttc" id="classfv_1_1Value_html_a4cc70444ceaf5d7651922adf9b7beeff"><div class="ttname"><a href="classfv_1_1Value.html#a4cc70444ceaf5d7651922adf9b7beeff">fv::Value::get_value</a></div><div class="ttdeci">virtual T &amp; get_value()=0</div><div class="ttdoc">Calculate, if necessary, and return the value held by this object. </div></div>
  75. <div class="ttc" id="classfv_1_1Container_html"><div class="ttname"><a href="classfv_1_1Container.html">fv::Container</a></div><div class="ttdoc">A class that is used to &quot;hold&quot; values. </div><div class="ttdef"><b>Definition:</b> container.hpp:123</div></div>
  76. </div><!-- fragment --></div><!-- contents -->
  77. <!-- start footer part -->
  78. <hr class="footer"/><address class="footer"><small>
  79. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  80. <img class="footer" src="doxygen.png" alt="doxygen"/>
  81. </a> 1.8.13
  82. </small></address>
  83. </body>
  84. </html>