Sophie

Sophie

distrib > Fedora > 13 > i386 > by-pkgid > eebc325dc36bd6e3b09b9b45133e42f8 > files > 1752

HippoDraw-devel-docs-1.21.1-10.fc13.i686.rpm

<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&nbsp;Page</span></a></li>
      <li><a href="pages.html"><span>Related&nbsp;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&nbsp;List</span></a></li>
      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="dir_bd46360b4c6a7cd846adf95fa79d46e4.html">python</a>
  </div>
</div>
<div class="contents">
<h1>PyFunctionRep.h</h1><a href="PyFunctionRep_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- mode: c++ -*- */</span>
<a name="l00002"></a>00002 
<a name="l00014"></a>00014 <span class="preprocessor">#ifndef PyFunctionRep_H</span>
<a name="l00015"></a>00015 <span class="preprocessor"></span><span class="preprocessor">#define PyFunctionRep_H</span>
<a name="l00016"></a>00016 <span class="preprocessor"></span>
<a name="l00017"></a>00017 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00018"></a>00018 <span class="preprocessor">#include &lt;vector&gt;</span>
<a name="l00019"></a>00019 
<a name="l00020"></a>00020 <span class="keyword">namespace </span>hippodraw {
<a name="l00021"></a>00021 
<a name="l00022"></a>00022 <span class="keyword">class </span>DataRep;
<a name="l00023"></a>00023 <span class="keyword">class </span>PyDataRep;
<a name="l00024"></a>00024 <span class="keyword">class </span>FunctionRep;
<a name="l00025"></a>00025 <span class="keyword">class </span>FunctionBase;
<a name="l00026"></a>00026 <span class="keyword">class </span>PlotterBase;
<a name="l00027"></a>00027 <span class="keyword">class </span>QtDisplay;
<a name="l00028"></a>00028 
<a name="l00041"></a><a class="code" href="classhippodraw_1_1PyFunctionRep.html">00041</a> <span class="keyword">class </span><a class="code" href="classhippodraw_1_1PyFunctionRep.html" title="This class is the public Python interface wrap for the FunctionRep class.">PyFunctionRep</a>
<a name="l00042"></a>00042 {
<a name="l00043"></a>00043 
<a name="l00044"></a>00044 <span class="keyword">private</span>:
<a name="l00045"></a>00045 
<a name="l00047"></a><a class="code" href="classhippodraw_1_1PyFunctionRep.html#a53b557c7c91073b6504225c238b0a8bf">00047</a>   <a class="code" href="classhippodraw_1_1FunctionRep.html" title="A derived class of DataRep which is a base class for displaying a function.">FunctionRep</a> * <a class="code" href="classhippodraw_1_1PyFunctionRep.html#a53b557c7c91073b6504225c238b0a8bf" title="The wrapped FunctionRep object.">m_rep</a>;
<a name="l00048"></a>00048 
<a name="l00050"></a><a class="code" href="classhippodraw_1_1PyFunctionRep.html#af592292899662dd0b006461b098b620e">00050</a>   <a class="code" href="classhippodraw_1_1PlotterBase.html" title="The base class for the PlotterBase hierarchy.">PlotterBase</a> * <a class="code" href="classhippodraw_1_1PyFunctionRep.html#af592292899662dd0b006461b098b620e" title="The PlotterBase on which the FunctionRep is displayed.">m_target</a>;
<a name="l00051"></a>00051 
<a name="l00052"></a>00052 <span class="keyword">public</span>:
<a name="l00053"></a>00053 
<a name="l00056"></a>00056   <a class="code" href="classhippodraw_1_1PyFunctionRep.html#aed0c550f461744abb43e4960c2fe34ba" title="Constructor taking function name and target DataRep.">PyFunctionRep</a> ( <span class="keyword">const</span> std::string &amp; function_name, <a class="code" href="classhippodraw_1_1PyDataRep.html" title="This class is the public interface the what the user sees as the DataRep object from...">PyDataRep</a> * rep );
<a name="l00057"></a>00057 
<a name="l00060"></a>00060   <a class="code" href="classhippodraw_1_1PyFunctionRep.html#aed0c550f461744abb43e4960c2fe34ba" title="Constructor taking function name and target DataRep.">PyFunctionRep</a> ( <a class="code" href="classhippodraw_1_1FunctionBase.html" title="A function that can be added to a DataRep and used in a fitter.">FunctionBase</a> * function, <a class="code" href="classhippodraw_1_1PyDataRep.html" title="This class is the public interface the what the user sees as the DataRep object from...">PyDataRep</a> * rep );
<a name="l00061"></a>00061 
<a name="l00064"></a>00064   <a class="code" href="classhippodraw_1_1PyFunctionRep.html#aed0c550f461744abb43e4960c2fe34ba" title="Constructor taking function name and target DataRep.">PyFunctionRep</a> ( <a class="code" href="classhippodraw_1_1FunctionBase.html" title="A function that can be added to a DataRep and used in a fitter.">FunctionBase</a> * function );
<a name="l00065"></a>00065 
<a name="l00067"></a>00067   <span class="keywordtype">void</span> <a class="code" href="classhippodraw_1_1PyFunctionRep.html#a328eae92d850302abb4dff0d4a0bb720" title="Adds the function on to the display.">addTo</a> ( <a class="code" href="classhippodraw_1_1QtDisplay.html" title="Qt Displays wraps a derived class of PlotterBase.">QtDisplay</a> * display );
<a name="l00068"></a>00068 
<a name="l00070"></a>00070   <a class="code" href="classhippodraw_1_1DataRep.html" title="The base class for data representations.">hippodraw::DataRep</a> * <a class="code" href="classhippodraw_1_1PyFunctionRep.html#a286267c8e54fefa4a9490a350b8c2f1b" title="Returns the wrapped FunctionRep object.">getRep</a> () <span class="keyword">const</span>;
<a name="l00071"></a>00071 
<a name="l00073"></a>00073   <span class="keyword">const</span> std::vector &lt; std::string &gt; &amp;  <a class="code" href="classhippodraw_1_1PyFunctionRep.html#a1047155d04f6fa2965ab2c46871c3c7e" title="Returns the names of the parameters.">parmNames</a> () <span class="keyword">const</span>;
<a name="l00074"></a>00074 
<a name="l00080"></a>00080   <span class="keyword">const</span> std::vector &lt; double &gt; &amp;  <a class="code" href="classhippodraw_1_1PyFunctionRep.html#a8feaee11443a07a66049bd4fee2a7689" title="Returns the current values of the parameters.">parameters</a> () <span class="keyword">const</span>;
<a name="l00081"></a>00081 
<a name="l00083"></a>00083   <span class="keyword">const</span> std::vector &lt; double &gt; &amp; <a class="code" href="classhippodraw_1_1PyFunctionRep.html#a48e275e03e4a6af662d3f3314a71713c" title="Returns the principle error values associated with the parameters.">principleErrors</a> () <span class="keyword">const</span>;
<a name="l00084"></a>00084   
<a name="l00090"></a>00090   <span class="keywordtype">bool</span> <a class="code" href="classhippodraw_1_1PyFunctionRep.html#a6f3c61b75deee71b8d79fb23471b7587" title="Fits the function to the target DataRep.">fitFunction</a> ();
<a name="l00091"></a>00091 
<a name="l00093"></a>00093    <span class="keywordtype">void</span> <a class="code" href="classhippodraw_1_1PyFunctionRep.html#aa29bd1eeebfc189fafbbab2c7507e81f" title="Set the parameter values.">setParameters</a>( <span class="keyword">const</span> std::vector&lt;double&gt; &amp; params );
<a name="l00094"></a>00094 
<a name="l00097"></a>00097   <span class="keywordtype">double</span> <a class="code" href="classhippodraw_1_1PyFunctionRep.html#a8b01f5831c9306311d6385888986bd70" title="Returns the function value at a given x.">operator () </a>( <span class="keywordtype">double</span> x );
<a name="l00098"></a>00098 
<a name="l00100"></a>00100    <span class="keywordtype">double</span> <a class="code" href="classhippodraw_1_1PyFunctionRep.html#a192d2a91adc9495a4109c494f976ee4d" title="Returns the value of objective value.">objectiveValue</a>();
<a name="l00101"></a>00101 
<a name="l00104"></a>00104   <span class="keyword">const</span> std::vector &lt; std::vector &lt; double &gt; &gt; &amp; <a class="code" href="classhippodraw_1_1PyFunctionRep.html#a37abaa7d5a924547729dba23a873da56" title="Returns the covariance matrix from the last fit.">covarianceMatrix</a> ();
<a name="l00105"></a>00105 
<a name="l00107"></a>00107    <span class="keywordtype">int</span> <a class="code" href="classhippodraw_1_1PyFunctionRep.html#a3ffce635d63149b93f1af03bd3069efe" title="Returns the number of degrees-of-freedom.">degreesOfFreedom</a>();
<a name="l00108"></a>00108 
<a name="l00110"></a>00110    <span class="keywordtype">void</span> <a class="code" href="classhippodraw_1_1PyFunctionRep.html#ac50591297b951f99124f66a4b9b5e785" title="Set the fixed flags of the parameters.">setFixedFlags</a>( <span class="keyword">const</span> std::vector&lt;int&gt; &amp; flags );
<a name="l00111"></a>00111 
<a name="l00114"></a>00114   <span class="keywordtype">void</span> <a class="code" href="classhippodraw_1_1PyFunctionRep.html#a0f7fe92665086c5f11fac3d10a48f01f" title="Sets the Fitter with name in the FitterFactory.">setFitter</a> ( <span class="keyword">const</span> std::string &amp; name );
<a name="l00115"></a>00115 
<a name="l00118"></a>00118   <span class="keyword">const</span> std::string &amp; <a class="code" href="classhippodraw_1_1PyFunctionRep.html#a4531764cca878e5acc503a9224b04a4e" title="Returns the name of the Fitter.">getFitterName</a> () <span class="keyword">const</span>;
<a name="l00119"></a>00119       
<a name="l00123"></a>00123   <a class="code" href="classhippodraw_1_1QtDisplay.html" title="Qt Displays wraps a derived class of PlotterBase.">QtDisplay</a> * <a class="code" href="classhippodraw_1_1PyFunctionRep.html#a35ed354a6459b6f6de4fbba1c91319d8" title="Returns an XY Plot of the residuals between the function and the data.">createResidualsDisplay</a> () <span class="keyword">const</span>;
<a name="l00124"></a>00124 
<a name="l00127"></a>00127   <span class="keywordtype">void</span> <a class="code" href="classhippodraw_1_1PyFunctionRep.html#a769b02c4581ec30a8b124b44655a8084" title="Sets the cut to limit range of fitting.">setFitRange</a> ( <span class="keywordtype">double</span> low, <span class="keywordtype">double</span> high );
<a name="l00128"></a>00128 
<a name="l00131"></a>00131   <span class="keywordtype">void</span> <a class="code" href="classhippodraw_1_1PyFunctionRep.html#ac408548db077607ec83a61902cf19d80" title="Sets use of a fitting range on or off.">setFitRangeEnabled</a> ( <span class="keywordtype">bool</span> yes = <span class="keyword">true</span> );
<a name="l00132"></a>00132 
<a name="l00133"></a>00133 };
<a name="l00134"></a>00134 
<a name="l00135"></a>00135 } <span class="comment">// namespace hippodraw</span>
<a name="l00136"></a>00136 
<a name="l00137"></a>00137 <span class="preprocessor">#endif // PyFunctionRep_H</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>