<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>HippoDraw Class Library</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
<link rel="shortcut icon" href="hippoApp.ico">
</head><body>
<!-- Generated by Doxygen 1.6.2 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespacehippodraw.html">hippodraw</a>::<a class="el" href="classhippodraw_1_1ConstantF.html">ConstantF</a>
</div>
</div>
<div class="contents">
<h1>ConstantF Class Reference</h1><!-- doxytag: class="hippodraw::ConstantF" --><!-- doxytag: inherits="hippodraw::FunctionBase" -->
<p>A <a class="el" href="classhippodraw_1_1ConstantF.html" title="A ConstantF function can be used with a fitter.">ConstantF</a> function can be used with a fitter.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="ConstantF_8h_source.html">ConstantF.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ConstantF:</div>
<div class="dynsection">
<div class="center"><img src="classhippodraw_1_1ConstantF__inherit__graph.gif" border="0" usemap="#ConstantF_inherit__map" alt="Inheritance graph"/></div>
<map name="ConstantF_inherit__map" id="ConstantF_inherit__map">
<area shape="rect" id="node2" href="classhippodraw_1_1FunctionBase.html" title="A function that can be added to a DataRep and used in a fitter." alt="" coords="5,5,107,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ConstantF:</div>
<div class="dynsection">
<div class="center"><img src="classhippodraw_1_1ConstantF__coll__graph.gif" border="0" usemap="#ConstantF_coll__map" alt="Collaboration graph"/></div>
<map name="ConstantF_coll__map" id="ConstantF_coll__map">
<area shape="rect" id="node2" href="classhippodraw_1_1FunctionBase.html" title="A function that can be added to a DataRep and used in a fitter." alt="" coords="227,293,328,323"/><area shape="rect" id="node4" title="STL class." alt="" coords="335,101,388,131"/><area shape="rect" id="node6" title="STL class." alt="" coords="291,5,432,35"/><area shape="rect" id="node11" title="STL class." alt="" coords="128,101,219,131"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classhippodraw_1_1ConstantF-members.html">List of all members.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#aff0ce151e66257591a964e347d330b1a">addToComposite</a> (<a class="el" href="classhippodraw_1_1FunctionBase.html">FunctionBase</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Does nothing. <a href="#aff0ce151e66257591a964e347d330b1a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classhippodraw_1_1FunctionBase.html">FunctionBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1ConstantF.html#a5e4b003c4faa8b7729e762445c7578d8">clone</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Creates a new function object by copying an existing one. <a href="#a5e4b003c4faa8b7729e762445c7578d8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1ConstantF.html#aa5eb7d36a840cfd356183ea00f12f499">ConstantF</a> (double value)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The following constructor takes the values of the parameters as an argument. <a href="#aa5eb7d36a840cfd356183ea00f12f499"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1ConstantF.html#a7305be57ebbcd488d57b7c37c3ba39d3">ConstantF</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The default constructor. <a href="#a7305be57ebbcd488d57b7c37c3ba39d3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#a9ba94da7db769b98d02381d872dd9bbb">count</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns 0. <a href="#a9ba94da7db769b98d02381d872dd9bbb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#a859ce4162e4a8aa28e4599d6c247038d">dimensions</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of dimensions of the data coordinate. <a href="#a859ce4162e4a8aa28e4599d6c247038d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const std::vector<br class="typebreak"/>
< double > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#ab6d95a533aca7f862becee6eca151a68">getParameters</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the values of the parameters as a vector. <a href="#ab6d95a533aca7f862becee6eca151a68"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#a014f51d18e05dbf02fc11ea7245a03f8">hasDerivatives</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if function can calculate its partial derivatives. <a href="#a014f51d18e05dbf02fc11ea7245a03f8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1ConstantF.html#ac89ece7f0010b352e8d897f0a352f811">initialParameters</a> (const <a class="el" href="classhippodraw_1_1FunctionHelper.html">FunctionHelper</a> *helper)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the <a class="el" href="classhippodraw_1_1FunctionHelper.html" title="An abstract base class to help FunctionBase objects perform some operations.">FunctionHelper</a> so that the function can calculate a reasonable set of initial parameter values. <a href="#ac89ece7f0010b352e8d897f0a352f811"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#abb154a0d5f8e4bb6725fb273a17ea766">integrate</a> (double lower_limit, double upper_limit) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the integral of the function from the lower limit to the higher limit. <a href="#abb154a0d5f8e4bb6725fb273a17ea766"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#af5ca0e3b3f772eb5785976bf9f8975c9">isComposite</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>false</code>. <a href="#af5ca0e3b3f772eb5785976bf9f8975c9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::string & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#a11c23a386abb9eb8a42f0c2c2835d640">name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the name of the function. <a href="#a11c23a386abb9eb8a42f0c2c2835d640"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#a4de2838a89d7e8f10d0242401f5a7e33">operator()</a> (const std::vector< double > &v) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The function call operator for multi-dimension coordinate variable. <a href="#a4de2838a89d7e8f10d0242401f5a7e33"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1ConstantF.html#a3a71b677f013fdbc07bdf5dd65ee5f27">operator()</a> (double x) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The function call operator. <a href="#a3a71b677f013fdbc07bdf5dd65ee5f27"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual const std::vector<br class="typebreak"/>
< std::string > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#a5cd61d6494588c53f64ea1b4497a58e8">parmNames</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a reference to a vector of parameter names. <a href="#a5cd61d6494588c53f64ea1b4497a58e8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#a6b7a91fdf914a37fc34b8996e862528d">removeFromComposite</a> (<a class="el" href="classhippodraw_1_1FunctionBase.html">FunctionBase</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Does nothing. <a href="#a6b7a91fdf914a37fc34b8996e862528d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual std::vector< double ><br class="typebreak"/>
::const_iterator </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#a893adb244f76732ad5c1c46066ae1463">setParameters</a> (std::vector< double >::const_iterator it)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the parameter values to the value pointed to by the iterator. <a href="#a893adb244f76732ad5c1c46066ae1463"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#aec721242269c5b893d79e271e85c3f79">setParameters</a> (const std::vector< double > &incr)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the parameter values. <a href="#aec721242269c5b893d79e271e85c3f79"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#aeb533a9c185a44ea914278078359866f">setParmNames</a> (const std::vector< std::string > &names)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the names of the parameters. <a href="#aeb533a9c185a44ea914278078359866f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#ab8e4e3e2a7bf18888b71bdf9dda0770b">size</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of parameters. <a href="#ab8e4e3e2a7bf18888b71bdf9dda0770b"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1ConstantF.html#a8617a1aa7536e4cb61f2a4ec29a39f36">derivByParm</a> (int i, double x) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the function's derivative at the coordinate value <code>x</code> with respect to the <code>i-th</code> parameter. <a href="#a8617a1aa7536e4cb61f2a4ec29a39f36"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1ConstantF.html#a25a40b6614565f755233080a384c35f1">initialize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initializes the function and parameters names. <a href="#a25a40b6614565f755233080a384c35f1"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#a0fc3d585aa53859602ac79c9c421f2a9">resize</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Re-sizes the appropriate vectors maintained in this base class. <a href="#a0fc3d585aa53859602ac79c9c421f2a9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#ad79b3edf375d6aa09288510a4e024a64">setName</a> (const char *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the name of the function. <a href="#ad79b3edf375d6aa09288510a4e024a64"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#adb41893ba19e889e56c559f25fc1a68a">m_name</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The name of the function. <a href="#adb41893ba19e889e56c559f25fc1a68a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::vector< std::string > </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#a96bf64e362e48f2ad4ecd76c32e4bc54">m_parm_names</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The names of the function parameters. <a href="#a96bf64e362e48f2ad4ecd76c32e4bc54"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::vector< double > </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1FunctionBase.html#aa892dcf9755ccd651b666f353b723c34">m_parms</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The parameter values. <a href="#aa892dcf9755ccd651b666f353b723c34"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A <a class="el" href="classhippodraw_1_1ConstantF.html" title="A ConstantF function can be used with a fitter.">ConstantF</a> function can be used with a fitter. </p>
<p>The function is a constant, i.e., computes <img class="formulaInl" alt="$ f(x) = p_0 $" src="form_6.png"/>.</p>
<p>This function has `F' in its name, unlike the others, because it fixed some strange problem in trying to call its <a class="el" href="classhippodraw_1_1ConstantF.html#a5e4b003c4faa8b7729e762445c7578d8" title="Creates a new function object by copying an existing one.">clone()</a> member function from the <a class="el" href="classhippodraw_1_1FunctionFactory.html" title="A Factory singleton class for creating objects whose class derives from FunctionBase...">FunctionFactory</a>.</p>
<dl class="author"><dt><b>Author:</b></dt><dd>Paul F. Kunz <<a href="mailto:Paul_Kunz@slac.stanford.edu">Paul_Kunz@slac.stanford.edu</a>> </dd></dl>
<p>Definition at line <a class="el" href="ConstantF_8h_source.html#l00029">29</a> of file <a class="el" href="ConstantF_8h_source.html">ConstantF.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7305be57ebbcd488d57b7c37c3ba39d3"></a><!-- doxytag: member="hippodraw::ConstantF::ConstantF" ref="a7305be57ebbcd488d57b7c37c3ba39d3" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhippodraw_1_1ConstantF.html">ConstantF</a> </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The default constructor. </p>
<p>Definition at line <a class="el" href="ConstantF_8cxx_source.html#l00030">30</a> of file <a class="el" href="ConstantF_8cxx_source.html">ConstantF.cxx</a>.</p>
<p>References <a class="el" href="ConstantF_8cxx_source.html#l00042">ConstantF::initialize()</a>.</p>
<p>Referenced by <a class="el" href="ConstantF_8cxx_source.html#l00050">ConstantF::clone()</a>.</p>
</div>
</div>
<a class="anchor" id="aa5eb7d36a840cfd356183ea00f12f499"></a><!-- doxytag: member="hippodraw::ConstantF::ConstantF" ref="aa5eb7d36a840cfd356183ea00f12f499" args="(double value)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhippodraw_1_1ConstantF.html">ConstantF</a> </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>value</em></td>
<td> ) </td>
<td><code> [explicit]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The following constructor takes the values of the parameters as an argument. </p>
<p>Definition at line <a class="el" href="ConstantF_8cxx_source.html#l00035">35</a> of file <a class="el" href="ConstantF_8cxx_source.html">ConstantF.cxx</a>.</p>
<p>References <a class="el" href="ConstantF_8cxx_source.html#l00042">ConstantF::initialize()</a>, and <a class="el" href="FunctionBase_8h_source.html#l00109">FunctionBase::m_parms</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aff0ce151e66257591a964e347d330b1a"></a><!-- doxytag: member="hippodraw::ConstantF::addToComposite" ref="aff0ce151e66257591a964e347d330b1a" args="(FunctionBase *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void addToComposite </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classhippodraw_1_1FunctionBase.html">FunctionBase</a> * </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Does nothing. </p>
<p>Derived classes that are a composite of functions should override this member function and add functions to the composite. </p>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1LinearSumFunction.html#aff0ce151e66257591a964e347d330b1a">LinearSumFunction</a>.</p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00166">166</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
</div>
</div>
<a class="anchor" id="a5e4b003c4faa8b7729e762445c7578d8"></a><!-- doxytag: member="hippodraw::ConstantF::clone" ref="a5e4b003c4faa8b7729e762445c7578d8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhippodraw_1_1FunctionBase.html">FunctionBase</a> * clone </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Creates a new function object by copying an existing one. </p>
<p>The implementation raises an assertion as this member function should be reimplemented in s derived class.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>There's an implementation here to satisfy the SIP interface. </dd></dl>
<p>Reimplemented from <a class="el" href="classhippodraw_1_1FunctionBase.html#a5e4b003c4faa8b7729e762445c7578d8">FunctionBase</a>.</p>
<p>Definition at line <a class="el" href="ConstantF_8cxx_source.html#l00050">50</a> of file <a class="el" href="ConstantF_8cxx_source.html">ConstantF.cxx</a>.</p>
<p>References <a class="el" href="ConstantF_8cxx_source.html#l00030">ConstantF::ConstantF()</a>.</p>
</div>
</div>
<a class="anchor" id="a9ba94da7db769b98d02381d872dd9bbb"></a><!-- doxytag: member="hippodraw::ConstantF::count" ref="a9ba94da7db769b98d02381d872dd9bbb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int count </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns 0. </p>
<p>Derived classes that are a composite of functions should override this member function to return the number of functions in the composite. </p>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1LinearSumFunction.html#a9ba94da7db769b98d02381d872dd9bbb">LinearSumFunction</a>.</p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00174">174</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
</div>
</div>
<a class="anchor" id="a8617a1aa7536e4cb61f2a4ec29a39f36"></a><!-- doxytag: member="hippodraw::ConstantF::derivByParm" ref="a8617a1aa7536e4cb61f2a4ec29a39f36" args="(int i, double x) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double derivByParm </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>i</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>x</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the function's derivative at the coordinate value <code>x</code> with respect to the <code>i-th</code> parameter. </p>
<p>Derived classes must implement this function.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000045">Todo:</a></b></dt><dd>Provide a numeric method for doing this calculation that will be the default. Derived classes should provide more efficient analytic method if available.</dd></dl>
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000030">Bug:</a></b></dt><dd>Make this function pure when problem compiling python/FunctionWrap under Windows is solved. </dd></dl>
<p>Reimplemented from <a class="el" href="classhippodraw_1_1FunctionBase.html#a8617a1aa7536e4cb61f2a4ec29a39f36">FunctionBase</a>.</p>
<p>Definition at line <a class="el" href="ConstantF_8cxx_source.html#l00067">67</a> of file <a class="el" href="ConstantF_8cxx_source.html">ConstantF.cxx</a>.</p>
</div>
</div>
<a class="anchor" id="a859ce4162e4a8aa28e4599d6c247038d"></a><!-- doxytag: member="hippodraw::ConstantF::dimensions" ref="a859ce4162e4a8aa28e4599d6c247038d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int dimensions </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of dimensions of the data coordinate. </p>
<p>This implementation in the base class returns <code>1</code>. Derived class should override this function if the data coordinate is multi-dimensional. </p>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1FunctionWrap.html#a859ce4162e4a8aa28e4599d6c247038d">FunctionWrap</a>.</p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00213">213</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
</div>
</div>
<a class="anchor" id="ab6d95a533aca7f862becee6eca151a68"></a><!-- doxytag: member="hippodraw::ConstantF::getParameters" ref="ab6d95a533aca7f862becee6eca151a68" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const vector< double > & getParameters </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the values of the parameters as a vector. </p>
<p>The function is non-const because a derived class may need to create the vector. </p>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1LinearSumFunction.html#ab6d95a533aca7f862becee6eca151a68">LinearSumFunction</a>.</p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00099">99</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
<p>References <a class="el" href="FunctionBase_8h_source.html#l00109">FunctionBase::m_parms</a>.</p>
<p>Referenced by <a class="el" href="FunctionProjectorXML_8cxx_source.html#l00039">FunctionProjectorXML::createElement()</a>, <a class="el" href="FuncParmRep_8cxx_source.html#l00041">FuncParmRep::drawProjectedValues()</a>, <a class="el" href="FunctionWrap_8cxx_source.html#l00034">hippodraw::Python::export_FunctionBase()</a>, <a class="el" href="FunctionRep_8cxx_source.html#l00278">FunctionRep::parameters()</a>, <a class="el" href="FunctionProjector_8cxx_source.html#l00080">FunctionProjector::saveParameters()</a>, and <a class="el" href="FunctionProjector_8cxx_source.html#l00297">FunctionProjector::setParameters()</a>.</p>
</div>
</div>
<a class="anchor" id="a014f51d18e05dbf02fc11ea7245a03f8"></a><!-- doxytag: member="hippodraw::ConstantF::hasDerivatives" ref="a014f51d18e05dbf02fc11ea7245a03f8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hasDerivatives </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns <code>true</code> if function can calculate its partial derivatives. </p>
<p>This base class implementation returns <code>true</code>. Derived class that can not calculate its partial derivatives should return <code>false</code>. This allows an application to not attempt to use a minimizer that requires derivatives to use this function. </p>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1LogNormal.html#a014f51d18e05dbf02fc11ea7245a03f8">LogNormal</a>, <a class="el" href="classhippodraw_1_1LogParabola.html#a014f51d18e05dbf02fc11ea7245a03f8">LogParabola</a>, <a class="el" href="classhippodraw_1_1Novosibirsk.html#a014f51d18e05dbf02fc11ea7245a03f8">Novosibirsk</a>, and <a class="el" href="classhippodraw_1_1FunctionWrap.html#a014f51d18e05dbf02fc11ea7245a03f8">FunctionWrap</a>.</p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00126">126</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
</div>
</div>
<a class="anchor" id="a25a40b6614565f755233080a384c35f1"></a><!-- doxytag: member="hippodraw::ConstantF::initialize" ref="a25a40b6614565f755233080a384c35f1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void initialize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initializes the function and parameters names. </p>
<p>Reimplemented from <a class="el" href="classhippodraw_1_1FunctionBase.html#a25a40b6614565f755233080a384c35f1">FunctionBase</a>.</p>
<p>Definition at line <a class="el" href="ConstantF_8cxx_source.html#l00042">42</a> of file <a class="el" href="ConstantF_8cxx_source.html">ConstantF.cxx</a>.</p>
<p>References <a class="el" href="FunctionBase_8h_source.html#l00103">FunctionBase::m_name</a>, <a class="el" href="FunctionBase_8h_source.html#l00106">FunctionBase::m_parm_names</a>, and <a class="el" href="FunctionBase_8cxx_source.html#l00071">FunctionBase::resize()</a>.</p>
<p>Referenced by <a class="el" href="ConstantF_8cxx_source.html#l00030">ConstantF::ConstantF()</a>.</p>
</div>
</div>
<a class="anchor" id="ac89ece7f0010b352e8d897f0a352f811"></a><!-- doxytag: member="hippodraw::ConstantF::initialParameters" ref="ac89ece7f0010b352e8d897f0a352f811" args="(const FunctionHelper *helper)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void initialParameters </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhippodraw_1_1FunctionHelper.html">FunctionHelper</a> * </td>
<td class="paramname"> <em>helper</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the <a class="el" href="classhippodraw_1_1FunctionHelper.html" title="An abstract base class to help FunctionBase objects perform some operations.">FunctionHelper</a> so that the function can calculate a reasonable set of initial parameter values. </p>
<p>Reimplemented from <a class="el" href="classhippodraw_1_1FunctionBase.html#ac89ece7f0010b352e8d897f0a352f811">FunctionBase</a>.</p>
<p>Definition at line <a class="el" href="ConstantF_8cxx_source.html#l00062">62</a> of file <a class="el" href="ConstantF_8cxx_source.html">ConstantF.cxx</a>.</p>
<p>References <a class="el" href="FunctionBase_8h_source.html#l00109">FunctionBase::m_parms</a>, and <a class="el" href="classhippodraw_1_1FunctionHelper.html#af3bc9c8d22d761fd78325b96330fd18a">FunctionHelper::meanValue()</a>.</p>
</div>
</div>
<a class="anchor" id="abb154a0d5f8e4bb6725fb273a17ea766"></a><!-- doxytag: member="hippodraw::ConstantF::integrate" ref="abb154a0d5f8e4bb6725fb273a17ea766" args="(double lower_limit, double upper_limit) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double integrate </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>a</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"> <em>b</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td> const<code> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the integral of the function from the lower limit to the higher limit. </p>
<p>As of now all the integration is done here numerically using the trapezoidal rule. Derived class may implement an analytical expression in place of this numerical method.</p>
<dl class="requests"><dt><b><a class="el" href="requests.html#_requests000018">Requests:</a></b></dt><dd>Override this method in derived classes when calculation of integral can be done analyically.</dd></dl>
<dl class="requests"><dt><b><a class="el" href="requests.html#_requests000019">Requests:</a></b></dt><dd>Check if this is the best algorithm. Its looks different from the one found in <a href="http://osl.iu.edu/%7Etveldhui/papers/techniques/">http://osl.iu.edu/%7Etveldhui/papers/techniques/</a> </dd></dl>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00138">138</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
<p>References <a class="el" href="FunctionBase_8cxx_source.html#l00205">FunctionBase::operator()()</a>.</p>
</div>
</div>
<a class="anchor" id="af5ca0e3b3f772eb5785976bf9f8975c9"></a><!-- doxytag: member="hippodraw::ConstantF::isComposite" ref="af5ca0e3b3f772eb5785976bf9f8975c9" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isComposite </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns <code>false</code>. </p>
<p>Derived classes that are a composite of functions should override this member function and return <code>true</code>. </p>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1LinearSumFunction.html#af5ca0e3b3f772eb5785976bf9f8975c9">LinearSumFunction</a>.</p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00161">161</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
<p>Referenced by <a class="el" href="FunctionRep_8cxx_source.html#l00118">FunctionRep::isComposite()</a>, <a class="el" href="FunctionController_8cxx_source.html#l00606">FunctionController::restoreParameters()</a>, and <a class="el" href="FunctionController_8cxx_source.html#l00593">FunctionController::saveParameters()</a>.</p>
</div>
</div>
<a class="anchor" id="a11c23a386abb9eb8a42f0c2c2835d640"></a><!-- doxytag: member="hippodraw::ConstantF::name" ref="a11c23a386abb9eb8a42f0c2c2835d640" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const string & name </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the name of the function. </p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00081">81</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
<p>References <a class="el" href="FunctionBase_8h_source.html#l00103">FunctionBase::m_name</a>.</p>
<p>Referenced by <a class="el" href="FunctionProjectorXML_8cxx_source.html#l00039">FunctionProjectorXML::createElement()</a>, <a class="el" href="FunctionController_8cxx_source.html#l00797">FunctionController::createNTuple()</a>, <a class="el" href="FunctionWrap_8cxx_source.html#l00034">hippodraw::Python::export_FunctionBase()</a>, <a class="el" href="FunctionController_8cxx_source.html#l00427">FunctionController::functionNames()</a>, <a class="el" href="FunctionProjector_8cxx_source.html#l00147">FunctionProjector::getTitle()</a>, <a class="el" href="FunctionProjector_8cxx_source.html#l00164">FunctionProjector::getYLabel()</a>, and <a class="el" href="LinearSumFunction_8cxx_source.html#l00060">LinearSumFunction::parmNames()</a>.</p>
</div>
</div>
<a class="anchor" id="a4de2838a89d7e8f10d0242401f5a7e33"></a><!-- doxytag: member="hippodraw::ConstantF::operator()" ref="a4de2838a89d7e8f10d0242401f5a7e33" args="(const std::vector< double > &v) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double operator() </td>
<td>(</td>
<td class="paramtype">const std::vector< double > & </td>
<td class="paramname"> <em>v</em></td>
<td> ) </td>
<td> const<code> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The function call operator for multi-dimension coordinate variable. </p>
<p>Returns the value of the function at coordinate represented by <em>v</em>. The implementation in this base class uses the first element of the vector and calls operator () ( double ). </p>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1FunctionWrap.html#a6d8d1c0bd26034ce989c063e748fe43e">FunctionWrap</a>.</p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00181">181</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
<p>References <a class="el" href="FunctionBase_8cxx_source.html#l00205">FunctionBase::operator()()</a>.</p>
</div>
</div>
<a class="anchor" id="a3a71b677f013fdbc07bdf5dd65ee5f27"></a><!-- doxytag: member="hippodraw::ConstantF::operator()" ref="a3a71b677f013fdbc07bdf5dd65ee5f27" args="(double x) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">double operator() </td>
<td>(</td>
<td class="paramtype">double </td>
<td class="paramname"> <em>x</em></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The function call operator. </p>
<p>Reimplemented from <a class="el" href="classhippodraw_1_1FunctionBase.html#a3a71b677f013fdbc07bdf5dd65ee5f27">FunctionBase</a>.</p>
<p>Definition at line <a class="el" href="ConstantF_8cxx_source.html#l00055">55</a> of file <a class="el" href="ConstantF_8cxx_source.html">ConstantF.cxx</a>.</p>
<p>References <a class="el" href="FunctionBase_8h_source.html#l00109">FunctionBase::m_parms</a>.</p>
</div>
</div>
<a class="anchor" id="a5cd61d6494588c53f64ea1b4497a58e8"></a><!-- doxytag: member="hippodraw::ConstantF::parmNames" ref="a5cd61d6494588c53f64ea1b4497a58e8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const vector< string > & parmNames </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns a reference to a vector of parameter names. </p>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1LinearSumFunction.html#a5cd61d6494588c53f64ea1b4497a58e8">LinearSumFunction</a>.</p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00086">86</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
<p>References <a class="el" href="FunctionBase_8h_source.html#l00106">FunctionBase::m_parm_names</a>.</p>
<p>Referenced by <a class="el" href="FuncParmRep_8cxx_source.html#l00041">FuncParmRep::drawProjectedValues()</a>, <a class="el" href="FunctionWrap_8cxx_source.html#l00034">hippodraw::Python::export_FunctionBase()</a>, and <a class="el" href="FunctionRep_8cxx_source.html#l00271">FunctionRep::parmNames()</a>.</p>
</div>
</div>
<a class="anchor" id="a6b7a91fdf914a37fc34b8996e862528d"></a><!-- doxytag: member="hippodraw::ConstantF::removeFromComposite" ref="a6b7a91fdf914a37fc34b8996e862528d" args="(FunctionBase *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void removeFromComposite </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classhippodraw_1_1FunctionBase.html">FunctionBase</a> * </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Does nothing. </p>
<p>Derived classes that are a composite of functions should override this member function and remove functions from the composite. </p>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1LinearSumFunction.html#a6b7a91fdf914a37fc34b8996e862528d">LinearSumFunction</a>.</p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00170">170</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
</div>
</div>
<a class="anchor" id="a0fc3d585aa53859602ac79c9c421f2a9"></a><!-- doxytag: member="hippodraw::ConstantF::resize" ref="a0fc3d585aa53859602ac79c9c421f2a9" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void resize </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected, virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Re-sizes the appropriate vectors maintained in this base class. </p>
<p>Derived classes should call this member function <b>after</b> initializing the m_parm_names data member, as the new size is taken from that data member's size. </p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00071">71</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
<p>References <a class="el" href="FunctionBase_8h_source.html#l00106">FunctionBase::m_parm_names</a>, <a class="el" href="FunctionBase_8h_source.html#l00109">FunctionBase::m_parms</a>, and <a class="el" href="FunctionBase_8cxx_source.html#l00156">FunctionBase::size()</a>.</p>
<p>Referenced by <a class="el" href="Quadratic2_8cxx_source.html#l00045">Quadratic2::initialize()</a>, <a class="el" href="Quadratic_8cxx_source.html#l00044">Quadratic::initialize()</a>, <a class="el" href="PowerLaw_8cxx_source.html#l00045">PowerLaw::initialize()</a>, <a class="el" href="Novosibirsk_8cxx_source.html#l00050">Novosibirsk::initialize()</a>, <a class="el" href="LogParabola_8cxx_source.html#l00051">LogParabola::initialize()</a>, <a class="el" href="LogNormal_8cxx_source.html#l00050">LogNormal::initialize()</a>, <a class="el" href="Linear_8cxx_source.html#l00043">Linear::initialize()</a>, <a class="el" href="Landau_8cxx_source.html#l00048">Landau::initialize()</a>, <a class="el" href="Gaussian_8cxx_source.html#l00054">Gaussian::initialize()</a>, <a class="el" href="FunctionWrap_8cxx_source.html#l00283">FunctionWrap::initialize()</a>, <a class="el" href="Exponential_8cxx_source.html#l00045">Exponential::initialize()</a>, <a class="el" href="Erfc_8cxx_source.html#l00047">Erfc::initialize()</a>, <a class="el" href="ConstantF_8cxx_source.html#l00042">ConstantF::initialize()</a>, <a class="el" href="Chi2Dist_8cxx_source.html#l00046">Chi2Dist::initialize()</a>, <a class="el" href="BrokenPowerLaw_8cxx_source.html#l00048">BrokenPowerLaw::initialize()</a>, <a class="el" href="FunctionWrap_8cxx_source.html#l00243">FunctionWrap::setParmNames()</a>, and <a class="el" href="FunctionBase_8cxx_source.html#l00093">FunctionBase::setParmNames()</a>.</p>
</div>
</div>
<a class="anchor" id="ad79b3edf375d6aa09288510a4e024a64"></a><!-- doxytag: member="hippodraw::ConstantF::setName" ref="ad79b3edf375d6aa09288510a4e024a64" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setName </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [protected, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the name of the function. </p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00066">66</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
<p>References <a class="el" href="FunctionBase_8h_source.html#l00103">FunctionBase::m_name</a>.</p>
</div>
</div>
<a class="anchor" id="a893adb244f76732ad5c1c46066ae1463"></a><!-- doxytag: member="hippodraw::ConstantF::setParameters" ref="a893adb244f76732ad5c1c46066ae1463" args="(std::vector< double >::const_iterator it)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">vector< double >::const_iterator setParameters </td>
<td>(</td>
<td class="paramtype">std::vector< double >::const_iterator </td>
<td class="paramname"> <em>it</em></td>
<td> ) </td>
<td><code> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the parameter values to the value pointed to by the iterator. </p>
<p>Returns an iterator to a data element one past the last used data element. </p>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1LinearSumFunction.html#a893adb244f76732ad5c1c46066ae1463">LinearSumFunction</a>.</p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00114">114</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
<p>References <a class="el" href="FunctionBase_8h_source.html#l00109">FunctionBase::m_parms</a>, and <a class="el" href="FunctionBase_8cxx_source.html#l00156">FunctionBase::size()</a>.</p>
</div>
</div>
<a class="anchor" id="aec721242269c5b893d79e271e85c3f79"></a><!-- doxytag: member="hippodraw::ConstantF::setParameters" ref="aec721242269c5b893d79e271e85c3f79" args="(const std::vector< double > &incr)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setParameters </td>
<td>(</td>
<td class="paramtype">const std::vector< double > & </td>
<td class="paramname"> <em>incr</em></td>
<td> ) </td>
<td><code> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the parameter values. </p>
<p>Derived classes should implement this function by invoking incrementValues ( vector< double >::const_iterator ) so that they correctly work with the <a class="el" href="classhippodraw_1_1LinearSumFunction.html" title="A function that can be used with a fitter.">LinearSumFunction</a> class. </p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00106">106</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
<p>Referenced by <a class="el" href="FunctionWrap_8cxx_source.html#l00034">hippodraw::Python::export_FunctionBase()</a>, <a class="el" href="FunctionProjector_8cxx_source.html#l00088">FunctionProjector::restoreParameters()</a>, <a class="el" href="FunctionProjectorXML_8cxx_source.html#l00074">FunctionProjectorXML::setAttributes()</a>, and <a class="el" href="FunctionProjector_8cxx_source.html#l00297">FunctionProjector::setParameters()</a>.</p>
</div>
</div>
<a class="anchor" id="aeb533a9c185a44ea914278078359866f"></a><!-- doxytag: member="hippodraw::ConstantF::setParmNames" ref="aeb533a9c185a44ea914278078359866f" args="(const std::vector< std::string > &names)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setParmNames </td>
<td>(</td>
<td class="paramtype">const std::vector< std::string > & </td>
<td class="paramname"> <em>names</em></td>
<td> ) </td>
<td><code> [inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the names of the parameters. </p>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1FunctionWrap.html#aeb533a9c185a44ea914278078359866f">FunctionWrap</a>.</p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00093">93</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
<p>References <a class="el" href="FunctionBase_8h_source.html#l00106">FunctionBase::m_parm_names</a>, and <a class="el" href="FunctionBase_8cxx_source.html#l00071">FunctionBase::resize()</a>.</p>
</div>
</div>
<a class="anchor" id="ab8e4e3e2a7bf18888b71bdf9dda0770b"></a><!-- doxytag: member="hippodraw::ConstantF::size" ref="ab8e4e3e2a7bf18888b71bdf9dda0770b" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int size </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [virtual, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of parameters. </p>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1LinearSumFunction.html#ab8e4e3e2a7bf18888b71bdf9dda0770b">LinearSumFunction</a>.</p>
<p>Definition at line <a class="el" href="FunctionBase_8cxx_source.html#l00156">156</a> of file <a class="el" href="FunctionBase_8cxx_source.html">FunctionBase.cxx</a>.</p>
<p>References <a class="el" href="FunctionBase_8h_source.html#l00106">FunctionBase::m_parm_names</a>.</p>
<p>Referenced by <a class="el" href="Novosibirsk_8cxx_source.html#l00098">Novosibirsk::initialParameters()</a>, <a class="el" href="LogParabola_8cxx_source.html#l00074">LogParabola::initialParameters()</a>, <a class="el" href="Gaussian_8cxx_source.html#l00089">Gaussian::initialParameters()</a>, <a class="el" href="FunctionWrap_8cxx_source.html#l00329">FunctionWrap::operator()()</a>, <a class="el" href="FunctionBase_8cxx_source.html#l00071">FunctionBase::resize()</a>, <a class="el" href="FunctionProjectorXML_8cxx_source.html#l00074">FunctionProjectorXML::setAttributes()</a>, and <a class="el" href="FunctionBase_8cxx_source.html#l00114">FunctionBase::setParameters()</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="adb41893ba19e889e56c559f25fc1a68a"></a><!-- doxytag: member="hippodraw::ConstantF::m_name" ref="adb41893ba19e889e56c559f25fc1a68a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string <a class="el" href="classhippodraw_1_1FunctionBase.html#adb41893ba19e889e56c559f25fc1a68a">m_name</a><code> [protected, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The name of the function. </p>
<p>Definition at line <a class="el" href="FunctionBase_8h_source.html#l00103">103</a> of file <a class="el" href="FunctionBase_8h_source.html">FunctionBase.h</a>.</p>
<p>Referenced by <a class="el" href="FunctionBase_8cxx_source.html#l00030">FunctionBase::FunctionBase()</a>, <a class="el" href="Quadratic2_8cxx_source.html#l00045">Quadratic2::initialize()</a>, <a class="el" href="Quadratic_8cxx_source.html#l00044">Quadratic::initialize()</a>, <a class="el" href="PowerLaw_8cxx_source.html#l00045">PowerLaw::initialize()</a>, <a class="el" href="Novosibirsk_8cxx_source.html#l00050">Novosibirsk::initialize()</a>, <a class="el" href="LogParabola_8cxx_source.html#l00051">LogParabola::initialize()</a>, <a class="el" href="LogNormal_8cxx_source.html#l00050">LogNormal::initialize()</a>, <a class="el" href="LinearSumFunction_8cxx_source.html#l00049">LinearSumFunction::initialize()</a>, <a class="el" href="Linear_8cxx_source.html#l00043">Linear::initialize()</a>, <a class="el" href="Landau_8cxx_source.html#l00048">Landau::initialize()</a>, <a class="el" href="Gaussian_8cxx_source.html#l00054">Gaussian::initialize()</a>, <a class="el" href="Exponential_8cxx_source.html#l00045">Exponential::initialize()</a>, <a class="el" href="Erfc_8cxx_source.html#l00047">Erfc::initialize()</a>, <a class="el" href="ConstantF_8cxx_source.html#l00042">ConstantF::initialize()</a>, <a class="el" href="Chi2Dist_8cxx_source.html#l00046">Chi2Dist::initialize()</a>, <a class="el" href="BrokenPowerLaw_8cxx_source.html#l00048">BrokenPowerLaw::initialize()</a>, <a class="el" href="FunctionBase_8cxx_source.html#l00081">FunctionBase::name()</a>, and <a class="el" href="FunctionBase_8cxx_source.html#l00066">FunctionBase::setName()</a>.</p>
</div>
</div>
<a class="anchor" id="a96bf64e362e48f2ad4ecd76c32e4bc54"></a><!-- doxytag: member="hippodraw::ConstantF::m_parm_names" ref="a96bf64e362e48f2ad4ecd76c32e4bc54" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector<std::string> <a class="el" href="classhippodraw_1_1FunctionBase.html#a96bf64e362e48f2ad4ecd76c32e4bc54">m_parm_names</a><code> [protected, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The names of the function parameters. </p>
<p>Definition at line <a class="el" href="FunctionBase_8h_source.html#l00106">106</a> of file <a class="el" href="FunctionBase_8h_source.html">FunctionBase.h</a>.</p>
<p>Referenced by <a class="el" href="Quadratic2_8cxx_source.html#l00045">Quadratic2::initialize()</a>, <a class="el" href="Quadratic_8cxx_source.html#l00044">Quadratic::initialize()</a>, <a class="el" href="PowerLaw_8cxx_source.html#l00045">PowerLaw::initialize()</a>, <a class="el" href="Novosibirsk_8cxx_source.html#l00050">Novosibirsk::initialize()</a>, <a class="el" href="LogParabola_8cxx_source.html#l00051">LogParabola::initialize()</a>, <a class="el" href="LogNormal_8cxx_source.html#l00050">LogNormal::initialize()</a>, <a class="el" href="Linear_8cxx_source.html#l00043">Linear::initialize()</a>, <a class="el" href="Landau_8cxx_source.html#l00048">Landau::initialize()</a>, <a class="el" href="Gaussian_8cxx_source.html#l00054">Gaussian::initialize()</a>, <a class="el" href="Exponential_8cxx_source.html#l00045">Exponential::initialize()</a>, <a class="el" href="Erfc_8cxx_source.html#l00047">Erfc::initialize()</a>, <a class="el" href="ConstantF_8cxx_source.html#l00042">ConstantF::initialize()</a>, <a class="el" href="Chi2Dist_8cxx_source.html#l00046">Chi2Dist::initialize()</a>, <a class="el" href="BrokenPowerLaw_8cxx_source.html#l00048">BrokenPowerLaw::initialize()</a>, <a class="el" href="LinearSumFunction_8cxx_source.html#l00060">LinearSumFunction::parmNames()</a>, <a class="el" href="FunctionBase_8cxx_source.html#l00086">FunctionBase::parmNames()</a>, <a class="el" href="FunctionBase_8cxx_source.html#l00071">FunctionBase::resize()</a>, <a class="el" href="FunctionWrap_8cxx_source.html#l00243">FunctionWrap::setParmNames()</a>, <a class="el" href="FunctionBase_8cxx_source.html#l00093">FunctionBase::setParmNames()</a>, and <a class="el" href="FunctionBase_8cxx_source.html#l00156">FunctionBase::size()</a>.</p>
</div>
</div>
<a class="anchor" id="aa892dcf9755ccd651b666f353b723c34"></a><!-- doxytag: member="hippodraw::ConstantF::m_parms" ref="aa892dcf9755ccd651b666f353b723c34" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector< double > <a class="el" href="classhippodraw_1_1FunctionBase.html#aa892dcf9755ccd651b666f353b723c34">m_parms</a><code> [protected, inherited]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The parameter values. </p>
<p>Definition at line <a class="el" href="FunctionBase_8h_source.html#l00109">109</a> of file <a class="el" href="FunctionBase_8h_source.html">FunctionBase.h</a>.</p>
<p>Referenced by <a class="el" href="BrokenPowerLaw_8cxx_source.html#l00037">BrokenPowerLaw::BrokenPowerLaw()</a>, <a class="el" href="Erfc_8h_source.html#l00077">Erfc::calcRed()</a>, <a class="el" href="Chi2Dist_8cxx_source.html#l00037">Chi2Dist::Chi2Dist()</a>, <a class="el" href="ConstantF_8cxx_source.html#l00035">ConstantF::ConstantF()</a>, <a class="el" href="Gaussian_8cxx_source.html#l00144">Gaussian::derivByMean()</a>, <a class="el" href="Landau_8cxx_source.html#l00122">Landau::derivByNorm()</a>, <a class="el" href="Gaussian_8cxx_source.html#l00123">Gaussian::derivByNorm()</a>, <a class="el" href="Quadratic2_8cxx_source.html#l00082">Quadratic2::derivByParm()</a>, <a class="el" href="PowerLaw_8cxx_source.html#l00093">PowerLaw::derivByParm()</a>, <a class="el" href="LogParabola_8cxx_source.html#l00086">LogParabola::derivByParm()</a>, <a class="el" href="Exponential_8cxx_source.html#l00090">Exponential::derivByParm()</a>, <a class="el" href="Erfc_8cxx_source.html#l00088">Erfc::derivByParm()</a>, <a class="el" href="Chi2Dist_8cxx_source.html#l00078">Chi2Dist::derivByParm()</a>, <a class="el" href="BrokenPowerLaw_8cxx_source.html#l00106">BrokenPowerLaw::derivByParm()</a>, <a class="el" href="Landau_8cxx_source.html#l00129">Landau::derivByPeak()</a>, <a class="el" href="Landau_8cxx_source.html#l00134">Landau::derivBySigma()</a>, <a class="el" href="Gaussian_8cxx_source.html#l00158">Gaussian::derivBySigma()</a>, <a class="el" href="Erfc_8cxx_source.html#l00038">Erfc::Erfc()</a>, <a class="el" href="Exponential_8cxx_source.html#l00037">Exponential::Exponential()</a>, <a class="el" href="Gaussian_8cxx_source.html#l00045">Gaussian::Gaussian()</a>, <a class="el" href="LinearSumFunction_8cxx_source.html#l00083">LinearSumFunction::getParameters()</a>, <a class="el" href="FunctionBase_8cxx_source.html#l00099">FunctionBase::getParameters()</a>, <a class="el" href="Quadratic2_8cxx_source.html#l00069">Quadratic2::initialParameters()</a>, <a class="el" href="Quadratic_8cxx_source.html#l00068">Quadratic::initialParameters()</a>, <a class="el" href="PowerLaw_8cxx_source.html#l00067">PowerLaw::initialParameters()</a>, <a class="el" href="Novosibirsk_8cxx_source.html#l00098">Novosibirsk::initialParameters()</a>, <a class="el" href="LogParabola_8cxx_source.html#l00074">LogParabola::initialParameters()</a>, <a class="el" href="LogNormal_8cxx_source.html#l00078">LogNormal::initialParameters()</a>, <a class="el" href="Linear_8cxx_source.html#l00065">Linear::initialParameters()</a>, <a class="el" href="Landau_8cxx_source.html#l00093">Landau::initialParameters()</a>, <a class="el" href="Gaussian_8cxx_source.html#l00089">Gaussian::initialParameters()</a>, <a class="el" href="Exponential_8cxx_source.html#l00067">Exponential::initialParameters()</a>, <a class="el" href="Erfc_8cxx_source.html#l00080">Erfc::initialParameters()</a>, <a class="el" href="ConstantF_8cxx_source.html#l00062">ConstantF::initialParameters()</a>, <a class="el" href="Chi2Dist_8cxx_source.html#l00070">Chi2Dist::initialParameters()</a>, <a class="el" href="BrokenPowerLaw_8cxx_source.html#l00076">BrokenPowerLaw::initialParameters()</a>, <a class="el" href="Landau_8cxx_source.html#l00039">Landau::Landau()</a>, <a class="el" href="Linear_8cxx_source.html#l00035">Linear::Linear()</a>, <a class="el" href="LogNormal_8cxx_source.html#l00041">LogNormal::LogNormal()</a>, <a class="el" href="LogParabola_8cxx_source.html#l00042">LogParabola::LogParabola()</a>, <a class="el" href="Novosibirsk_8cxx_source.html#l00040">Novosibirsk::Novosibirsk()</a>, <a class="el" href="Quadratic2_8cxx_source.html#l00061">Quadratic2::operator()()</a>, <a class="el" href="Quadratic_8cxx_source.html#l00060">Quadratic::operator()()</a>, <a class="el" href="PowerLaw_8cxx_source.html#l00059">PowerLaw::operator()()</a>, <a class="el" href="Novosibirsk_8cxx_source.html#l00067">Novosibirsk::operator()()</a>, <a class="el" href="LogParabola_8cxx_source.html#l00067">LogParabola::operator()()</a>, <a class="el" href="LogNormal_8cxx_source.html#l00066">LogNormal::operator()()</a>, <a class="el" href="Linear_8cxx_source.html#l00057">Linear::operator()()</a>, <a class="el" href="Landau_8cxx_source.html#l00081">Landau::operator()()</a>, <a class="el" href="Gaussian_8cxx_source.html#l00070">Gaussian::operator()()</a>, <a class="el" href="Exponential_8cxx_source.html#l00059">Exponential::operator()()</a>, <a class="el" href="ConstantF_8cxx_source.html#l00055">ConstantF::operator()()</a>, <a class="el" href="Chi2Dist_8cxx_source.html#l00061">Chi2Dist::operator()()</a>, <a class="el" href="BrokenPowerLaw_8cxx_source.html#l00064">BrokenPowerLaw::operator()()</a>, <a class="el" href="PowerLaw_8cxx_source.html#l00037">PowerLaw::PowerLaw()</a>, <a class="el" href="Quadratic_8cxx_source.html#l00035">Quadratic::Quadratic()</a>, <a class="el" href="Quadratic2_8cxx_source.html#l00036">Quadratic2::Quadratic2()</a>, <a class="el" href="FunctionBase_8cxx_source.html#l00071">FunctionBase::resize()</a>, and <a class="el" href="FunctionBase_8cxx_source.html#l00114">FunctionBase::setParameters()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="ConstantF_8h_source.html">ConstantF.h</a></li>
<li><a class="el" href="ConstantF_8cxx_source.html">ConstantF.cxx</a></li>
</ul>
</div>
<hr size="1"><address style="align: right;"><small>
Generated for HippoDraw Class Library by <a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0>
</a> </small></address>
</body>
</html>
