<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><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_bd46360b4c6a7cd846adf95fa79d46e4.html">python</a>
</div>
</div>
<div class="contents">
<h1>export_Fitter.cxx</h1><a href="export__Fitter_8cxx.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00012"></a>00012 <span class="preprocessor">#ifdef _MSC_VER</span>
<a name="l00013"></a>00013 <span class="preprocessor"></span><span class="comment">// nonstandard extension used 'extern' before...</span>
<a name="l00014"></a>00014 <span class="preprocessor"># pragma warning(disable:4231) </span>
<a name="l00015"></a>00015 <span class="preprocessor"></span>
<a name="l00016"></a>00016 <span class="comment">// needs to have dll-interface used by client</span>
<a name="l00017"></a>00017 <span class="preprocessor"># pragma warning(disable:4251) </span>
<a name="l00018"></a>00018 <span class="preprocessor"></span>
<a name="l00019"></a>00019 <span class="comment">// non dll-interface struct</span>
<a name="l00020"></a>00020 <span class="preprocessor"># pragma warning(disable:4275) </span>
<a name="l00021"></a>00021 <span class="preprocessor"></span>
<a name="l00022"></a>00022 <span class="comment">// 'int' : forcing value to bool 'true' or 'false' (performance warning)</span>
<a name="l00023"></a>00023 <span class="preprocessor"># pragma warning(disable:4800) </span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="comment">// include first to avoid _POSIX_C_SOURCE warning.</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <boost/python.hpp></span>
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="FunctionBase_8h.html" title="hippodraw::FunctionBase class interface">functions/FunctionBase.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="Fitter_8h.html" title="hippodraw::Fitter class interface">minimizers/Fitter.h</a>"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="StatedFCN_8h.html" title="hippodraw::StatedFCN class interface">minimizers/StatedFCN.h</a>"</span>
<a name="l00032"></a>00032
<a name="l00033"></a>00033 <span class="keyword">using</span> std::vector;
<a name="l00034"></a>00034 <span class="keyword">using namespace </span>boost::python;
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="keyword">namespace </span>hippodraw {
<a name="l00037"></a>00037 <span class="keyword">namespace </span>Python {
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="keywordtype">void</span>
<a name="l00040"></a>00040 <a class="code" href="namespacehippodraw_1_1Python.html#a4107ff7b175823f285d32bf02eb6568a" title="Exports the Fitter class to Python.">export_Fitter</a>()
<a name="l00041"></a>00041 {
<a name="l00042"></a>00042 class_ < Fitter, bases<>,
<a name="l00043"></a>00043 Fitter, boost::noncopyable >
<a name="l00044"></a>00044 ( <span class="stringliteral">"Fitter"</span>,
<a name="l00045"></a>00045 <span class="stringliteral">"Provides an interface to objective function minimizers."</span>,
<a name="l00046"></a>00046 no_init )
<a name="l00047"></a>00047
<a name="l00048"></a>00048 .add_property ( <span class="stringliteral">"degreesOfFreedom"</span>,
<a name="l00049"></a>00049 &<a class="code" href="classhippodraw_1_1Fitter.html#abb9b6e0a214042e968b50f9925572d0d" title="Returns the number of degrees of freedom in the fit.">Fitter::calcDegreesOfFreedom</a> )
<a name="l00050"></a>00050
<a name="l00051"></a>00051 .add_property ( <span class="stringliteral">"objectiveValue"</span>,
<a name="l00052"></a>00052 &<a class="code" href="classhippodraw_1_1Fitter.html#a35d807e079d04d56ca61b604d49deae8" title="Calculates the value of the objective function at the current set of parameters.">Fitter::objectiveValue</a> )
<a name="l00053"></a>00053
<a name="l00054"></a>00054 .def ( <span class="stringliteral">"name"</span>, &<a class="code" href="classhippodraw_1_1Fitter.html#af8370604529de0f829b8424e1288a104" title="Returns the name of the fitter.">Fitter::name</a>,
<a name="l00055"></a>00055 return_value_policy < copy_const_reference > (),
<a name="l00056"></a>00056 <span class="stringliteral">"name () -> string\n"</span>
<a name="l00057"></a>00057 <span class="stringliteral">"\n"</span>
<a name="l00058"></a>00058 <span class="stringliteral">"Returns the minimizer name."</span> )
<a name="l00059"></a>00059
<a name="l00060"></a>00060 .def ( <span class="stringliteral">"getFCN"</span>, &<a class="code" href="classhippodraw_1_1Fitter.html#af96a5a267a12c934ce39d73df7003f0d" title="Returns the objective function object.">Fitter::getFCN</a>,
<a name="l00061"></a>00061 return_value_policy < reference_existing_object > (),
<a name="l00062"></a>00062 <span class="stringliteral">"getFCN () -> FCNBase\n"</span>
<a name="l00063"></a>00063 <span class="stringliteral">"\n"</span>
<a name="l00064"></a>00064 <span class="stringliteral">"Returns the objective function."</span> )
<a name="l00065"></a>00065
<a name="l00066"></a>00066 .def ( <span class="stringliteral">"minimize"</span>, &<a class="code" href="classhippodraw_1_1Fitter.html#a6b32cf633d6e11f0c01fe0884adfddc8" title="Calculates the best fit.">Fitter::calcBestFit</a>,
<a name="l00067"></a>00067 <span class="stringliteral">"minimize () -> Boolean\n"</span>
<a name="l00068"></a>00068 <span class="stringliteral">"\n"</span>
<a name="l00069"></a>00069 <span class="stringliteral">"Attempts to do a minimization, returns True if successful."</span> )
<a name="l00070"></a>00070
<a name="l00071"></a>00071 .def ( <span class="stringliteral">"setFixedFlags"</span>, &<a class="code" href="classhippodraw_1_1Fitter.html#ac50591297b951f99124f66a4b9b5e785" title="Sets the parameters that are to be held fixed during objective function minimization...">Fitter::setFixedFlags</a>,
<a name="l00072"></a>00072 <span class="stringliteral">"setFixedFlags ( sequence ) -> None\n"</span>
<a name="l00073"></a>00073 <span class="stringliteral">"\n"</span>
<a name="l00074"></a>00074 <span class="stringliteral">"Sets which parameters that should be fixed during a fit. A\n"</span>
<a name="l00075"></a>00075 <span class="stringliteral">"`1' in the sequence indicates corresponding parameters is fixed."</span> )
<a name="l00076"></a>00076
<a name="l00077"></a>00077 .def ( <span class="stringliteral">"setLimits"</span>,
<a name="l00078"></a>00078 ( <span class="keywordtype">void</span> ( Fitter::* ) <span class="comment">// function pointer cast</span>
<a name="l00079"></a>00079 ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>, <span class="keywordtype">double</span>, <span class="keywordtype">double</span> ) ) <span class="comment">// signature</span>
<a name="l00080"></a>00080 &<a class="code" href="classhippodraw_1_1Fitter.html#a5500ef2b9a787bd77e5f0dbbc0591b5f" title="Sets the limits for the parameter of the model function indexed by i.">Fitter::setLimits</a> )
<a name="l00081"></a>00081
<a name="l00082"></a>00082 .def ( <span class="stringliteral">"setLimits"</span>,
<a name="l00083"></a>00083 ( <span class="keywordtype">void</span> ( Fitter::* ) <span class="comment">// function pointer cast</span>
<a name="l00084"></a>00084 ( <span class="keyword">const</span> std::string &, <span class="keywordtype">double</span>, <span class="keywordtype">double</span> ) ) <span class="comment">// signature</span>
<a name="l00085"></a>00085 &Fitter::setLimits,
<a name="l00086"></a>00086 <span class="stringliteral">"setLimits ( name, low, high ) -> None\n"</span>
<a name="l00087"></a>00087 <span class="stringliteral">"setLimits ( index, low, high ) -> None\n"</span>
<a name="l00088"></a>00088 <span class="stringliteral">"\n"</span>
<a name="l00089"></a>00089 <span class="stringliteral">"Sets the limits on a model function parameter. Only minimizers\n"</span>
<a name="l00090"></a>00090 <span class="stringliteral">"based on Minuit support this feature, others throw an exception."</span> )
<a name="l00091"></a>00091
<a name="l00092"></a>00092 .def ( <span class="stringliteral">"setStepSize"</span>,
<a name="l00093"></a>00093 ( <span class="keywordtype">void</span> ( Fitter::* ) <span class="comment">// function pointer cast</span>
<a name="l00094"></a>00094 ( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>, <span class="keywordtype">double</span> ) ) <span class="comment">// signature</span>
<a name="l00095"></a>00095 &<a class="code" href="classhippodraw_1_1Fitter.html#a1bf21edfa7650b8451f18707b00b210c" title="Sets the step size for parameter of the minimization.">Fitter::setStepSize</a> )
<a name="l00096"></a>00096
<a name="l00097"></a>00097 .def ( <span class="stringliteral">"setStepSize"</span>,
<a name="l00098"></a>00098 ( <span class="keywordtype">void</span> ( Fitter::* ) <span class="comment">// function pointer cast</span>
<a name="l00099"></a>00099 ( <span class="keyword">const</span> std::string &, <span class="keywordtype">double</span> ) ) <span class="comment">// signature</span>
<a name="l00100"></a>00100 &Fitter::setStepSize,
<a name="l00101"></a>00101 <span class="stringliteral">"setStepSize ( name, value ) -> None\n"</span>
<a name="l00102"></a>00102 <span class="stringliteral">"setStepSize ( index, value ) -> None\n"</span>
<a name="l00103"></a>00103 <span class="stringliteral">"\n"</span>
<a name="l00104"></a>00104 <span class="stringliteral">"Sets the step size for the model function parameter. Only\n"</span>
<a name="l00105"></a>00105 <span class="stringliteral">"minimizers based on Minuit support this function, others\n"</span>
<a name="l00106"></a>00106 <span class="stringliteral">"throw an exception."</span> )
<a name="l00107"></a>00107
<a name="l00108"></a>00108 ;
<a name="l00109"></a>00109 }
<a name="l00110"></a>00110
<a name="l00111"></a>00111 } <span class="comment">// namespace Python</span>
<a name="l00112"></a>00112 } <span class="comment">// namespace hippodraw</span>
</pre></div></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>
