<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_1StatedFCN.html">StatedFCN</a>
</div>
</div>
<div class="contents">
<h1>StatedFCN Class Reference</h1><!-- doxytag: class="hippodraw::StatedFCN" --><!-- doxytag: inherits="FCNBase" -->
<p>A derived class for <a class="elRef" doxygen="Minuit.tag:http://seal.web.cern.ch/seal/MathLibs/Minuit/html/" href="http://seal.web.cern.ch/seal/MathLibs/Minuit/html/classFCNBase.html">FCNBase</a> class.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="StatedFCN_8h_source.html">StatedFCN.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for StatedFCN:</div>
<div class="dynsection">
<div class="center"><img src="classhippodraw_1_1StatedFCN__inherit__graph.gif" border="0" usemap="#StatedFCN_inherit__map" alt="Inheritance graph"/></div>
<map name="StatedFCN_inherit__map" id="StatedFCN_inherit__map">
<area shape="rect" id="node5" href="classhippodraw_1_1NTupleFCN.html" title="A derived class of StatedFCN This class gets its data points from a DataSource." alt="" coords="188,160,279,189"/><area shape="rect" id="node2" doxygen="Minuit.tag:http://seal.web.cern.ch/seal/MathLibs/Minuit/html/" href="http://seal.web.cern.ch/seal/MathLibs/Minuit/html/classFCNBase.html" title="FCNBase" alt="" coords="193,5,273,35"/><area shape="rect" id="node7" href="classhippodraw_1_1NTupleChiSqFCN.html" title="A Chi-squared functor class." alt="" coords="5,237,133,267"/><area shape="rect" id="node9" href="classhippodraw_1_1NTupleLikeliHoodFCN.html" title="A Likelihood functor class." alt="" coords="157,237,309,267"/><area shape="rect" id="node11" href="classhippodraw_1_1NTuplePearsonFCN.html" title="A Pearson's Chi-squared functor class." alt="" coords="333,237,472,267"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for StatedFCN:</div>
<div class="dynsection">
<div class="center"><img src="classhippodraw_1_1StatedFCN__coll__graph.gif" border="0" usemap="#StatedFCN_coll__map" alt="Collaboration graph"/></div>
<map name="StatedFCN_coll__map" id="StatedFCN_coll__map">
<area shape="rect" id="node2" doxygen="Minuit.tag:http://seal.web.cern.ch/seal/MathLibs/Minuit/html/" href="http://seal.web.cern.ch/seal/MathLibs/Minuit/html/classFCNBase.html" title="FCNBase" alt="" coords="63,293,143,323"/><area shape="rect" id="node4" href="classhippodraw_1_1FunctionBase.html" title="A function that can be added to a DataRep and used in a fitter." alt="" coords="167,293,268,323"/><area shape="rect" id="node6" title="STL class." alt="" coords="49,101,103,131"/><area shape="rect" id="node8" title="STL class." alt="" coords="5,5,147,35"/><area shape="rect" id="node13" title="STL class." alt="" coords="261,101,352,131"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classhippodraw_1_1StatedFCN-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_1StatedFCN.html#aa5271c3a579b2eec0bb989cb270de3a7">calcAlphaBeta</a> (std::vector< std::vector< double > > &alpha, std::vector< double > &beta)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classhippodraw_1_1StatedFCN.html">StatedFCN</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1StatedFCN.html#acd37539348111ff623df618800860a79">clone</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Makes a copy of the derived class object. <a href="#acd37539348111ff623df618800860a79"></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_1StatedFCN.html#ab0fb42c970f3d877d531dc69324f4a13">copyFrom</a> (const <a class="el" href="classhippodraw_1_1StatedFCN.html">StatedFCN</a> *other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Makes a copy of the relevant attributes from <em>other</em> object. <a href="#ab0fb42c970f3d877d531dc69324f4a13"></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_1StatedFCN.html#a55ecc5c1799212f0bf1943fb0e14e73e">degreesOfFreedom</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of degrees of freedom. <a href="#a55ecc5c1799212f0bf1943fb0e14e73e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="elRef" doxygen="Minuit.tag:http://seal.web.cern.ch/seal/MathLibs/Minuit/html/" href="http://seal.web.cern.ch/seal/MathLibs/Minuit/html/classFCNBase.html#FCNGradientBasea4">errorDef</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1StatedFCN.html#a003a278024cb1697a7da7693cb173e13">fillFreeDerivatives</a> (std::vector< double > &, double x)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Clears and fills the vector with the derivatives of the function a coordinate value x. <a href="#a003a278024cb1697a7da7693cb173e13"></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_1StatedFCN.html#af1f6388d597dbb84c5037744087d6adc">fillFreeParameters</a> (std::vector< double > &free_parms) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Fills the vector with the values of the free parameters. <a href="#af1f6388d597dbb84c5037744087d6adc"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::vector< int > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1StatedFCN.html#a777e60f0c60999be4d87fa177c88977e">getFixedFlags</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the vector of which of the model function's parameters are considered fixed and not to be changed during minimization of this objective function. <a href="#a777e60f0c60999be4d87fa177c88977e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1StatedFCN.html#ac9e48046c9ded89ff309004c57189984">getNumberFreeParms</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the number of free parameters. <a href="#ac9e48046c9ded89ff309004c57189984"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::vector< double > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1StatedFCN.html#ab6d95a533aca7f862becee6eca151a68">getParameters</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the current state of the model function's parameters. <a href="#ab6d95a533aca7f862becee6eca151a68"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">const std::vector< std::string > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1StatedFCN.html#a651e3160511ef4c64f182146d5f3de92">getParmNames</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the names of the model function's parameters. <a href="#a651e3160511ef4c64f182146d5f3de92"></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_1StatedFCN.html#a1c924d04fed95a502a09f7fe7ce0432a">getUseErrors</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if error data from the <a class="el" href="classhippodraw_1_1DataSource.html" title="Base class for DataSource.">DataSource</a> is to be used. <a href="#a1c924d04fed95a502a09f7fe7ce0432a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1StatedFCN.html#a85bc0316db791b8c7a740be85b2acd84">hasFunction</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if model function has been set, otherwise returns <code>false</code>. <a href="#a85bc0316db791b8c7a740be85b2acd84"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1StatedFCN.html#afb07a512dba156a736e361e9ba19b065">isCompatible</a> (const <a class="el" href="classhippodraw_1_1FunctionBase.html">FunctionBase</a> *) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if function is compatible this objective function. <a href="#afb07a512dba156a736e361e9ba19b065"></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_1StatedFCN.html#af3efb59034c525f50e2e95282b1a2bcb">needsIntegrated</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns <code>true</code> if data points were integrated. <a href="#af3efb59034c525f50e2e95282b1a2bcb"></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_1StatedFCN.html#aa8dd40bae951055be0330b2d31bef942">objectiveValue</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the value of the objective function. <a href="#aa8dd40bae951055be0330b2d31bef942"></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_1StatedFCN.html#a2c182d63f5d59fe955fb4b3376cc73b3">operator()</a> (const std::vector< double > &parms) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the model function parameters to <em>parms</em> and returns the objective value. <a href="#a2c182d63f5d59fe955fb4b3376cc73b3"></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_1StatedFCN.html#a34616ec0b931f30459b1b1573e16fccf">setDataSource</a> (const <a class="el" href="classhippodraw_1_1DataSource.html">DataSource</a> *source, int dimension, const std::vector< int > &)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the data source, dimension, and indices into the columns. <a href="#a34616ec0b931f30459b1b1573e16fccf"></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_1StatedFCN.html#ab33a1bcfede7bc7d9990d08593405bc1">setDataSource</a> (const <a class="el" href="classhippodraw_1_1DataSource.html">DataSource</a> *source)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the data source. <a href="#ab33a1bcfede7bc7d9990d08593405bc1"></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_1StatedFCN.html#a231ddfe5d56a59f7e7d52b8fdbd59401">setFitCut</a> (<a class="el" href="classhippodraw_1_1TupleCut.html">TupleCut</a> *cut)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the cut to limit range of fitting. <a href="#a231ddfe5d56a59f7e7d52b8fdbd59401"></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_1StatedFCN.html#a559998f72c916ece70beb18ecf490766">setFitRange</a> (bool yes=true)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets use of a fitting range on or off. <a href="#a559998f72c916ece70beb18ecf490766"></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_1StatedFCN.html#ac50591297b951f99124f66a4b9b5e785">setFixedFlags</a> (const std::vector< int > &flags)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the parameters that are to be held fixed during minimization of this objective function. <a href="#ac50591297b951f99124f66a4b9b5e785"></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_1StatedFCN.html#a36eca8449007e74b5e40a1e68aa1ba48">setFreeParameters</a> (const std::vector< double > &parms)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the free parameters from the vector <em>parms</em>. <a href="#a36eca8449007e74b5e40a1e68aa1ba48"></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_1StatedFCN.html#a65ce3c605e5795ae822acda0c0aab146">setFunction</a> (<a class="el" href="classhippodraw_1_1FunctionBase.html">FunctionBase</a> *function)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the model function. <a href="#a65ce3c605e5795ae822acda0c0aab146"></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_1StatedFCN.html#a24e41fbd77c87afc49df17c084f10903">setNeedsDerivatives</a> (bool yes)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the needs derivatives flag. <a href="#a24e41fbd77c87afc49df17c084f10903"></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_1StatedFCN.html#af6411d7495d2807652e54f20cdbcaf25">setParameters</a> (const std::vector< double > &parms)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the values of the model function's parameters. <a href="#af6411d7495d2807652e54f20cdbcaf25"></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_1StatedFCN.html#a6dadef88f09ba2c6f74d8e20a1a6fdf6">setUseErrors</a> (bool yes=true)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the FCN to use errors from the <a class="el" href="classhippodraw_1_1DataSource.html" title="Base class for DataSource.">DataSource</a> if they are available on all data points. <a href="#a6dadef88f09ba2c6f74d8e20a1a6fdf6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual double </td><td class="memItemRight" valign="bottom"><a class="elRef" doxygen="Minuit.tag:http://seal.web.cern.ch/seal/MathLibs/Minuit/html/" href="http://seal.web.cern.ch/seal/MathLibs/Minuit/html/classFCNBase.html#FCNGradientBasea5">up</a> () const =0</td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1StatedFCN.html#a72b74a2053f12e8ed17b99ac4ba32a45">StatedFCN</a> (const <a class="el" href="classhippodraw_1_1StatedFCN.html">StatedFCN</a> &)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The copy constructor. <a href="#a72b74a2053f12e8ed17b99ac4ba32a45"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1StatedFCN.html#a2b5ec89037208c81f6f3f933220c09a1">StatedFCN</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The default constructor. <a href="#a2b5ec89037208c81f6f3f933220c09a1"></a><br/></td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classhippodraw_1_1FunctionBase.html">FunctionBase</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1StatedFCN.html#a8dc0ee286cf84b5835db9b75cb771cf4">m_function</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A pointer to the model function to be used in fitting. <a href="#a8dc0ee286cf84b5835db9b75cb771cf4"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1StatedFCN.html#a7f0fe8c855395f1df4b4162c43e376a1">m_needs_derivs</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Needs derivatives flag. <a href="#a7f0fe8c855395f1df4b4162c43e376a1"></a><br/></td></tr>
<tr><td colspan="2"><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">std::vector< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classhippodraw_1_1StatedFCN.html#a577ee4bec395e845b448e3632f919c36">m_fixed_flags</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">The flags to indicated which parameters are to be held fixed during minimization of this objective function. <a href="#a577ee4bec395e845b448e3632f919c36"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>A derived class for <a class="elRef" doxygen="Minuit.tag:http://seal.web.cern.ch/seal/MathLibs/Minuit/html/" href="http://seal.web.cern.ch/seal/MathLibs/Minuit/html/classFCNBase.html">FCNBase</a> class. </p>
<p>This class uses a stated function derived from <a class="el" href="classhippodraw_1_1FunctionBase.html" title="A function that can be added to a DataRep and used in a fitter.">FunctionBase</a>. That is, it assumes the function maintains the state of all its parameters.</p>
<dl class="note"><dt><b>Note:</b></dt><dd>If <b>HippoDraw</b> is built with Minuit or Minuit2, then this class is derived from the Minuit's <a class="elRef" doxygen="Minuit.tag:http://seal.web.cern.ch/seal/MathLibs/Minuit/html/" href="http://seal.web.cern.ch/seal/MathLibs/Minuit/html/classFCNBase.html">FCNBase</a> class, otherwise it derives from <b>HippoDraw's</b> <a class="elRef" doxygen="Minuit.tag:http://seal.web.cern.ch/seal/MathLibs/Minuit/html/" href="http://seal.web.cern.ch/seal/MathLibs/Minuit/html/classFCNBase.html">FCNBase</a>. The difference between Minuit and Minuit2 is the capitialization of the member function names. There's no difference between HippoDraw's and Minuit's <a class="elRef" doxygen="Minuit.tag:http://seal.web.cern.ch/seal/MathLibs/Minuit/html/" href="http://seal.web.cern.ch/seal/MathLibs/Minuit/html/classFCNBase.html">FCNBase</a> class. If you derive from this class, you need to supply a <em> config.h </em> file which contains a define HAVE_MINUIT or define HAVE_MINUIT2 depending on how HippoDraw was built. HippoDraw doesn't install its autoconf generated <em> config.h </em> file since it may conflict with a file of the same name from other packages.</dd></dl>
<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="StatedFCN_8h_source.html#l00069">69</a> of file <a class="el" href="StatedFCN_8h_source.html">StatedFCN.h</a>.</p>
<hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a2b5ec89037208c81f6f3f933220c09a1"></a><!-- doxytag: member="hippodraw::StatedFCN::StatedFCN" ref="a2b5ec89037208c81f6f3f933220c09a1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhippodraw_1_1StatedFCN.html">StatedFCN</a> </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The default constructor. </p>
<p>The default constructor initializes the pointer to the model function to the null pointer. </p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00028">28</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
</div>
</div>
<a class="anchor" id="a72b74a2053f12e8ed17b99ac4ba32a45"></a><!-- doxytag: member="hippodraw::StatedFCN::StatedFCN" ref="a72b74a2053f12e8ed17b99ac4ba32a45" args="(const StatedFCN &)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhippodraw_1_1StatedFCN.html">StatedFCN</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhippodraw_1_1StatedFCN.html">StatedFCN</a> & </td>
<td class="paramname"> <em>fcn</em></td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The copy constructor. </p>
<p>The copy constructor makes a copy of the pointer to the <a class="el" href="classhippodraw_1_1FunctionBase.html" title="A function that can be added to a DataRep and used in a fitter.">FunctionBase</a> object it uses. </p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00035">35</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa5271c3a579b2eec0bb989cb270de3a7"></a><!-- doxytag: member="hippodraw::StatedFCN::calcAlphaBeta" ref="aa5271c3a579b2eec0bb989cb270de3a7" args="(std::vector< std::vector< double > > &alpha, std::vector< double > &beta)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void calcAlphaBeta </td>
<td>(</td>
<td class="paramtype">std::vector< std::vector< double > > & </td>
<td class="paramname"> <em>alpha</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector< double > & </td>
<td class="paramname"> <em>beta</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Implemented in <a class="el" href="classhippodraw_1_1NTupleFCN.html#ac9f4cc0cbf8ed2377d6663e3d34c2ce7">NTupleFCN</a>.</p>
</div>
</div>
<a class="anchor" id="acd37539348111ff623df618800860a79"></a><!-- doxytag: member="hippodraw::StatedFCN::clone" ref="acd37539348111ff623df618800860a79" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classhippodraw_1_1StatedFCN.html">StatedFCN</a>* clone </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Makes a copy of the derived class object. </p>
<p>Implemented in <a class="el" href="classhippodraw_1_1NTupleChiSqFCN.html#a1a9bae9949914ddd55e372ba6dcfd110">NTupleChiSqFCN</a>, <a class="el" href="classhippodraw_1_1NTupleLikeliHoodFCN.html#a1a9bae9949914ddd55e372ba6dcfd110">NTupleLikeliHoodFCN</a>, and <a class="el" href="classhippodraw_1_1NTuplePearsonFCN.html#a1a9bae9949914ddd55e372ba6dcfd110">NTuplePearsonFCN</a>.</p>
</div>
</div>
<a class="anchor" id="ab0fb42c970f3d877d531dc69324f4a13"></a><!-- doxytag: member="hippodraw::StatedFCN::copyFrom" ref="ab0fb42c970f3d877d531dc69324f4a13" args="(const StatedFCN *other)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void copyFrom </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhippodraw_1_1StatedFCN.html">StatedFCN</a> * </td>
<td class="paramname"> <em>other</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Makes a copy of the relevant attributes from <em>other</em> object. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>This is similar to a copy constructor, but can be used between objects from different derived classes. </dd></dl>
<p>Reimplemented in <a class="el" href="classhippodraw_1_1NTupleFCN.html#a02ce45a9049afed1faf35b2f9159f6c6">NTupleFCN</a>.</p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00045">45</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
<p>References <a class="el" href="StatedFCN_8h_source.html#l00082">StatedFCN::m_fixed_flags</a>, and <a class="el" href="StatedFCN_8h_source.html#l00089">StatedFCN::m_function</a>.</p>
</div>
</div>
<a class="anchor" id="a55ecc5c1799212f0bf1943fb0e14e73e"></a><!-- doxytag: member="hippodraw::StatedFCN::degreesOfFreedom" ref="a55ecc5c1799212f0bf1943fb0e14e73e" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int degreesOfFreedom </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of degrees of freedom. </p>
<p>Implemented in <a class="el" href="classhippodraw_1_1NTupleFCN.html#a4fd39d150f1dc0c6313d5c633aa3137a">NTupleFCN</a>.</p>
</div>
</div>
<a class="anchor" id="a003a278024cb1697a7da7693cb173e13"></a><!-- doxytag: member="hippodraw::StatedFCN::fillFreeDerivatives" ref="a003a278024cb1697a7da7693cb173e13" args="(std::vector< double > &, double x)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fillFreeDerivatives </td>
<td>(</td>
<td class="paramtype">std::vector< double > & </td>
<td class="paramname"> <em>derives</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></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Clears and fills the vector with the derivatives of the function a coordinate value x. </p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00166">166</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
<p>References <a class="el" href="StatedFCN_8cxx_source.html#l00093">StatedFCN::getParameters()</a>, <a class="el" href="StatedFCN_8h_source.html#l00082">StatedFCN::m_fixed_flags</a>, <a class="el" href="StatedFCN_8h_source.html#l00089">StatedFCN::m_function</a>, and <a class="el" href="num__util_8cpp_source.html#l00296">num_util::size()</a>.</p>
<p>Referenced by <a class="el" href="NTupleFCN_8cxx_source.html#l00194">NTupleFCN::calcAlphaBeta()</a>.</p>
</div>
</div>
<a class="anchor" id="af1f6388d597dbb84c5037744087d6adc"></a><!-- doxytag: member="hippodraw::StatedFCN::fillFreeParameters" ref="af1f6388d597dbb84c5037744087d6adc" args="(std::vector< double > &free_parms) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fillFreeParameters </td>
<td>(</td>
<td class="paramtype">std::vector< double > & </td>
<td class="paramname"> <em>free_parms</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Fills the vector with the values of the free parameters. </p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00107">107</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
<p>References <a class="el" href="StatedFCN_8cxx_source.html#l00093">StatedFCN::getParameters()</a>, <a class="el" href="StatedFCN_8h_source.html#l00082">StatedFCN::m_fixed_flags</a>, <a class="el" href="StatedFCN_8h_source.html#l00089">StatedFCN::m_function</a>, and <a class="el" href="num__util_8cpp_source.html#l00296">num_util::size()</a>.</p>
</div>
</div>
<a class="anchor" id="a777e60f0c60999be4d87fa177c88977e"></a><!-- doxytag: member="hippodraw::StatedFCN::getFixedFlags" ref="a777e60f0c60999be4d87fa177c88977e" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const vector< int > & getFixedFlags </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the vector of which of the model function's parameters are considered fixed and not to be changed during minimization of this objective function. </p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00134">134</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
<p>References <a class="el" href="StatedFCN_8h_source.html#l00082">StatedFCN::m_fixed_flags</a>.</p>
</div>
</div>
<a class="anchor" id="ac9e48046c9ded89ff309004c57189984"></a><!-- doxytag: member="hippodraw::StatedFCN::getNumberFreeParms" ref="ac9e48046c9ded89ff309004c57189984" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int getNumberFreeParms </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the number of free parameters. </p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00121">121</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
<p>References <a class="el" href="StatedFCN_8h_source.html#l00082">StatedFCN::m_fixed_flags</a>, and <a class="el" href="num__util_8cpp_source.html#l00296">num_util::size()</a>.</p>
<p>Referenced by <a class="el" href="NTupleFCN_8cxx_source.html#l00194">NTupleFCN::calcAlphaBeta()</a>, and <a class="el" href="NTupleFCN_8cxx_source.html#l00158">NTupleFCN::degreesOfFreedom()</a>.</p>
</div>
</div>
<a class="anchor" id="ab6d95a533aca7f862becee6eca151a68"></a><!-- doxytag: member="hippodraw::StatedFCN::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</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the current state of the model function's parameters. </p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00093">93</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
<p>References <a class="el" href="StatedFCN_8h_source.html#l00089">StatedFCN::m_function</a>.</p>
<p>Referenced by <a class="el" href="StatedFCN_8cxx_source.html#l00166">StatedFCN::fillFreeDerivatives()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00107">StatedFCN::fillFreeParameters()</a>, and <a class="el" href="StatedFCN_8cxx_source.html#l00148">StatedFCN::setFreeParameters()</a>.</p>
</div>
</div>
<a class="anchor" id="a651e3160511ef4c64f182146d5f3de92"></a><!-- doxytag: member="hippodraw::StatedFCN::getParmNames" ref="a651e3160511ef4c64f182146d5f3de92" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const vector< string > & getParmNames </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the names of the model function's parameters. </p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00086">86</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
<p>References <a class="el" href="StatedFCN_8h_source.html#l00089">StatedFCN::m_function</a>.</p>
</div>
</div>
<a class="anchor" id="a1c924d04fed95a502a09f7fe7ce0432a"></a><!-- doxytag: member="hippodraw::StatedFCN::getUseErrors" ref="a1c924d04fed95a502a09f7fe7ce0432a" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool getUseErrors </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns true if error data from the <a class="el" href="classhippodraw_1_1DataSource.html" title="Base class for DataSource.">DataSource</a> is to be used. </p>
<p>Implemented in <a class="el" href="classhippodraw_1_1NTupleFCN.html#a5db61f264b6fbebf40b61faedae06dc6">NTupleFCN</a>.</p>
</div>
</div>
<a class="anchor" id="a85bc0316db791b8c7a740be85b2acd84"></a><!-- doxytag: member="hippodraw::StatedFCN::hasFunction" ref="a85bc0316db791b8c7a740be85b2acd84" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool hasFunction </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns <code>true</code> if model function has been set, otherwise returns <code>false</code>. </p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00054">54</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
<p>References <a class="el" href="StatedFCN_8h_source.html#l00089">StatedFCN::m_function</a>.</p>
</div>
</div>
<a class="anchor" id="afb07a512dba156a736e361e9ba19b065"></a><!-- doxytag: member="hippodraw::StatedFCN::isCompatible" ref="afb07a512dba156a736e361e9ba19b065" args="(const FunctionBase *) const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool isCompatible </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhippodraw_1_1FunctionBase.html">FunctionBase</a> * </td>
<td class="paramname"> <em>function</em></td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns <code>true</code> if function is compatible this objective function. </p>
<p>Return <code>false</code> if the function is incompatible with this objective function. For example, if the fitter indicated it needs partial derivatives and the function can not provide them. </p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00198">198</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
<p>References <a class="el" href="StatedFCN_8h_source.html#l00094">StatedFCN::m_needs_derivs</a>.</p>
<p>Referenced by <a class="el" href="StatedFCN_8cxx_source.html#l00064">StatedFCN::setFunction()</a>.</p>
</div>
</div>
<a class="anchor" id="af3efb59034c525f50e2e95282b1a2bcb"></a><!-- doxytag: member="hippodraw::StatedFCN::needsIntegrated" ref="af3efb59034c525f50e2e95282b1a2bcb" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool needsIntegrated </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns <code>true</code> if data points were integrated. </p>
<p>Return <code>true</code> if the FCN function needs data points were integrated over a range. An example would be a histogram. Returns <code>false</code> if the integrated data points are not needed. </p>
<p>Implemented in <a class="el" href="classhippodraw_1_1NTupleChiSqFCN.html#a19687104100dbb1e3492a0952da14319">NTupleChiSqFCN</a>, <a class="el" href="classhippodraw_1_1NTupleLikeliHoodFCN.html#a19687104100dbb1e3492a0952da14319">NTupleLikeliHoodFCN</a>, and <a class="el" href="classhippodraw_1_1NTuplePearsonFCN.html#a19687104100dbb1e3492a0952da14319">NTuplePearsonFCN</a>.</p>
</div>
</div>
<a class="anchor" id="aa8dd40bae951055be0330b2d31bef942"></a><!-- doxytag: member="hippodraw::StatedFCN::objectiveValue" ref="aa8dd40bae951055be0330b2d31bef942" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual double objectiveValue </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the value of the objective function. </p>
<p>Returns the value of the objective function for the current state of the function. The state of the function's parameters is set by operator(). Other states the function may have is set by calling member functions of the function directly. </p>
<p>Implemented in <a class="el" href="classhippodraw_1_1NTupleChiSqFCN.html#a35d807e079d04d56ca61b604d49deae8">NTupleChiSqFCN</a>, <a class="el" href="classhippodraw_1_1NTupleLikeliHoodFCN.html#a35d807e079d04d56ca61b604d49deae8">NTupleLikeliHoodFCN</a>, and <a class="el" href="classhippodraw_1_1NTuplePearsonFCN.html#a35d807e079d04d56ca61b604d49deae8">NTuplePearsonFCN</a>.</p>
<p>Referenced by <a class="el" href="StatedFCN_8cxx_source.html#l00182">StatedFCN::operator()()</a>.</p>
</div>
</div>
<a class="anchor" id="a2c182d63f5d59fe955fb4b3376cc73b3"></a><!-- doxytag: member="hippodraw::StatedFCN::operator()" ref="a2c182d63f5d59fe955fb4b3376cc73b3" args="(const std::vector< double > &parms) 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>parms</em></td>
<td> ) </td>
<td> const<code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the model function parameters to <em>parms</em> and returns the objective value. </p>
<p>Implements <a class="elRef" doxygen="Minuit.tag:http://seal.web.cern.ch/seal/MathLibs/Minuit/html/" href="http://seal.web.cern.ch/seal/MathLibs/Minuit/html/classFCNBase.html#FCNGradientBasea3">FCNBase</a>.</p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00182">182</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
<p>References <a class="el" href="StatedFCN_8h_source.html#l00089">StatedFCN::m_function</a>, <a class="el" href="classhippodraw_1_1StatedFCN.html#aa8dd40bae951055be0330b2d31bef942">StatedFCN::objectiveValue()</a>, and <a class="el" href="StatedFCN_8cxx_source.html#l00100">StatedFCN::setParameters()</a>.</p>
<p>Referenced by <a class="el" href="NTupleFCN_8cxx_source.html#l00194">NTupleFCN::calcAlphaBeta()</a>, <a class="el" href="NTuplePearsonFCN_8cxx_source.html#l00060">NTuplePearsonFCN::objectiveValue()</a>, and <a class="el" href="NTupleChiSqFCN_8cxx_source.html#l00061">NTupleChiSqFCN::objectiveValue()</a>.</p>
</div>
</div>
<a class="anchor" id="a34616ec0b931f30459b1b1573e16fccf"></a><!-- doxytag: member="hippodraw::StatedFCN::setDataSource" ref="a34616ec0b931f30459b1b1573e16fccf" args="(const DataSource *source, int dimension, const std::vector< int > &)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void setDataSource </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhippodraw_1_1DataSource.html">DataSource</a> * </td>
<td class="paramname"> <em>source</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>dimension</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< int > & </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the data source, dimension, and indices into the columns. </p>
<p>Sets the data source, dimension and indices into the column. For one dimensional data source, the order of the indices are as in The <a class="el" href="namespacehippodraw_1_1DataPoint2DTuple.html" title="A namespace to set the standard for indexing into 2 dimension data point tuple.">hippodraw::DataPoint2DTuple</a> enumeration. For two dimensional data source as with <a class="el" href="namespacehippodraw_1_1DataPoint3DTuple.html" title="A namespace to set the standard for indexing into 3 dimension data point tuple.">hippodraw::DataPoint3DTuple</a> enumeration. For higher dimensions, the pattern should repeat. A negative index value indicates that the variable is not used. </p>
<p>Implemented in <a class="el" href="classhippodraw_1_1NTupleFCN.html#a373abd043d2fb5e4debf05178bf61145">NTupleFCN</a>.</p>
</div>
</div>
<a class="anchor" id="ab33a1bcfede7bc7d9990d08593405bc1"></a><!-- doxytag: member="hippodraw::StatedFCN::setDataSource" ref="ab33a1bcfede7bc7d9990d08593405bc1" args="(const DataSource *source)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void setDataSource </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classhippodraw_1_1DataSource.html">DataSource</a> * </td>
<td class="paramname"> <em>source</em></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the data source. </p>
<p>Sets the data source and uses indices from <a class="el" href="namespacehippodraw_1_1DataPoint2DTuple.html" title="A namespace to set the standard for indexing into 2 dimension data point tuple.">hippodraw::DataPoint2DTuple</a>. </p>
<p>Implemented in <a class="el" href="classhippodraw_1_1NTupleFCN.html#af5e61f87813b72805dbd38266f4d5a91">NTupleFCN</a>.</p>
</div>
</div>
<a class="anchor" id="a231ddfe5d56a59f7e7d52b8fdbd59401"></a><!-- doxytag: member="hippodraw::StatedFCN::setFitCut" ref="a231ddfe5d56a59f7e7d52b8fdbd59401" args="(TupleCut *cut)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void setFitCut </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classhippodraw_1_1TupleCut.html">TupleCut</a> * </td>
<td class="paramname"> <em>cut</em></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the cut to limit range of fitting. </p>
<p>Implemented in <a class="el" href="classhippodraw_1_1NTupleFCN.html#af6777101133629cf4ec9665cb87692bf">NTupleFCN</a>.</p>
</div>
</div>
<a class="anchor" id="a559998f72c916ece70beb18ecf490766"></a><!-- doxytag: member="hippodraw::StatedFCN::setFitRange" ref="a559998f72c916ece70beb18ecf490766" args="(bool yes=true)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void setFitRange </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>yes</em> = <code>true</code></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets use of a fitting range on or off. </p>
<p>Implemented in <a class="el" href="classhippodraw_1_1NTupleFCN.html#ae9ffca067177b475c7b4d334a9e0ecec">NTupleFCN</a>.</p>
</div>
</div>
<a class="anchor" id="ac50591297b951f99124f66a4b9b5e785"></a><!-- doxytag: member="hippodraw::StatedFCN::setFixedFlags" ref="ac50591297b951f99124f66a4b9b5e785" args="(const std::vector< int > &flags)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setFixedFlags </td>
<td>(</td>
<td class="paramtype">const std::vector< int > & </td>
<td class="paramname"> <em>flags</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the parameters that are to be held fixed during minimization of this objective function. </p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00141">141</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
<p>References <a class="el" href="StatedFCN_8h_source.html#l00082">StatedFCN::m_fixed_flags</a>.</p>
</div>
</div>
<a class="anchor" id="a36eca8449007e74b5e40a1e68aa1ba48"></a><!-- doxytag: member="hippodraw::StatedFCN::setFreeParameters" ref="a36eca8449007e74b5e40a1e68aa1ba48" args="(const std::vector< double > &parms)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setFreeParameters </td>
<td>(</td>
<td class="paramtype">const std::vector< double > & </td>
<td class="paramname"> <em>parms</em></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the free parameters from the vector <em>parms</em>. </p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00148">148</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
<p>References <a class="el" href="StatedFCN_8cxx_source.html#l00093">StatedFCN::getParameters()</a>, <a class="el" href="StatedFCN_8h_source.html#l00082">StatedFCN::m_fixed_flags</a>, <a class="el" href="StatedFCN_8h_source.html#l00089">StatedFCN::m_function</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00100">StatedFCN::setParameters()</a>, and <a class="el" href="num__util_8cpp_source.html#l00296">num_util::size()</a>.</p>
</div>
</div>
<a class="anchor" id="a65ce3c605e5795ae822acda0c0aab146"></a><!-- doxytag: member="hippodraw::StatedFCN::setFunction" ref="a65ce3c605e5795ae822acda0c0aab146" args="(FunctionBase *function)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setFunction </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classhippodraw_1_1FunctionBase.html">FunctionBase</a> * </td>
<td class="paramname"> <em>function</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the model function. </p>
<p>Sets the model function object to <em>function</em>.</p>
<dl class="bug"><dt><b><a class="el" href="bug.html#_bug000038">Bug:</a></b></dt><dd>@@ Should be able to display a function without fitting. Use examples/fuction_rep.py to see the problem. </dd></dl>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00064">64</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
<p>References <a class="el" href="StatedFCN_8cxx_source.html#l00198">StatedFCN::isCompatible()</a>, <a class="el" href="StatedFCN_8h_source.html#l00082">StatedFCN::m_fixed_flags</a>, <a class="el" href="StatedFCN_8h_source.html#l00089">StatedFCN::m_function</a>, and <a class="el" href="num__util_8cpp_source.html#l00296">num_util::size()</a>.</p>
</div>
</div>
<a class="anchor" id="a24e41fbd77c87afc49df17c084f10903"></a><!-- doxytag: member="hippodraw::StatedFCN::setNeedsDerivatives" ref="a24e41fbd77c87afc49df17c084f10903" args="(bool yes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void setNeedsDerivatives </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>yes</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the needs derivatives flag. </p>
<p>Sets the needs derivatives flag to <code>true</code> if the <a class="el" href="classhippodraw_1_1Fitter.html" title="The base class for fitters.">Fitter</a> needs partial derivatives from the <a class="el" href="classhippodraw_1_1FunctionBase.html" title="A function that can be added to a DataRep and used in a fitter.">FunctionBase</a> object. </p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00191">191</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
<p>References <a class="el" href="StatedFCN_8h_source.html#l00094">StatedFCN::m_needs_derivs</a>.</p>
</div>
</div>
<a class="anchor" id="af6411d7495d2807652e54f20cdbcaf25"></a><!-- doxytag: member="hippodraw::StatedFCN::setParameters" ref="af6411d7495d2807652e54f20cdbcaf25" args="(const std::vector< double > &parms)" -->
<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>parms</em></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the values of the model function's parameters. </p>
<p>Definition at line <a class="el" href="StatedFCN_8cxx_source.html#l00100">100</a> of file <a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.cxx</a>.</p>
<p>References <a class="el" href="StatedFCN_8h_source.html#l00089">StatedFCN::m_function</a>.</p>
<p>Referenced by <a class="el" href="StatedFCN_8cxx_source.html#l00182">StatedFCN::operator()()</a>, and <a class="el" href="StatedFCN_8cxx_source.html#l00148">StatedFCN::setFreeParameters()</a>.</p>
</div>
</div>
<a class="anchor" id="a6dadef88f09ba2c6f74d8e20a1a6fdf6"></a><!-- doxytag: member="hippodraw::StatedFCN::setUseErrors" ref="a6dadef88f09ba2c6f74d8e20a1a6fdf6" args="(bool yes=true)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool setUseErrors </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>yes</em> = <code>true</code></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Sets the FCN to use errors from the <a class="el" href="classhippodraw_1_1DataSource.html" title="Base class for DataSource.">DataSource</a> if they are available on all data points. </p>
<p>Implemented in <a class="el" href="classhippodraw_1_1NTupleFCN.html#ab16b2e55114812f533fd0259c8f72084">NTupleFCN</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a577ee4bec395e845b448e3632f919c36"></a><!-- doxytag: member="hippodraw::StatedFCN::m_fixed_flags" ref="a577ee4bec395e845b448e3632f919c36" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector< int > <a class="el" href="classhippodraw_1_1StatedFCN.html#a577ee4bec395e845b448e3632f919c36">m_fixed_flags</a><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The flags to indicated which parameters are to be held fixed during minimization of this objective function. </p>
<dl class="note"><dt><b>Note:</b></dt><dd>The flags are held as int because it is more space and time efficient for the expected number of parameters. </dd></dl>
<p>Definition at line <a class="el" href="StatedFCN_8h_source.html#l00082">82</a> of file <a class="el" href="StatedFCN_8h_source.html">StatedFCN.h</a>.</p>
<p>Referenced by <a class="el" href="StatedFCN_8cxx_source.html#l00045">StatedFCN::copyFrom()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00166">StatedFCN::fillFreeDerivatives()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00107">StatedFCN::fillFreeParameters()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00134">StatedFCN::getFixedFlags()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00121">StatedFCN::getNumberFreeParms()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00141">StatedFCN::setFixedFlags()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00148">StatedFCN::setFreeParameters()</a>, and <a class="el" href="StatedFCN_8cxx_source.html#l00064">StatedFCN::setFunction()</a>.</p>
</div>
</div>
<a class="anchor" id="a8dc0ee286cf84b5835db9b75cb771cf4"></a><!-- doxytag: member="hippodraw::StatedFCN::m_function" ref="a8dc0ee286cf84b5835db9b75cb771cf4" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classhippodraw_1_1FunctionBase.html">FunctionBase</a>* <a class="el" href="classhippodraw_1_1StatedFCN.html#a8dc0ee286cf84b5835db9b75cb771cf4">m_function</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A pointer to the model function to be used in fitting. </p>
<p>This object does not own the function. </p>
<p>Definition at line <a class="el" href="StatedFCN_8h_source.html#l00089">89</a> of file <a class="el" href="StatedFCN_8h_source.html">StatedFCN.h</a>.</p>
<p>Referenced by <a class="el" href="NTupleFCN_8cxx_source.html#l00194">NTupleFCN::calcAlphaBeta()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00045">StatedFCN::copyFrom()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00166">StatedFCN::fillFreeDerivatives()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00107">StatedFCN::fillFreeParameters()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00093">StatedFCN::getParameters()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00086">StatedFCN::getParmNames()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00054">StatedFCN::hasFunction()</a>, <a class="el" href="NTuplePearsonFCN_8cxx_source.html#l00060">NTuplePearsonFCN::objectiveValue()</a>, <a class="el" href="NTupleLikeliHoodFCN_8cxx_source.html#l00054">NTupleLikeliHoodFCN::objectiveValue()</a>, <a class="el" href="NTupleChiSqFCN_8cxx_source.html#l00061">NTupleChiSqFCN::objectiveValue()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00182">StatedFCN::operator()()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00148">StatedFCN::setFreeParameters()</a>, <a class="el" href="StatedFCN_8cxx_source.html#l00064">StatedFCN::setFunction()</a>, and <a class="el" href="StatedFCN_8cxx_source.html#l00100">StatedFCN::setParameters()</a>.</p>
</div>
</div>
<a class="anchor" id="a7f0fe8c855395f1df4b4162c43e376a1"></a><!-- doxytag: member="hippodraw::StatedFCN::m_needs_derivs" ref="a7f0fe8c855395f1df4b4162c43e376a1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classhippodraw_1_1StatedFCN.html#a7f0fe8c855395f1df4b4162c43e376a1">m_needs_derivs</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Needs derivatives flag. </p>
<p>A flag set to <code>true</code>, if the <a class="el" href="classhippodraw_1_1Fitter.html" title="The base class for fitters.">Fitter</a> needs partial derivatives from the <a class="el" href="classhippodraw_1_1FunctionBase.html" title="A function that can be added to a DataRep and used in a fitter.">FunctionBase</a>. </p>
<p>Definition at line <a class="el" href="StatedFCN_8h_source.html#l00094">94</a> of file <a class="el" href="StatedFCN_8h_source.html">StatedFCN.h</a>.</p>
<p>Referenced by <a class="el" href="StatedFCN_8cxx_source.html#l00198">StatedFCN::isCompatible()</a>, and <a class="el" href="StatedFCN_8cxx_source.html#l00191">StatedFCN::setNeedsDerivatives()</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="StatedFCN_8h_source.html">StatedFCN.h</a></li>
<li><a class="el" href="StatedFCN_8cxx_source.html">StatedFCN.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>
