Du kannst nicht mehr als 25 Themen auswählen Themen müssen entweder mit einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.
 
 
 
 

627 Zeilen
36 KiB

  1. <!DOCTYPE html><html lang="en">
  2. <head>
  3. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  4. <meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
  5. <meta charset="utf-8">
  6. <title>PHPExcel classes » \PHPExcel_Best_Fit</title>
  7. <meta name="author" content="Mike van Riel">
  8. <meta name="description" content="">
  9. <link href="../css/template.css" rel="stylesheet" media="all">
  10. <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
  11. <link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
  12. <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
  13. <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
  14. </head>
  15. <body>
  16. <div class="navbar navbar-fixed-top">
  17. <div class="navbar-inner"><div class="container">
  18. <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">PHPExcel classes</a><div class="nav-collapse"><ul class="nav">
  19. <li class="dropdown">
  20. <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
  21. API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
  22. <li><a>Packages</a></li>
  23. <li><a href="../packages/Default.html"><i class="icon-folder-open"></i> Default</a></li>
  24. <li><a href="../packages/JAMA.html"><i class="icon-folder-open"></i> JAMA</a></li>
  25. <li><a href="../packages/JAMA%0D%0ACholesky%20decomposition%20class%0D%0AFor%20a%20symmetric,%20positive%20definite%20matrix%20A,%20the%20Cholesky%20decomposition%0D%0Ais%20an%20lower%20triangular%20matrix%20L%20so%20that%20A%20=%20L*L'.html"><i class="icon-folder-open"></i> JAMA
  26. Cholesky decomposition class
  27. For a symmetric, positive definite matrix A, the Cholesky decomposition
  28. is an lower triangular matrix L so that A = L*L'</a></li>
  29. <li><a href="../packages/JAMA%0D%0AClass%20to%20obtain%20eigenvalues%20and%20eigenvectors%20of%20a%20real%20matrix.html"><i class="icon-folder-open"></i> JAMA
  30. Class to obtain eigenvalues and eigenvectors of a real matrix</a></li>
  31. <li><a href="../packages/JAMA%0D%0AError%20handling.html"><i class="icon-folder-open"></i> JAMA
  32. Error handling</a></li>
  33. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20LU%20decomposition%20is%20an%20m-by-n%0D%0Aunit%20lower%20triangular%20matrix%20L,%20an%20n-by-n%20upper%20triangular%20matrix%20U,%0D%0Aand%20a%20permutation%20vector%20piv%20of%20length%20m%20so%20that%20A(piv,:)%20=%20L*U.html"><i class="icon-folder-open"></i> JAMA
  34. For an m-by-n matrix A with m &gt;= n, the LU decomposition is an m-by-n
  35. unit lower triangular matrix L, an n-by-n upper triangular matrix U,
  36. and a permutation vector piv of length m so that A(piv,:) = L*U</a></li>
  37. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20QR%20decomposition%20is%20an%20m-by-n%0D%0Aorthogonal%20matrix%20Q%20and%20an%20n-by-n%20upper%20triangular%20matrix%20R%20so%20that%0D%0AA%20=%20Q*R.html"><i class="icon-folder-open"></i> JAMA
  38. For an m-by-n matrix A with m &gt;= n, the QR decomposition is an m-by-n
  39. orthogonal matrix Q and an n-by-n upper triangular matrix R so that
  40. A = Q*R</a></li>
  41. <li><a href="../packages/JAMA%0D%0AFor%20an%20m-by-n%20matrix%20A%20with%20m%20&gt;=%20n,%20the%20singular%20value%20decomposition%20is%0D%0Aan%20m-by-n%20orthogonal%20matrix%20U,%20an%20n-by-n%20diagonal%20matrix%20S,%20and%0D%0Aan%20n-by-n%20orthogonal%20matrix%20V%20so%20that%20A%20=%20U*S*V'.html"><i class="icon-folder-open"></i> JAMA
  42. For an m-by-n matrix A with m &gt;= n, the singular value decomposition is
  43. an m-by-n orthogonal matrix U, an n-by-n diagonal matrix S, and
  44. an n-by-n orthogonal matrix V so that A = U*S*V'</a></li>
  45. <li><a href="../packages/JAMA%0D%0APythagorean%20Theorem:%0D%0Aa%20=%203%0D%0Ab%20=%204%0D%0Ar%20=%20sqrt(square(a)%20+%20square(b))%0D%0Ar%20=%205%0D%0Ar%20=%20sqrt(a%5E2%20+%20b%5E2)%20without%20under.overflow.html"><i class="icon-folder-open"></i> JAMA
  46. Pythagorean Theorem:
  47. a = 3
  48. b = 4
  49. r = sqrt(square(a) + square(b))
  50. r = 5
  51. r = sqrt(a^2 + b^2) without under/overflow</a></li>
  52. <li><a href="../packages/PHPExcel.html"><i class="icon-folder-open"></i> PHPExcel</a></li>
  53. </ul>
  54. </li>
  55. <li class="dropdown" id="charts-menu">
  56. <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
  57. Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
  58. </li>
  59. <li class="dropdown" id="reports-menu">
  60. <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
  61. Reports <b class="caret"></b></a><ul class="dropdown-menu">
  62. <li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
  63. <span class="label label-info">551</span></a></li>
  64. <li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
  65. <ul>
  66. <li>todo 
  67. <span class="label label-info">19</span>
  68. </li>
  69. <li>fixme 
  70. <span class="label label-info">10</span>
  71. </li>
  72. </ul></a></li>
  73. <li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
  74. <span class="label label-info">12</span></a></li>
  75. </ul>
  76. </li>
  77. </ul></div>
  78. </div></div>
  79. <div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
  80. </div>
  81. <div id="___" class="container">
  82. <noscript><div class="alert alert-warning">
  83. Javascript is disabled; several features are only available
  84. if Javascript is enabled.
  85. </div></noscript>
  86. <div class="row">
  87. <div class="span4">
  88. <span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
  89. <button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
  90. </div>
  91. <ul class="side-nav nav nav-list">
  92. <li class="nav-header">
  93. <i class="icon-custom icon-method"></i> Methods
  94. <ul>
  95. <li class="method public "><a href="#method___construct" title="__construct :: Define the regression"><span class="description">Define the regression</span><pre>__construct()</pre></a></li>
  96. <li class="method public "><a href="#method_getBestFitType" title="getBestFitType :: "><span class="description">getBestFitType()
  97. </span><pre>getBestFitType()</pre></a></li>
  98. <li class="method public "><a href="#method_getCorrelation" title="getCorrelation :: "><span class="description">getCorrelation()
  99. </span><pre>getCorrelation()</pre></a></li>
  100. <li class="method public "><a href="#method_getCovariance" title="getCovariance :: "><span class="description">getCovariance()
  101. </span><pre>getCovariance()</pre></a></li>
  102. <li class="method public "><a href="#method_getDFResiduals" title="getDFResiduals :: "><span class="description">getDFResiduals()
  103. </span><pre>getDFResiduals()</pre></a></li>
  104. <li class="method public "><a href="#method_getEquation" title="getEquation :: Return the Equation of the best-fit line"><span class="description">Return the Equation of the best-fit line</span><pre>getEquation()</pre></a></li>
  105. <li class="method public "><a href="#method_getError" title="getError :: "><span class="description">getError()
  106. </span><pre>getError()</pre></a></li>
  107. <li class="method public "><a href="#method_getF" title="getF :: "><span class="description">getF()
  108. </span><pre>getF()</pre></a></li>
  109. <li class="method public "><a href="#method_getGoodnessOfFit" title="getGoodnessOfFit :: Return the goodness of fit for this regression"><span class="description">Return the goodness of fit for this regression</span><pre>getGoodnessOfFit()</pre></a></li>
  110. <li class="method public "><a href="#method_getGoodnessOfFitPercent" title="getGoodnessOfFitPercent :: "><span class="description">getGoodnessOfFitPercent()
  111. </span><pre>getGoodnessOfFitPercent()</pre></a></li>
  112. <li class="method public "><a href="#method_getIntersect" title="getIntersect :: Return the Value of X where it intersects Y = 0"><span class="description">Return the Value of X where it intersects Y = 0</span><pre>getIntersect()</pre></a></li>
  113. <li class="method public "><a href="#method_getIntersectSE" title="getIntersectSE :: Return the standard error of the Intersect"><span class="description">Return the standard error of the Intersect</span><pre>getIntersectSE()</pre></a></li>
  114. <li class="method public "><a href="#method_getSSRegression" title="getSSRegression :: "><span class="description">getSSRegression()
  115. </span><pre>getSSRegression()</pre></a></li>
  116. <li class="method public "><a href="#method_getSSResiduals" title="getSSResiduals :: "><span class="description">getSSResiduals()
  117. </span><pre>getSSResiduals()</pre></a></li>
  118. <li class="method public "><a href="#method_getSlope" title="getSlope :: Return the Slope of the line"><span class="description">Return the Slope of the line</span><pre>getSlope()</pre></a></li>
  119. <li class="method public "><a href="#method_getSlopeSE" title="getSlopeSE :: Return the standard error of the Slope"><span class="description">Return the standard error of the Slope</span><pre>getSlopeSE()</pre></a></li>
  120. <li class="method public "><a href="#method_getStdevOfResiduals" title="getStdevOfResiduals :: Return the standard deviation of the residuals for this regression"><span class="description">Return the standard deviation of the residuals for this regression</span><pre>getStdevOfResiduals()</pre></a></li>
  121. <li class="method public "><a href="#method_getValueOfXForY" title="getValueOfXForY :: Return the X-Value for a specified value of Y"><span class="description">Return the X-Value for a specified value of Y</span><pre>getValueOfXForY()</pre></a></li>
  122. <li class="method public "><a href="#method_getValueOfYForX" title="getValueOfYForX :: Return the Y-Value for a specified value of X"><span class="description">Return the Y-Value for a specified value of X</span><pre>getValueOfYForX()</pre></a></li>
  123. <li class="method public "><a href="#method_getXValues" title="getXValues :: Return the original set of X-Values"><span class="description">Return the original set of X-Values</span><pre>getXValues()</pre></a></li>
  124. <li class="method public "><a href="#method_getYBestFitValues" title="getYBestFitValues :: "><span class="description">getYBestFitValues()
  125. </span><pre>getYBestFitValues()</pre></a></li>
  126. </ul>
  127. </li>
  128. <li class="nav-header protected">» Protected
  129. <ul>
  130. <li class="method protected "><a href="#method__calculateGoodnessOfFit" title="_calculateGoodnessOfFit :: "><span class="description">_calculateGoodnessOfFit()
  131. </span><pre>_calculateGoodnessOfFit()</pre></a></li>
  132. <li class="method protected "><a href="#method__leastSquareFit" title="_leastSquareFit :: "><span class="description">_leastSquareFit()
  133. </span><pre>_leastSquareFit()</pre></a></li>
  134. </ul>
  135. </li>
  136. <li class="nav-header">
  137. <i class="icon-custom icon-property"></i> Properties
  138. <ul></ul>
  139. </li>
  140. <li class="nav-header protected">» Protected
  141. <ul>
  142. <li class="property protected "><a href="#property__DFResiduals" title="$_DFResiduals :: "><span class="description"></span><pre>$_DFResiduals</pre></a></li>
  143. <li class="property protected "><a href="#property__F" title="$_F :: "><span class="description"></span><pre>$_F</pre></a></li>
  144. <li class="property protected "><a href="#property__SSRegression" title="$_SSRegression :: "><span class="description"></span><pre>$_SSRegression</pre></a></li>
  145. <li class="property protected "><a href="#property__SSResiduals" title="$_SSResiduals :: "><span class="description"></span><pre>$_SSResiduals</pre></a></li>
  146. <li class="property protected "><a href="#property__Xoffset" title="$_Xoffset :: "><span class="description"></span><pre>$_Xoffset</pre></a></li>
  147. <li class="property protected "><a href="#property__Yoffset" title="$_Yoffset :: "><span class="description"></span><pre>$_Yoffset</pre></a></li>
  148. <li class="property protected "><a href="#property__adjustToZero" title="$_adjustToZero :: Flag indicating whether values should be adjusted to Y=0"><span class="description"></span><pre>$_adjustToZero</pre></a></li>
  149. <li class="property protected "><a href="#property__bestFitType" title="$_bestFitType :: Algorithm type to use for best-fit"><span class="description"></span><pre>$_bestFitType</pre></a></li>
  150. <li class="property protected "><a href="#property__correlation" title="$_correlation :: "><span class="description"></span><pre>$_correlation</pre></a></li>
  151. <li class="property protected "><a href="#property__covariance" title="$_covariance :: "><span class="description"></span><pre>$_covariance</pre></a></li>
  152. <li class="property protected "><a href="#property__error" title="$_error :: Indicator flag for a calculation error"><span class="description"></span><pre>$_error</pre></a></li>
  153. <li class="property protected "><a href="#property__goodnessOfFit" title="$_goodnessOfFit :: "><span class="description"></span><pre>$_goodnessOfFit</pre></a></li>
  154. <li class="property protected "><a href="#property__intersect" title="$_intersect :: "><span class="description"></span><pre>$_intersect</pre></a></li>
  155. <li class="property protected "><a href="#property__intersectSE" title="$_intersectSE :: "><span class="description"></span><pre>$_intersectSE</pre></a></li>
  156. <li class="property protected "><a href="#property__slope" title="$_slope :: "><span class="description"></span><pre>$_slope</pre></a></li>
  157. <li class="property protected "><a href="#property__slopeSE" title="$_slopeSE :: "><span class="description"></span><pre>$_slopeSE</pre></a></li>
  158. <li class="property protected "><a href="#property__stdevOfResiduals" title="$_stdevOfResiduals :: "><span class="description"></span><pre>$_stdevOfResiduals</pre></a></li>
  159. <li class="property protected "><a href="#property__valueCount" title="$_valueCount :: Number of entries in the sets of x- and y-value arrays"><span class="description"></span><pre>$_valueCount</pre></a></li>
  160. <li class="property protected "><a href="#property__xValues" title="$_xValues :: X-value dataseries of values"><span class="description"></span><pre>$_xValues</pre></a></li>
  161. <li class="property protected "><a href="#property__yBestFitValues" title="$_yBestFitValues :: Y-value series of best-fit values"><span class="description"></span><pre>$_yBestFitValues</pre></a></li>
  162. <li class="property protected "><a href="#property__yValues" title="$_yValues :: Y-value dataseries of values"><span class="description"></span><pre>$_yValues</pre></a></li>
  163. </ul>
  164. </li>
  165. </ul>
  166. </div>
  167. <div class="span8">
  168. <a id="\PHPExcel_Best_Fit"></a><ul class="breadcrumb">
  169. <li>
  170. <a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
  171. </li>
  172. <li><a href="../namespaces/global.html">global</a></li>
  173. <li class="active">
  174. <span class="divider">\</span><a href="../classes/PHPExcel_Best_Fit.html">PHPExcel_Best_Fit</a>
  175. </li>
  176. </ul>
  177. <div class="element class">
  178. <p class="short_description">PHPExcel_Best_Fit</p>
  179. <div class="details">
  180. <div class="long_description"></div>
  181. <table class="table table-bordered">
  182. <tr>
  183. <th>category</th>
  184. <td>PHPExcel</td>
  185. </tr>
  186. <tr>
  187. <th>package</th>
  188. <td><a href="../packages/PHPExcel.Shared.Trend.html">PHPExcel_Shared_Trend</a></td>
  189. </tr>
  190. <tr>
  191. <th>copyright</th>
  192. <td>Copyright (c) 2006 - 2014 PHPExcel (http://www.codeplex.com/PHPExcel)</td>
  193. </tr>
  194. </table>
  195. <h3>
  196. <i class="icon-custom icon-method"></i> Methods</h3>
  197. <a id="method___construct"></a><div class="element clickable method public method___construct" data-toggle="collapse" data-target=".method___construct .collapse">
  198. <h2>Define the regression</h2>
  199. <pre>__construct(float[] $yValues, float[] $xValues, boolean $const) </pre>
  200. <div class="labels"></div>
  201. <div class="row collapse"><div class="detail-description">
  202. <div class="long_description"></div>
  203. <h3>Parameters</h3>
  204. <div class="subelement argument">
  205. <h4>$yValues</h4>
  206. <code>float[]</code><p>The set of Y-values for this regression</p>
  207. </div>
  208. <div class="subelement argument">
  209. <h4>$xValues</h4>
  210. <code>float[]</code><p>The set of X-values for this regression</p>
  211. </div>
  212. <div class="subelement argument">
  213. <h4>$const</h4>
  214. <code>boolean</code>
  215. </div>
  216. </div></div>
  217. </div>
  218. <a id="method_getBestFitType"></a><div class="element clickable method public method_getBestFitType" data-toggle="collapse" data-target=".method_getBestFitType .collapse">
  219. <h2>getBestFitType()
  220. </h2>
  221. <pre>getBestFitType() </pre>
  222. <div class="labels"></div>
  223. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  224. </div>
  225. <a id="method_getCorrelation"></a><div class="element clickable method public method_getCorrelation" data-toggle="collapse" data-target=".method_getCorrelation .collapse">
  226. <h2>getCorrelation()
  227. </h2>
  228. <pre>getCorrelation($dp) </pre>
  229. <div class="labels"></div>
  230. <div class="row collapse"><div class="detail-description">
  231. <div class="long_description"></div>
  232. <h3>Parameters</h3>
  233. <div class="subelement argument"><h4>$dp</h4></div>
  234. </div></div>
  235. </div>
  236. <a id="method_getCovariance"></a><div class="element clickable method public method_getCovariance" data-toggle="collapse" data-target=".method_getCovariance .collapse">
  237. <h2>getCovariance()
  238. </h2>
  239. <pre>getCovariance($dp) </pre>
  240. <div class="labels"></div>
  241. <div class="row collapse"><div class="detail-description">
  242. <div class="long_description"></div>
  243. <h3>Parameters</h3>
  244. <div class="subelement argument"><h4>$dp</h4></div>
  245. </div></div>
  246. </div>
  247. <a id="method_getDFResiduals"></a><div class="element clickable method public method_getDFResiduals" data-toggle="collapse" data-target=".method_getDFResiduals .collapse">
  248. <h2>getDFResiduals()
  249. </h2>
  250. <pre>getDFResiduals($dp) </pre>
  251. <div class="labels"></div>
  252. <div class="row collapse"><div class="detail-description">
  253. <div class="long_description"></div>
  254. <h3>Parameters</h3>
  255. <div class="subelement argument"><h4>$dp</h4></div>
  256. </div></div>
  257. </div>
  258. <a id="method_getEquation"></a><div class="element clickable method public method_getEquation" data-toggle="collapse" data-target=".method_getEquation .collapse">
  259. <h2>Return the Equation of the best-fit line</h2>
  260. <pre>getEquation(int $dp) : string</pre>
  261. <div class="labels"></div>
  262. <div class="row collapse"><div class="detail-description">
  263. <div class="long_description"></div>
  264. <h3>Parameters</h3>
  265. <div class="subelement argument">
  266. <h4>$dp</h4>
  267. <code>int</code><p>Number of places of decimal precision to display</p></div>
  268. <h3>Returns</h3>
  269. <div class="subelement response"><code>string</code></div>
  270. </div></div>
  271. </div>
  272. <a id="method_getError"></a><div class="element clickable method public method_getError" data-toggle="collapse" data-target=".method_getError .collapse">
  273. <h2>getError()
  274. </h2>
  275. <pre>getError() </pre>
  276. <div class="labels"></div>
  277. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  278. </div>
  279. <a id="method_getF"></a><div class="element clickable method public method_getF" data-toggle="collapse" data-target=".method_getF .collapse">
  280. <h2>getF()
  281. </h2>
  282. <pre>getF($dp) </pre>
  283. <div class="labels"></div>
  284. <div class="row collapse"><div class="detail-description">
  285. <div class="long_description"></div>
  286. <h3>Parameters</h3>
  287. <div class="subelement argument"><h4>$dp</h4></div>
  288. </div></div>
  289. </div>
  290. <a id="method_getGoodnessOfFit"></a><div class="element clickable method public method_getGoodnessOfFit" data-toggle="collapse" data-target=".method_getGoodnessOfFit .collapse">
  291. <h2>Return the goodness of fit for this regression</h2>
  292. <pre>getGoodnessOfFit(int $dp) : float</pre>
  293. <div class="labels"></div>
  294. <div class="row collapse"><div class="detail-description">
  295. <div class="long_description"></div>
  296. <h3>Parameters</h3>
  297. <div class="subelement argument">
  298. <h4>$dp</h4>
  299. <code>int</code><p>Number of places of decimal precision to return</p></div>
  300. <h3>Returns</h3>
  301. <div class="subelement response"><code>float</code></div>
  302. </div></div>
  303. </div>
  304. <a id="method_getGoodnessOfFitPercent"></a><div class="element clickable method public method_getGoodnessOfFitPercent" data-toggle="collapse" data-target=".method_getGoodnessOfFitPercent .collapse">
  305. <h2>getGoodnessOfFitPercent()
  306. </h2>
  307. <pre>getGoodnessOfFitPercent($dp) </pre>
  308. <div class="labels"></div>
  309. <div class="row collapse"><div class="detail-description">
  310. <div class="long_description"></div>
  311. <h3>Parameters</h3>
  312. <div class="subelement argument"><h4>$dp</h4></div>
  313. </div></div>
  314. </div>
  315. <a id="method_getIntersect"></a><div class="element clickable method public method_getIntersect" data-toggle="collapse" data-target=".method_getIntersect .collapse">
  316. <h2>Return the Value of X where it intersects Y = 0</h2>
  317. <pre>getIntersect(int $dp) : string</pre>
  318. <div class="labels"></div>
  319. <div class="row collapse"><div class="detail-description">
  320. <div class="long_description"></div>
  321. <h3>Parameters</h3>
  322. <div class="subelement argument">
  323. <h4>$dp</h4>
  324. <code>int</code><p>Number of places of decimal precision to display</p></div>
  325. <h3>Returns</h3>
  326. <div class="subelement response"><code>string</code></div>
  327. </div></div>
  328. </div>
  329. <a id="method_getIntersectSE"></a><div class="element clickable method public method_getIntersectSE" data-toggle="collapse" data-target=".method_getIntersectSE .collapse">
  330. <h2>Return the standard error of the Intersect</h2>
  331. <pre>getIntersectSE(int $dp) : string</pre>
  332. <div class="labels"></div>
  333. <div class="row collapse"><div class="detail-description">
  334. <div class="long_description"></div>
  335. <h3>Parameters</h3>
  336. <div class="subelement argument">
  337. <h4>$dp</h4>
  338. <code>int</code><p>Number of places of decimal precision to display</p></div>
  339. <h3>Returns</h3>
  340. <div class="subelement response"><code>string</code></div>
  341. </div></div>
  342. </div>
  343. <a id="method_getSSRegression"></a><div class="element clickable method public method_getSSRegression" data-toggle="collapse" data-target=".method_getSSRegression .collapse">
  344. <h2>getSSRegression()
  345. </h2>
  346. <pre>getSSRegression($dp) </pre>
  347. <div class="labels"></div>
  348. <div class="row collapse"><div class="detail-description">
  349. <div class="long_description"></div>
  350. <h3>Parameters</h3>
  351. <div class="subelement argument"><h4>$dp</h4></div>
  352. </div></div>
  353. </div>
  354. <a id="method_getSSResiduals"></a><div class="element clickable method public method_getSSResiduals" data-toggle="collapse" data-target=".method_getSSResiduals .collapse">
  355. <h2>getSSResiduals()
  356. </h2>
  357. <pre>getSSResiduals($dp) </pre>
  358. <div class="labels"></div>
  359. <div class="row collapse"><div class="detail-description">
  360. <div class="long_description"></div>
  361. <h3>Parameters</h3>
  362. <div class="subelement argument"><h4>$dp</h4></div>
  363. </div></div>
  364. </div>
  365. <a id="method_getSlope"></a><div class="element clickable method public method_getSlope" data-toggle="collapse" data-target=".method_getSlope .collapse">
  366. <h2>Return the Slope of the line</h2>
  367. <pre>getSlope(int $dp) : string</pre>
  368. <div class="labels"></div>
  369. <div class="row collapse"><div class="detail-description">
  370. <div class="long_description"></div>
  371. <h3>Parameters</h3>
  372. <div class="subelement argument">
  373. <h4>$dp</h4>
  374. <code>int</code><p>Number of places of decimal precision to display</p></div>
  375. <h3>Returns</h3>
  376. <div class="subelement response"><code>string</code></div>
  377. </div></div>
  378. </div>
  379. <a id="method_getSlopeSE"></a><div class="element clickable method public method_getSlopeSE" data-toggle="collapse" data-target=".method_getSlopeSE .collapse">
  380. <h2>Return the standard error of the Slope</h2>
  381. <pre>getSlopeSE(int $dp) : string</pre>
  382. <div class="labels"></div>
  383. <div class="row collapse"><div class="detail-description">
  384. <div class="long_description"></div>
  385. <h3>Parameters</h3>
  386. <div class="subelement argument">
  387. <h4>$dp</h4>
  388. <code>int</code><p>Number of places of decimal precision to display</p></div>
  389. <h3>Returns</h3>
  390. <div class="subelement response"><code>string</code></div>
  391. </div></div>
  392. </div>
  393. <a id="method_getStdevOfResiduals"></a><div class="element clickable method public method_getStdevOfResiduals" data-toggle="collapse" data-target=".method_getStdevOfResiduals .collapse">
  394. <h2>Return the standard deviation of the residuals for this regression</h2>
  395. <pre>getStdevOfResiduals(int $dp) : float</pre>
  396. <div class="labels"></div>
  397. <div class="row collapse"><div class="detail-description">
  398. <div class="long_description"></div>
  399. <h3>Parameters</h3>
  400. <div class="subelement argument">
  401. <h4>$dp</h4>
  402. <code>int</code><p>Number of places of decimal precision to return</p></div>
  403. <h3>Returns</h3>
  404. <div class="subelement response"><code>float</code></div>
  405. </div></div>
  406. </div>
  407. <a id="method_getValueOfXForY"></a><div class="element clickable method public method_getValueOfXForY" data-toggle="collapse" data-target=".method_getValueOfXForY .collapse">
  408. <h2>Return the X-Value for a specified value of Y</h2>
  409. <pre>getValueOfXForY(float $yValue) : float</pre>
  410. <div class="labels"></div>
  411. <div class="row collapse"><div class="detail-description">
  412. <div class="long_description"></div>
  413. <h3>Parameters</h3>
  414. <div class="subelement argument">
  415. <h4>$yValue</h4>
  416. <code>float</code><p>Y-Value</p>
  417. </div>
  418. <h3>Returns</h3>
  419. <div class="subelement response">
  420. <code>float</code>X-Value</div>
  421. </div></div>
  422. </div>
  423. <a id="method_getValueOfYForX"></a><div class="element clickable method public method_getValueOfYForX" data-toggle="collapse" data-target=".method_getValueOfYForX .collapse">
  424. <h2>Return the Y-Value for a specified value of X</h2>
  425. <pre>getValueOfYForX(float $xValue) : float</pre>
  426. <div class="labels"></div>
  427. <div class="row collapse"><div class="detail-description">
  428. <div class="long_description"></div>
  429. <h3>Parameters</h3>
  430. <div class="subelement argument">
  431. <h4>$xValue</h4>
  432. <code>float</code><p>X-Value</p>
  433. </div>
  434. <h3>Returns</h3>
  435. <div class="subelement response">
  436. <code>float</code>Y-Value</div>
  437. </div></div>
  438. </div>
  439. <a id="method_getXValues"></a><div class="element clickable method public method_getXValues" data-toggle="collapse" data-target=".method_getXValues .collapse">
  440. <h2>Return the original set of X-Values</h2>
  441. <pre>getXValues() : float[]</pre>
  442. <div class="labels"></div>
  443. <div class="row collapse"><div class="detail-description">
  444. <div class="long_description"></div>
  445. <h3>Returns</h3>
  446. <div class="subelement response">
  447. <code>float[]</code>X-Values</div>
  448. </div></div>
  449. </div>
  450. <a id="method_getYBestFitValues"></a><div class="element clickable method public method_getYBestFitValues" data-toggle="collapse" data-target=".method_getYBestFitValues .collapse">
  451. <h2>getYBestFitValues()
  452. </h2>
  453. <pre>getYBestFitValues() </pre>
  454. <div class="labels"></div>
  455. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  456. </div>
  457. <a id="method__calculateGoodnessOfFit"></a><div class="element clickable method protected method__calculateGoodnessOfFit" data-toggle="collapse" data-target=".method__calculateGoodnessOfFit .collapse">
  458. <h2>_calculateGoodnessOfFit()
  459. </h2>
  460. <pre>_calculateGoodnessOfFit($sumX, $sumY, $sumX2, $sumY2, $sumXY, $meanX, $meanY, $const) </pre>
  461. <div class="labels"></div>
  462. <div class="row collapse"><div class="detail-description">
  463. <div class="long_description"></div>
  464. <h3>Parameters</h3>
  465. <div class="subelement argument"><h4>$sumX</h4></div>
  466. <div class="subelement argument"><h4>$sumY</h4></div>
  467. <div class="subelement argument"><h4>$sumX2</h4></div>
  468. <div class="subelement argument"><h4>$sumY2</h4></div>
  469. <div class="subelement argument"><h4>$sumXY</h4></div>
  470. <div class="subelement argument"><h4>$meanX</h4></div>
  471. <div class="subelement argument"><h4>$meanY</h4></div>
  472. <div class="subelement argument"><h4>$const</h4></div>
  473. </div></div>
  474. </div>
  475. <a id="method__leastSquareFit"></a><div class="element clickable method protected method__leastSquareFit" data-toggle="collapse" data-target=".method__leastSquareFit .collapse">
  476. <h2>_leastSquareFit()
  477. </h2>
  478. <pre>_leastSquareFit($yValues, $xValues, $const) </pre>
  479. <div class="labels"></div>
  480. <div class="row collapse"><div class="detail-description">
  481. <div class="long_description"></div>
  482. <h3>Parameters</h3>
  483. <div class="subelement argument"><h4>$yValues</h4></div>
  484. <div class="subelement argument"><h4>$xValues</h4></div>
  485. <div class="subelement argument"><h4>$const</h4></div>
  486. </div></div>
  487. </div>
  488. <h3>
  489. <i class="icon-custom icon-property"></i> Properties</h3>
  490. <a id="property__DFResiduals"> </a><div class="element clickable property protected property__DFResiduals" data-toggle="collapse" data-target=".property__DFResiduals .collapse">
  491. <h2></h2>
  492. <pre>$_DFResiduals </pre>
  493. <div class="labels"></div>
  494. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  495. </div>
  496. <a id="property__F"> </a><div class="element clickable property protected property__F" data-toggle="collapse" data-target=".property__F .collapse">
  497. <h2></h2>
  498. <pre>$_F </pre>
  499. <div class="labels"></div>
  500. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  501. </div>
  502. <a id="property__SSRegression"> </a><div class="element clickable property protected property__SSRegression" data-toggle="collapse" data-target=".property__SSRegression .collapse">
  503. <h2></h2>
  504. <pre>$_SSRegression </pre>
  505. <div class="labels"></div>
  506. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  507. </div>
  508. <a id="property__SSResiduals"> </a><div class="element clickable property protected property__SSResiduals" data-toggle="collapse" data-target=".property__SSResiduals .collapse">
  509. <h2></h2>
  510. <pre>$_SSResiduals </pre>
  511. <div class="labels"></div>
  512. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  513. </div>
  514. <a id="property__Xoffset"> </a><div class="element clickable property protected property__Xoffset" data-toggle="collapse" data-target=".property__Xoffset .collapse">
  515. <h2></h2>
  516. <pre>$_Xoffset </pre>
  517. <div class="labels"></div>
  518. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  519. </div>
  520. <a id="property__Yoffset"> </a><div class="element clickable property protected property__Yoffset" data-toggle="collapse" data-target=".property__Yoffset .collapse">
  521. <h2></h2>
  522. <pre>$_Yoffset </pre>
  523. <div class="labels"></div>
  524. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  525. </div>
  526. <a id="property__adjustToZero"> </a><div class="element clickable property protected property__adjustToZero" data-toggle="collapse" data-target=".property__adjustToZero .collapse">
  527. <h2></h2>
  528. <pre>$_adjustToZero : boolean</pre>
  529. <div class="labels"></div>
  530. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  531. </div>
  532. <a id="property__bestFitType"> </a><div class="element clickable property protected property__bestFitType" data-toggle="collapse" data-target=".property__bestFitType .collapse">
  533. <h2></h2>
  534. <pre>$_bestFitType : string</pre>
  535. <div class="labels"></div>
  536. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  537. </div>
  538. <a id="property__correlation"> </a><div class="element clickable property protected property__correlation" data-toggle="collapse" data-target=".property__correlation .collapse">
  539. <h2></h2>
  540. <pre>$_correlation </pre>
  541. <div class="labels"></div>
  542. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  543. </div>
  544. <a id="property__covariance"> </a><div class="element clickable property protected property__covariance" data-toggle="collapse" data-target=".property__covariance .collapse">
  545. <h2></h2>
  546. <pre>$_covariance </pre>
  547. <div class="labels"></div>
  548. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  549. </div>
  550. <a id="property__error"> </a><div class="element clickable property protected property__error" data-toggle="collapse" data-target=".property__error .collapse">
  551. <h2></h2>
  552. <pre>$_error : boolean</pre>
  553. <div class="labels"></div>
  554. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  555. </div>
  556. <a id="property__goodnessOfFit"> </a><div class="element clickable property protected property__goodnessOfFit" data-toggle="collapse" data-target=".property__goodnessOfFit .collapse">
  557. <h2></h2>
  558. <pre>$_goodnessOfFit </pre>
  559. <div class="labels"></div>
  560. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  561. </div>
  562. <a id="property__intersect"> </a><div class="element clickable property protected property__intersect" data-toggle="collapse" data-target=".property__intersect .collapse">
  563. <h2></h2>
  564. <pre>$_intersect </pre>
  565. <div class="labels"></div>
  566. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  567. </div>
  568. <a id="property__intersectSE"> </a><div class="element clickable property protected property__intersectSE" data-toggle="collapse" data-target=".property__intersectSE .collapse">
  569. <h2></h2>
  570. <pre>$_intersectSE </pre>
  571. <div class="labels"></div>
  572. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  573. </div>
  574. <a id="property__slope"> </a><div class="element clickable property protected property__slope" data-toggle="collapse" data-target=".property__slope .collapse">
  575. <h2></h2>
  576. <pre>$_slope </pre>
  577. <div class="labels"></div>
  578. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  579. </div>
  580. <a id="property__slopeSE"> </a><div class="element clickable property protected property__slopeSE" data-toggle="collapse" data-target=".property__slopeSE .collapse">
  581. <h2></h2>
  582. <pre>$_slopeSE </pre>
  583. <div class="labels"></div>
  584. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  585. </div>
  586. <a id="property__stdevOfResiduals"> </a><div class="element clickable property protected property__stdevOfResiduals" data-toggle="collapse" data-target=".property__stdevOfResiduals .collapse">
  587. <h2></h2>
  588. <pre>$_stdevOfResiduals </pre>
  589. <div class="labels"></div>
  590. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  591. </div>
  592. <a id="property__valueCount"> </a><div class="element clickable property protected property__valueCount" data-toggle="collapse" data-target=".property__valueCount .collapse">
  593. <h2></h2>
  594. <pre>$_valueCount : int</pre>
  595. <div class="labels"></div>
  596. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  597. </div>
  598. <a id="property__xValues"> </a><div class="element clickable property protected property__xValues" data-toggle="collapse" data-target=".property__xValues .collapse">
  599. <h2></h2>
  600. <pre>$_xValues : float[]</pre>
  601. <div class="labels"></div>
  602. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  603. </div>
  604. <a id="property__yBestFitValues"> </a><div class="element clickable property protected property__yBestFitValues" data-toggle="collapse" data-target=".property__yBestFitValues .collapse">
  605. <h2></h2>
  606. <pre>$_yBestFitValues : float[]</pre>
  607. <div class="labels"></div>
  608. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  609. </div>
  610. <a id="property__yValues"> </a><div class="element clickable property protected property__yValues" data-toggle="collapse" data-target=".property__yValues .collapse">
  611. <h2></h2>
  612. <pre>$_yValues : float[]</pre>
  613. <div class="labels"></div>
  614. <div class="row collapse"><div class="detail-description"><div class="long_description"></div></div></div>
  615. </div>
  616. </div>
  617. </div>
  618. </div>
  619. </div>
  620. <div class="row"><footer class="span12">
  621. Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
  622. Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a12</a> and<br>
  623. generated on 2014-03-02T15:27:37Z.<br></footer></div>
  624. </div>
  625. </body>
  626. </html>