swh:1:snp:e6d42e6731ce66e3c09de07ac49964c03139e990
Raw File
Tip revision: 26b818c8be2be41dd673d938b403c5c7562635de authored by Travis CI on 28 November 2019, 13:55:12 UTC
Deploy code docs to GitHub Pages Travis build: 305
Tip revision: 26b818c
_ox_model_t2_two_param_8h_source.html
<!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.6"/>
<title>Tomato: lib/OxModelT2TwoParam.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="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
   <div id="projectname">Tomato
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
      <li><a href="globals.html"><span>File&#160;Members</span></a></li>
    </ul>
  </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('_ox_model_t2_two_param_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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Pages</a></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">OxModelT2TwoParam.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_ox_model_t2_two_param_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;</div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#ifndef Tomato_OXModelT2TwoParam_H</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#define Tomato_OXModelT2TwoParam_H</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="preprocessor">#include &quot;tomatolib_export.h&quot;</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="_ox_model_8h.html">OxModel.h</a>&quot;</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="preprocessor">#include &lt;cmath&gt;</span></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">namespace </span>Ox {</div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;</div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;    <span class="keyword">template</span>&lt; <span class="keyword">typename</span> MeasureType &gt;</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="class_ox_1_1_model_t2_two_param.html">   23</a></span>&#160;    <span class="keyword">class </span><a class="code" href="class_ox_1_1_model_t2_two_param.html">ModelT2TwoParam</a> : <span class="keyword">public</span> <a class="code" href="class_ox_1_1_model.html">Model</a>&lt;MeasureType&gt;{</div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;</div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;    <span class="keyword">public</span>:</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">virtual</span> MeasureType <a class="code" href="class_ox_1_1_model_t2_two_param.html#a1401dbd94a7a23903f22013af44c4648">calcModelValue</a>(<span class="keyword">const</span> MeasureType* parameters, MeasureType time);</div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_ox_1_1_model_t2_two_param.html#a7f4e4edc966189fb95f6fcbbd6417c5f">calcLSResiduals</a>(<span class="keyword">const</span> MeasureType* parameters, MeasureType* residuals);</div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_ox_1_1_model_t2_two_param.html#af056e278a340918eb57f23f63ba2f23c">calcLSJacobian</a>(<span class="keyword">const</span> MeasureType* parameters, MeasureType* jacobian);</div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;        <span class="keyword">virtual</span> MeasureType <a class="code" href="class_ox_1_1_model_t2_two_param.html#abd88af16b5860a18632453ca1ce858b4">calcCostValue</a>(<span class="keyword">const</span> MeasureType* parameters );</div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;        <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_ox_1_1_model_t2_two_param.html#a4957d8cf05666364c6c21483fd0f9fa9">calcCostDerivative</a>(<span class="keyword">const</span> MeasureType* parameters, MeasureType* derivative);</div>
<div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;        <a class="code" href="class_ox_1_1_model_t2_two_param.html">ModelT2TwoParam</a>() : <a class="code" href="class_ox_1_1_model.html">Model&lt;MeasureType&gt;</a>(){</div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;            this-&gt;_nDims = 2;</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;</div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="class_ox_1_1_model_t2_two_param.html#a64afe7ef809a611d93df0d8f695f1a22">   41</a></span>&#160;        <span class="keyword">virtual</span> <a class="code" href="class_ox_1_1_model.html">Model&lt;MeasureType&gt;</a> *<a class="code" href="class_ox_1_1_model_t2_two_param.html#a64afe7ef809a611d93df0d8f695f1a22">newByCloning</a>() { <span class="keywordflow">return</span> <span class="keyword">new</span> <a class="code" href="class_ox_1_1_model_t2_two_param.html">ModelT2TwoParam&lt;MeasureType&gt;</a>(*this); }</div>
<div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;</div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="class_ox_1_1_model_t2_two_param.html#aa6ff3c3c4b24a3479c8ed6f3490f12ed">   47</a></span>&#160;        <span class="keyword">virtual</span> <a class="code" href="class_ox_1_1_model_t2_two_param.html#aa6ff3c3c4b24a3479c8ed6f3490f12ed">~ModelT2TwoParam</a>(){};</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    };</div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;} <span class="comment">//namespace Ox</span></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;<span class="preprocessor">#ifndef TOMATOLIB_COMPILED</span></div>
<div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="_ox_model_t2_two_param_8hxx.html">OxModelT2TwoParam.hxx</a>&quot;</span></div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="preprocessor">#endif //TOMATOLIB_COMPILED</span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="preprocessor"></span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="preprocessor">#endif //Tomato_OXModelT2TwoParam_H</span></div>
<div class="ttc" id="class_ox_1_1_model_t2_two_param_html_aa6ff3c3c4b24a3479c8ed6f3490f12ed"><div class="ttname"><a href="class_ox_1_1_model_t2_two_param.html#aa6ff3c3c4b24a3479c8ed6f3490f12ed">Ox::ModelT2TwoParam::~ModelT2TwoParam</a></div><div class="ttdeci">virtual ~ModelT2TwoParam()</div><div class="ttdoc">do not forget about the virtual destructor, see https://stackoverflow.com/questions/461203/when-to-us...</div><div class="ttdef"><b>Definition:</b> OxModelT2TwoParam.h:47</div></div>
<div class="ttc" id="class_ox_1_1_model_html"><div class="ttname"><a href="class_ox_1_1_model.html">Ox::Model</a></div><div class="ttdoc">Container for a model function, cost function and Least-Squares function. And derivatives. </div><div class="ttdef"><b>Definition:</b> OxModel.h:25</div></div>
<div class="ttc" id="class_ox_1_1_model_t2_two_param_html_a64afe7ef809a611d93df0d8f695f1a22"><div class="ttname"><a href="class_ox_1_1_model_t2_two_param.html#a64afe7ef809a611d93df0d8f695f1a22">Ox::ModelT2TwoParam::newByCloning</a></div><div class="ttdeci">virtual Model&lt; MeasureType &gt; * newByCloning()</div><div class="ttdef"><b>Definition:</b> OxModelT2TwoParam.h:41</div></div>
<div class="ttc" id="class_ox_1_1_model_t2_two_param_html_a7f4e4edc966189fb95f6fcbbd6417c5f"><div class="ttname"><a href="class_ox_1_1_model_t2_two_param.html#a7f4e4edc966189fb95f6fcbbd6417c5f">Ox::ModelT2TwoParam::calcLSResiduals</a></div><div class="ttdeci">virtual void calcLSResiduals(const MeasureType *parameters, MeasureType *residuals)</div><div class="ttdef"><b>Definition:</b> OxModelT2TwoParam.hxx:29</div></div>
<div class="ttc" id="class_ox_1_1_model_t2_two_param_html_abd88af16b5860a18632453ca1ce858b4"><div class="ttname"><a href="class_ox_1_1_model_t2_two_param.html#abd88af16b5860a18632453ca1ce858b4">Ox::ModelT2TwoParam::calcCostValue</a></div><div class="ttdeci">virtual MeasureType calcCostValue(const MeasureType *parameters)</div><div class="ttdef"><b>Definition:</b> OxModelT2TwoParam.hxx:70</div></div>
<div class="ttc" id="class_ox_1_1_model_t2_two_param_html_a4957d8cf05666364c6c21483fd0f9fa9"><div class="ttname"><a href="class_ox_1_1_model_t2_two_param.html#a4957d8cf05666364c6c21483fd0f9fa9">Ox::ModelT2TwoParam::calcCostDerivative</a></div><div class="ttdeci">virtual void calcCostDerivative(const MeasureType *parameters, MeasureType *derivative)</div><div class="ttdef"><b>Definition:</b> OxModelT2TwoParam.hxx:87</div></div>
<div class="ttc" id="class_ox_1_1_model_t2_two_param_html_af056e278a340918eb57f23f63ba2f23c"><div class="ttname"><a href="class_ox_1_1_model_t2_two_param.html#af056e278a340918eb57f23f63ba2f23c">Ox::ModelT2TwoParam::calcLSJacobian</a></div><div class="ttdeci">virtual void calcLSJacobian(const MeasureType *parameters, MeasureType *jacobian)</div><div class="ttdef"><b>Definition:</b> OxModelT2TwoParam.hxx:47</div></div>
<div class="ttc" id="_ox_model_8h_html"><div class="ttname"><a href="_ox_model_8h.html">OxModel.h</a></div></div>
<div class="ttc" id="class_ox_1_1_model_t2_two_param_html_a1401dbd94a7a23903f22013af44c4648"><div class="ttname"><a href="class_ox_1_1_model_t2_two_param.html#a1401dbd94a7a23903f22013af44c4648">Ox::ModelT2TwoParam::calcModelValue</a></div><div class="ttdeci">virtual MeasureType calcModelValue(const MeasureType *parameters, MeasureType time)</div><div class="ttdef"><b>Definition:</b> OxModelT2TwoParam.hxx:16</div></div>
<div class="ttc" id="_ox_model_t2_two_param_8hxx_html"><div class="ttname"><a href="_ox_model_t2_two_param_8hxx.html">OxModelT2TwoParam.hxx</a></div></div>
<div class="ttc" id="class_ox_1_1_model_t2_two_param_html"><div class="ttname"><a href="class_ox_1_1_model_t2_two_param.html">Ox::ModelT2TwoParam</a></div><div class="ttdoc">Container for a TwoParam model function , cost function and Least-Squares function and derivatives...</div><div class="ttdef"><b>Definition:</b> OxModelT2TwoParam.h:23</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="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li><li class="navelem"><a class="el" href="_ox_model_t2_two_param_8h.html">OxModelT2TwoParam.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.6 </li>
  </ul>
</div>
</body>
</html>
back to top