Regression.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:43 CEST 2014 -->
  6. <title>Regression (JFreeChart Class Library (version 1.0.19-fx))</title>
  7. <meta name="date" content="2014-07-31">
  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="Regression (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9};
  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/Regression.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  47. <li><a href="../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../org/jfree/data/statistics/MultiValueCategoryDataset.html" title="interface in org.jfree.data.statistics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/data/statistics/SimpleHistogramBin.html" title="class in org.jfree.data.statistics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/data/statistics/Regression.html" target="_top">Frames</a></li>
  57. <li><a href="Regression.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.jfree.data.statistics</div>
  96. <h2 title="Class Regression" class="title">Class Regression</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>org.jfree.data.statistics.Regression</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <hr>
  111. <br>
  112. <pre>public abstract class <a href="../../../../src-html/org/jfree/data/statistics/Regression.html#line.55">Regression</a>
  113. extends java.lang.Object</pre>
  114. <div class="block">A utility class for fitting regression curves to data.</div>
  115. </li>
  116. </ul>
  117. </div>
  118. <div class="summary">
  119. <ul class="blockList">
  120. <li class="blockList">
  121. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  122. <ul class="blockList">
  123. <li class="blockList"><a name="constructor.summary">
  124. <!-- -->
  125. </a>
  126. <h3>Constructor Summary</h3>
  127. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  128. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  129. <tr>
  130. <th class="colOne" scope="col">Constructor and Description</th>
  131. </tr>
  132. <tr class="altColor">
  133. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/Regression.html#Regression--">Regression</a></span>()</code>&nbsp;</td>
  134. </tr>
  135. </table>
  136. </li>
  137. </ul>
  138. <!-- ========== METHOD SUMMARY =========== -->
  139. <ul class="blockList">
  140. <li class="blockList"><a name="method.summary">
  141. <!-- -->
  142. </a>
  143. <h3>Method Summary</h3>
  144. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  145. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  146. <tr>
  147. <th class="colFirst" scope="col">Modifier and Type</th>
  148. <th class="colLast" scope="col">Method and Description</th>
  149. </tr>
  150. <tr id="i0" class="altColor">
  151. <td class="colFirst"><code>static double[]</code></td>
  152. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/Regression.html#getOLSRegression-double:A:A-">getOLSRegression</a></span>(double[][]&nbsp;data)</code>
  153. <div class="block">Returns the parameters 'a' and 'b' for an equation y = a + bx, fitted to
  154. the data using ordinary least squares regression.</div>
  155. </td>
  156. </tr>
  157. <tr id="i1" class="rowColor">
  158. <td class="colFirst"><code>static double[]</code></td>
  159. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/Regression.html#getOLSRegression-org.jfree.data.xy.XYDataset-int-">getOLSRegression</a></span>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;data,
  160. int&nbsp;series)</code>
  161. <div class="block">Returns the parameters 'a' and 'b' for an equation y = a + bx, fitted to
  162. the data using ordinary least squares regression.</div>
  163. </td>
  164. </tr>
  165. <tr id="i2" class="altColor">
  166. <td class="colFirst"><code>static double[]</code></td>
  167. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/Regression.html#getPolynomialRegression-org.jfree.data.xy.XYDataset-int-int-">getPolynomialRegression</a></span>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;dataset,
  168. int&nbsp;series,
  169. int&nbsp;order)</code>
  170. <div class="block">Returns the parameters 'a0', 'a1', 'a2', ..., 'an' for a polynomial
  171. function of order n, y = a0 + a1 * x + a2 * x^2 + ...</div>
  172. </td>
  173. </tr>
  174. <tr id="i3" class="rowColor">
  175. <td class="colFirst"><code>static double[]</code></td>
  176. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/Regression.html#getPowerRegression-double:A:A-">getPowerRegression</a></span>(double[][]&nbsp;data)</code>
  177. <div class="block">Returns the parameters 'a' and 'b' for an equation y = ax^b, fitted to
  178. the data using a power regression equation.</div>
  179. </td>
  180. </tr>
  181. <tr id="i4" class="altColor">
  182. <td class="colFirst"><code>static double[]</code></td>
  183. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/Regression.html#getPowerRegression-org.jfree.data.xy.XYDataset-int-">getPowerRegression</a></span>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;data,
  184. int&nbsp;series)</code>
  185. <div class="block">Returns the parameters 'a' and 'b' for an equation y = ax^b, fitted to
  186. the data using a power regression equation.</div>
  187. </td>
  188. </tr>
  189. </table>
  190. <ul class="blockList">
  191. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  192. <!-- -->
  193. </a>
  194. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  195. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  196. </ul>
  197. </li>
  198. </ul>
  199. </li>
  200. </ul>
  201. </div>
  202. <div class="details">
  203. <ul class="blockList">
  204. <li class="blockList">
  205. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  206. <ul class="blockList">
  207. <li class="blockList"><a name="constructor.detail">
  208. <!-- -->
  209. </a>
  210. <h3>Constructor Detail</h3>
  211. <a name="Regression--">
  212. <!-- -->
  213. </a>
  214. <ul class="blockListLast">
  215. <li class="blockList">
  216. <h4>Regression</h4>
  217. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/Regression.html#line.55">Regression</a>()</pre>
  218. </li>
  219. </ul>
  220. </li>
  221. </ul>
  222. <!-- ============ METHOD DETAIL ========== -->
  223. <ul class="blockList">
  224. <li class="blockList"><a name="method.detail">
  225. <!-- -->
  226. </a>
  227. <h3>Method Detail</h3>
  228. <a name="getOLSRegression-double:A:A-">
  229. <!-- -->
  230. </a>
  231. <ul class="blockList">
  232. <li class="blockList">
  233. <h4>getOLSRegression</h4>
  234. <pre>public static&nbsp;double[]&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/Regression.html#line.66">getOLSRegression</a>(double[][]&nbsp;data)</pre>
  235. <div class="block">Returns the parameters 'a' and 'b' for an equation y = a + bx, fitted to
  236. the data using ordinary least squares regression. The result is
  237. returned as a double[], where result[0] --&gt; a, and result[1] --&gt; b.</div>
  238. <dl>
  239. <dt><span class="paramLabel">Parameters:</span></dt>
  240. <dd><code>data</code> - the data.</dd>
  241. <dt><span class="returnLabel">Returns:</span></dt>
  242. <dd>The parameters.</dd>
  243. </dl>
  244. </li>
  245. </ul>
  246. <a name="getOLSRegression-org.jfree.data.xy.XYDataset-int-">
  247. <!-- -->
  248. </a>
  249. <ul class="blockList">
  250. <li class="blockList">
  251. <h4>getOLSRegression</h4>
  252. <pre>public static&nbsp;double[]&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/Regression.html#line.110">getOLSRegression</a>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;data,
  253. int&nbsp;series)</pre>
  254. <div class="block">Returns the parameters 'a' and 'b' for an equation y = a + bx, fitted to
  255. the data using ordinary least squares regression. The result is returned
  256. as a double[], where result[0] --&gt; a, and result[1] --&gt; b.</div>
  257. <dl>
  258. <dt><span class="paramLabel">Parameters:</span></dt>
  259. <dd><code>data</code> - the data.</dd>
  260. <dd><code>series</code> - the series (zero-based index).</dd>
  261. <dt><span class="returnLabel">Returns:</span></dt>
  262. <dd>The parameters.</dd>
  263. </dl>
  264. </li>
  265. </ul>
  266. <a name="getPowerRegression-double:A:A-">
  267. <!-- -->
  268. </a>
  269. <ul class="blockList">
  270. <li class="blockList">
  271. <h4>getPowerRegression</h4>
  272. <pre>public static&nbsp;double[]&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/Regression.html#line.153">getPowerRegression</a>(double[][]&nbsp;data)</pre>
  273. <div class="block">Returns the parameters 'a' and 'b' for an equation y = ax^b, fitted to
  274. the data using a power regression equation. The result is returned as
  275. an array, where double[0] --&gt; a, and double[1] --&gt; b.</div>
  276. <dl>
  277. <dt><span class="paramLabel">Parameters:</span></dt>
  278. <dd><code>data</code> - the data.</dd>
  279. <dt><span class="returnLabel">Returns:</span></dt>
  280. <dd>The parameters.</dd>
  281. </dl>
  282. </li>
  283. </ul>
  284. <a name="getPowerRegression-org.jfree.data.xy.XYDataset-int-">
  285. <!-- -->
  286. </a>
  287. <ul class="blockList">
  288. <li class="blockList">
  289. <h4>getPowerRegression</h4>
  290. <pre>public static&nbsp;double[]&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/Regression.html#line.197">getPowerRegression</a>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;data,
  291. int&nbsp;series)</pre>
  292. <div class="block">Returns the parameters 'a' and 'b' for an equation y = ax^b, fitted to
  293. the data using a power regression equation. The result is returned as
  294. an array, where double[0] --&gt; a, and double[1] --&gt; b.</div>
  295. <dl>
  296. <dt><span class="paramLabel">Parameters:</span></dt>
  297. <dd><code>data</code> - the data.</dd>
  298. <dd><code>series</code> - the series to fit the regression line against.</dd>
  299. <dt><span class="returnLabel">Returns:</span></dt>
  300. <dd>The parameters.</dd>
  301. </dl>
  302. </li>
  303. </ul>
  304. <a name="getPolynomialRegression-org.jfree.data.xy.XYDataset-int-int-">
  305. <!-- -->
  306. </a>
  307. <ul class="blockListLast">
  308. <li class="blockList">
  309. <h4>getPolynomialRegression</h4>
  310. <pre>public static&nbsp;double[]&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/Regression.html#line.250">getPolynomialRegression</a>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;dataset,
  311. int&nbsp;series,
  312. int&nbsp;order)</pre>
  313. <div class="block">Returns the parameters 'a0', 'a1', 'a2', ..., 'an' for a polynomial
  314. function of order n, y = a0 + a1 * x + a2 * x^2 + ... + an * x^n,
  315. fitted to the data using a polynomial regression equation.
  316. The result is returned as an array with a length of n + 2,
  317. where double[0] --&gt; a0, double[1] --&gt; a1, .., double[n] --&gt; an.
  318. and double[n + 1] is the correlation coefficient R2
  319. Reference: J. D. Faires, R. L. Burden, Numerische Methoden (german
  320. edition), pp. 243ff and 327ff.</div>
  321. <dl>
  322. <dt><span class="paramLabel">Parameters:</span></dt>
  323. <dd><code>dataset</code> - the dataset (<code>null</code> not permitted).</dd>
  324. <dd><code>series</code> - the series to fit the regression line against (the series
  325. must have at least order + 1 non-NaN items).</dd>
  326. <dd><code>order</code> - the order of the function (&gt; 0).</dd>
  327. <dt><span class="returnLabel">Returns:</span></dt>
  328. <dd>The parameters.</dd>
  329. <dt><span class="simpleTagLabel">Since:</span></dt>
  330. <dd>1.0.14</dd>
  331. </dl>
  332. </li>
  333. </ul>
  334. </li>
  335. </ul>
  336. </li>
  337. </ul>
  338. </div>
  339. </div>
  340. <!-- ========= END OF CLASS DATA ========= -->
  341. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  342. <div class="bottomNav"><a name="navbar.bottom">
  343. <!-- -->
  344. </a>
  345. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  346. <a name="navbar.bottom.firstrow">
  347. <!-- -->
  348. </a>
  349. <ul class="navList" title="Navigation">
  350. <li><a href="../../../../overview-summary.html">Overview</a></li>
  351. <li><a href="package-summary.html">Package</a></li>
  352. <li class="navBarCell1Rev">Class</li>
  353. <li><a href="class-use/Regression.html">Use</a></li>
  354. <li><a href="package-tree.html">Tree</a></li>
  355. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  356. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  357. <li><a href="../../../../help-doc.html">Help</a></li>
  358. </ul>
  359. </div>
  360. <div class="subNav">
  361. <ul class="navList">
  362. <li><a href="../../../../org/jfree/data/statistics/MultiValueCategoryDataset.html" title="interface in org.jfree.data.statistics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  363. <li><a href="../../../../org/jfree/data/statistics/SimpleHistogramBin.html" title="class in org.jfree.data.statistics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  364. </ul>
  365. <ul class="navList">
  366. <li><a href="../../../../index.html?org/jfree/data/statistics/Regression.html" target="_top">Frames</a></li>
  367. <li><a href="Regression.html" target="_top">No&nbsp;Frames</a></li>
  368. </ul>
  369. <ul class="navList" id="allclasses_navbar_bottom">
  370. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  371. </ul>
  372. <div>
  373. <script type="text/javascript"><!--
  374. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  375. if(window==top) {
  376. allClassesLink.style.display = "block";
  377. }
  378. else {
  379. allClassesLink.style.display = "none";
  380. }
  381. //-->
  382. </script>
  383. </div>
  384. <div>
  385. <ul class="subNavList">
  386. <li>Summary:&nbsp;</li>
  387. <li>Nested&nbsp;|&nbsp;</li>
  388. <li>Field&nbsp;|&nbsp;</li>
  389. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  390. <li><a href="#method.summary">Method</a></li>
  391. </ul>
  392. <ul class="subNavList">
  393. <li>Detail:&nbsp;</li>
  394. <li>Field&nbsp;|&nbsp;</li>
  395. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  396. <li><a href="#method.detail">Method</a></li>
  397. </ul>
  398. </div>
  399. <a name="skip.navbar.bottom">
  400. <!-- -->
  401. </a></div>
  402. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  403. </body>
  404. </html>