<!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>DFNgen: expDist.h 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</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">DFNgen
   &#160;<span id="projectnumber">2.0</span>
   </div>
   <div id="projectbrief">DFN Model Generator</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('exp_dist_8h_source.html','');});
</script>
<div id="doc-content">
<!-- 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 class="header">
  <div class="headertitle">
<div class="title">expDist.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="exp_dist_8h.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;<span class="preprocessor">#ifndef _expDist_h_</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#define _expDist_h_</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor">#include &lt;random&gt;</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;</div><div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="class_exp_dist.html">   12</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_exp_dist.html">ExpDist</a> {</div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="keyword">private</span>:</div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="class_exp_dist.html#a2fe179a686cf5727771ac299586cd389">   19</a></span>&#160;    <span class="keywordtype">double</span> <a class="code" href="class_exp_dist.html#a2fe179a686cf5727771ac299586cd389">maxInput</a>;</div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;    <span class="keywordtype">double</span> <a class="code" href="class_exp_dist.html#a8fb900100a01f9b465afb8d4c0e27fcd">unifRandom</a>(<span class="keywordtype">double</span>, <span class="keywordtype">double</span>);</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00025"></a><span class="lineno"><a class="line" href="class_exp_dist.html#a93e52d93e369e35113451f8b13fee733">   25</a></span>&#160;    std::mt19937_64 &amp;<a class="code" href="class_exp_dist.html#a93e52d93e369e35113451f8b13fee733">generator</a>;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;</div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="keyword">public</span>:</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;    </div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;    <span class="comment">// Constructor. maxDecimal is the maximum number less than 1,</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;    <span class="comment">// using maximum digits in the double&#39;s mantissa, to use </span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;    <span class="comment">// when sampling the dist. This prevents .999999... being </span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;    <span class="comment">// turned into 1, causing a return of inf from the distribution</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;    <span class="comment">//ExpDist(double maxDecimal, std::mt19937_64 &amp;_generator);</span></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;    <a class="code" href="class_exp_dist.html#a6ff9f11c95c39bec106a702458019253">ExpDist</a>(<span class="keywordtype">double</span> maxDecimal,std::mt19937_64 &amp;_generator);</div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;    </div><div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;    <span class="comment">// Returns double using rv as &quot;random variable&quot;</span></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;    <span class="keywordtype">double</span> <a class="code" href="class_exp_dist.html#a6d4f5a28aa202431400586aa8c441fad">getValue</a>(<span class="keywordtype">double</span> lambda, <span class="keywordtype">double</span> rv);     </div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;    </div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    <span class="comment">// Generates its own random input to distribution</span></div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;    <span class="keywordtype">double</span> <a class="code" href="class_exp_dist.html#a6d4f5a28aa202431400586aa8c441fad">getValue</a>(<span class="keywordtype">double</span> lambda, <span class="keywordtype">double</span> minInput, <span class="keywordtype">double</span> maxInput);</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;        </div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;    <span class="comment">// Returns maximum value computer is able to produce</span></div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;    <span class="comment">// can be relatively small with certain parameters for lambda</span></div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;    <span class="comment">// due to precision issues. </span></div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;    <span class="keywordtype">double</span> <a class="code" href="class_exp_dist.html#a1172a8ef0d7ddf6338ae38f4dacb336d">getMaxValue</a>(<span class="keywordtype">double</span> lambda);</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;    <span class="comment">// Computes what the input value needs to be in </span></div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    <span class="comment">// order for the distribution to return &quot;output&quot; value</span></div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    <span class="keywordtype">double</span> <a class="code" href="class_exp_dist.html#a37c73098f6602d6ac114722dfe9f9a72">computeInput</a>(<span class="keywordtype">double</span> output, <span class="keywordtype">double</span> lambda);</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;};</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="preprocessor">#endif</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;</div><div class="ttc" id="class_exp_dist_html_a6d4f5a28aa202431400586aa8c441fad"><div class="ttname"><a href="class_exp_dist.html#a6d4f5a28aa202431400586aa8c441fad">ExpDist::getValue</a></div><div class="ttdeci">double getValue(double lambda, double rv)</div><div class="ttdef"><b>Definition:</b> <a href="exp_dist_8cpp_source.html#l00046">expDist.cpp:46</a></div></div>
<div class="ttc" id="class_exp_dist_html_a8fb900100a01f9b465afb8d4c0e27fcd"><div class="ttname"><a href="class_exp_dist.html#a8fb900100a01f9b465afb8d4c0e27fcd">ExpDist::unifRandom</a></div><div class="ttdeci">double unifRandom(double, double)</div><div class="ttdef"><b>Definition:</b> <a href="exp_dist_8cpp_source.html#l00033">expDist.cpp:33</a></div></div>
<div class="ttc" id="class_exp_dist_html_a1172a8ef0d7ddf6338ae38f4dacb336d"><div class="ttname"><a href="class_exp_dist.html#a1172a8ef0d7ddf6338ae38f4dacb336d">ExpDist::getMaxValue</a></div><div class="ttdeci">double getMaxValue(double lambda)</div><div class="ttdef"><b>Definition:</b> <a href="exp_dist_8cpp_source.html#l00115">expDist.cpp:115</a></div></div>
<div class="ttc" id="class_exp_dist_html_a2fe179a686cf5727771ac299586cd389"><div class="ttname"><a href="class_exp_dist.html#a2fe179a686cf5727771ac299586cd389">ExpDist::maxInput</a></div><div class="ttdeci">double maxInput</div><div class="ttdef"><b>Definition:</b> <a href="exp_dist_8h_source.html#l00019">expDist.h:19</a></div></div>
<div class="ttc" id="class_exp_dist_html_a37c73098f6602d6ac114722dfe9f9a72"><div class="ttname"><a href="class_exp_dist.html#a37c73098f6602d6ac114722dfe9f9a72">ExpDist::computeInput</a></div><div class="ttdeci">double computeInput(double output, double lambda)</div><div class="ttdef"><b>Definition:</b> <a href="exp_dist_8cpp_source.html#l00129">expDist.cpp:129</a></div></div>
<div class="ttc" id="class_exp_dist_html_a93e52d93e369e35113451f8b13fee733"><div class="ttname"><a href="class_exp_dist.html#a93e52d93e369e35113451f8b13fee733">ExpDist::generator</a></div><div class="ttdeci">std::mt19937_64 &amp; generator</div><div class="ttdef"><b>Definition:</b> <a href="exp_dist_8h_source.html#l00025">expDist.h:25</a></div></div>
<div class="ttc" id="class_exp_dist_html"><div class="ttname"><a href="class_exp_dist.html">ExpDist</a></div><div class="ttdef"><b>Definition:</b> <a href="exp_dist_8h_source.html#l00012">expDist.h:12</a></div></div>
<div class="ttc" id="class_exp_dist_html_a6ff9f11c95c39bec106a702458019253"><div class="ttname"><a href="class_exp_dist.html#a6ff9f11c95c39bec106a702458019253">ExpDist::ExpDist</a></div><div class="ttdeci">ExpDist(double maxDecimal, std::mt19937_64 &amp;_generator)</div><div class="ttdef"><b>Definition:</b> <a href="exp_dist_8cpp_source.html#l00021">expDist.cpp:21</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="exp_dist_8h.html">expDist.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.12 </li>
  </ul>
</div>
</body>
</html>
