| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081 |
- <!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.13"/>
- <meta name="viewport" content="width=device-width, initial-scale=1"/>
- <title>TTTT Analysis: /home/caleb/Sources/TTTT/filval/examples/example1.cpp Source File</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="search/search.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="search/searchdata.js"></script>
- <script type="text/javascript" src="search/search.js"></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">TTTT Analysis
-  <span id="projectnumber">0.1</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.13 -->
- <script type="text/javascript">
- var searchBox = new SearchBox("searchBox", "search",false,'Search');
- </script>
- <script type="text/javascript" src="menudata.js"></script>
- <script type="text/javascript" src="menu.js"></script>
- <script type="text/javascript">
- $(function() {
- initMenu('',true,false,'search.php','Search');
- $(document).ready(function() { init_search(); });
- });
- </script>
- <div id="main-nav"></div>
- <!-- window showing the filter options -->
- <div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
- </div>
- <!-- iframe showing the search results (closed by default) -->
- <div id="MSearchResultsWindow">
- <iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
- </iframe>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="dir_b2e1228fdb7fe80fc606210a4045f658.html">filval</a></li><li class="navelem"><a class="el" href="dir_3ce6d6f73dcdcb3d85e4b28dfdf65651.html">examples</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="headertitle">
- <div class="title">example1.cpp</div> </div>
- </div><!--header-->
- <div class="contents">
- <a href="example1_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#include <iostream></span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include <utility></span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#include "filval/filval.hpp"</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> </div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keywordtype">int</span> main(<span class="keywordtype">int</span> argc, <span class="keyword">const</span> <span class="keywordtype">char</span>* argv[]){</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="comment">// Initialize logging. Let's not worry about what is being logged right now</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="comment">// and just redirect it to /dev/null so it doesn't appear on the screen.</span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  fv::util::Log::init_logger(<span class="stringliteral">"/dev/null"</span>, fv::util::LogPriority::kLogDebug);</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// declare a helper function to print out a std::pair object</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keyword">auto</span> print_pair = [](<a class="code" href="classfv_1_1Value.html">fv::Value<std::pair<double, double></a>>* dp){</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  std::pair<double, double> p = dp->get_value();</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  std::cout << <span class="stringliteral">"("</span> << p.first << <span class="stringliteral">", "</span> << p.second << <span class="stringliteral">")\n"</span>;</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  };</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="comment">// These variables are the "Values" that will be observed. Think of these</span></div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment">// as sources of data that will be updated as new observations are loaded.</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <span class="keywordtype">double</span> x = 12;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">double</span> y = 13;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="comment">// This is where the fun begins. Here we declare a couple ObservedValue</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="comment">// objects. these are basically just fancy wrappers around the x, and y</span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment">// variables declared above. They have the job of supplying the value</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="comment">// stored by x and y when requested.</span></div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <a class="code" href="classfv_1_1ObservedValue.html">fv::ObservedValue<double></a> x_val(<span class="stringliteral">"x"</span>, &x);</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <a class="code" href="classfv_1_1ObservedValue.html">fv::ObservedValue<double></a> y_val(<span class="stringliteral">"y"</span>, &y);</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// Now that we have a few source values, let's compose them together into a</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="comment">// pair. The fv api defines a function to do this: fv::pair. This function</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// takes pointers to two Value objects and creates a new value that is a</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <span class="comment">// std::pair of these objects.</span></div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <a class="code" href="classfv_1_1Value.html">fv::Value<std::pair<double, double></a>>* dp = fv::pair(&x_val, &y_val);</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="comment">// If we call the print_pair function that we declared earlier with the new</span></div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  <span class="comment">// value object, we can see that, indeed, we see the correct output</span></div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="comment">// (12, 13)</span></div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  print_pair(dp);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="comment">// Now let's update the values of x and y to both be 2. Normally this job</span></div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="comment">// will be handled by a DataSet object which manages these variables, but</span></div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="comment">// we can do it here for now.</span></div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  x = 2;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  y = 2;</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="comment">// Before we can access these new values through our value chain, we need</span></div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  <span class="comment">// to tell the values to "reset". One of the main features of FV is that</span></div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="comment">// each value is only calculated at most once per observation, regardless</span></div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="comment">// of how many times it is accessed. However, this means that we have to</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="comment">// tell the objects when a new object has been loaded so it will actually</span></div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  <span class="comment">// do a re-calculation. In the case of dp, this means that it will</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="comment">// re-access the values of x and y and create a new pair with the updated</span></div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  <span class="comment">// values.</span></div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  fv::GenValue::reset();</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  <span class="comment">// Call print_pair again just to verify that it gives the updated values,</span></div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="comment">// and indeed it does.</span></div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="comment">// (2, 2)</span></div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  print_pair(dp);</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordflow">return</span> 0;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> }</div><div class="ttc" id="classfv_1_1ObservedValue_html"><div class="ttname"><a href="classfv_1_1ObservedValue.html">fv::ObservedValue</a></div><div class="ttdoc">A value supplied by the dataset, not derived. </div><div class="ttdef"><b>Definition:</b> <a href="value_8hpp_source.html#l00450">value.hpp:450</a></div></div>
- <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 templated value. </div><div class="ttdef"><b>Definition:</b> <a href="value_8hpp_source.html#l00265">value.hpp:265</a></div></div>
- </div><!-- fragment --></div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.13
- </small></address>
- </body>
- </html>
|
