BoxAndWhiskerCalculator.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374
  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:42 CEST 2014 -->
  6. <title>BoxAndWhiskerCalculator (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="BoxAndWhiskerCalculator (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};
  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/BoxAndWhiskerCalculator.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>Prev&nbsp;Class</li>
  53. <li><a href="../../../../org/jfree/data/statistics/BoxAndWhiskerCategoryDataset.html" title="interface 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/BoxAndWhiskerCalculator.html" target="_top">Frames</a></li>
  57. <li><a href="BoxAndWhiskerCalculator.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 BoxAndWhiskerCalculator" class="title">Class BoxAndWhiskerCalculator</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.BoxAndWhiskerCalculator</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/BoxAndWhiskerCalculator.html#line.61">BoxAndWhiskerCalculator</a>
  113. extends java.lang.Object</pre>
  114. <div class="block">A utility class that calculates the mean, median, quartiles Q1 and Q3, plus
  115. a list of outlier values...all from an arbitrary list of
  116. <code>Number</code> objects.</div>
  117. </li>
  118. </ul>
  119. </div>
  120. <div class="summary">
  121. <ul class="blockList">
  122. <li class="blockList">
  123. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  124. <ul class="blockList">
  125. <li class="blockList"><a name="constructor.summary">
  126. <!-- -->
  127. </a>
  128. <h3>Constructor Summary</h3>
  129. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  130. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  131. <tr>
  132. <th class="colOne" scope="col">Constructor and Description</th>
  133. </tr>
  134. <tr class="altColor">
  135. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/BoxAndWhiskerCalculator.html#BoxAndWhiskerCalculator--">BoxAndWhiskerCalculator</a></span>()</code>&nbsp;</td>
  136. </tr>
  137. </table>
  138. </li>
  139. </ul>
  140. <!-- ========== METHOD SUMMARY =========== -->
  141. <ul class="blockList">
  142. <li class="blockList"><a name="method.summary">
  143. <!-- -->
  144. </a>
  145. <h3>Method Summary</h3>
  146. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  147. <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>
  148. <tr>
  149. <th class="colFirst" scope="col">Modifier and Type</th>
  150. <th class="colLast" scope="col">Method and Description</th>
  151. </tr>
  152. <tr id="i0" class="altColor">
  153. <td class="colFirst"><code>static <a href="../../../../org/jfree/data/statistics/BoxAndWhiskerItem.html" title="class in org.jfree.data.statistics">BoxAndWhiskerItem</a></code></td>
  154. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/BoxAndWhiskerCalculator.html#calculateBoxAndWhiskerStatistics-java.util.List-">calculateBoxAndWhiskerStatistics</a></span>(java.util.List&nbsp;values)</code>
  155. <div class="block">Calculates the statistics required for a <a href="../../../../org/jfree/data/statistics/BoxAndWhiskerItem.html" title="class in org.jfree.data.statistics"><code>BoxAndWhiskerItem</code></a>
  156. from a list of <code>Number</code> objects.</div>
  157. </td>
  158. </tr>
  159. <tr id="i1" class="rowColor">
  160. <td class="colFirst"><code>static <a href="../../../../org/jfree/data/statistics/BoxAndWhiskerItem.html" title="class in org.jfree.data.statistics">BoxAndWhiskerItem</a></code></td>
  161. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/BoxAndWhiskerCalculator.html#calculateBoxAndWhiskerStatistics-java.util.List-boolean-">calculateBoxAndWhiskerStatistics</a></span>(java.util.List&nbsp;values,
  162. boolean&nbsp;stripNullAndNaNItems)</code>
  163. <div class="block">Calculates the statistics required for a <a href="../../../../org/jfree/data/statistics/BoxAndWhiskerItem.html" title="class in org.jfree.data.statistics"><code>BoxAndWhiskerItem</code></a>
  164. from a list of <code>Number</code> objects.</div>
  165. </td>
  166. </tr>
  167. <tr id="i2" class="altColor">
  168. <td class="colFirst"><code>static double</code></td>
  169. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/BoxAndWhiskerCalculator.html#calculateQ1-java.util.List-">calculateQ1</a></span>(java.util.List&nbsp;values)</code>
  170. <div class="block">Calculates the first quartile for a list of numbers in ascending order.</div>
  171. </td>
  172. </tr>
  173. <tr id="i3" class="rowColor">
  174. <td class="colFirst"><code>static double</code></td>
  175. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/BoxAndWhiskerCalculator.html#calculateQ3-java.util.List-">calculateQ3</a></span>(java.util.List&nbsp;values)</code>
  176. <div class="block">Calculates the third quartile for a list of numbers in ascending order.</div>
  177. </td>
  178. </tr>
  179. </table>
  180. <ul class="blockList">
  181. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  182. <!-- -->
  183. </a>
  184. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  185. <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  186. </ul>
  187. </li>
  188. </ul>
  189. </li>
  190. </ul>
  191. </div>
  192. <div class="details">
  193. <ul class="blockList">
  194. <li class="blockList">
  195. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  196. <ul class="blockList">
  197. <li class="blockList"><a name="constructor.detail">
  198. <!-- -->
  199. </a>
  200. <h3>Constructor Detail</h3>
  201. <a name="BoxAndWhiskerCalculator--">
  202. <!-- -->
  203. </a>
  204. <ul class="blockListLast">
  205. <li class="blockList">
  206. <h4>BoxAndWhiskerCalculator</h4>
  207. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/BoxAndWhiskerCalculator.html#line.61">BoxAndWhiskerCalculator</a>()</pre>
  208. </li>
  209. </ul>
  210. </li>
  211. </ul>
  212. <!-- ============ METHOD DETAIL ========== -->
  213. <ul class="blockList">
  214. <li class="blockList"><a name="method.detail">
  215. <!-- -->
  216. </a>
  217. <h3>Method Detail</h3>
  218. <a name="calculateBoxAndWhiskerStatistics-java.util.List-">
  219. <!-- -->
  220. </a>
  221. <ul class="blockList">
  222. <li class="blockList">
  223. <h4>calculateBoxAndWhiskerStatistics</h4>
  224. <pre>public static&nbsp;<a href="../../../../org/jfree/data/statistics/BoxAndWhiskerItem.html" title="class in org.jfree.data.statistics">BoxAndWhiskerItem</a>&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/BoxAndWhiskerCalculator.html#line.74">calculateBoxAndWhiskerStatistics</a>(java.util.List&nbsp;values)</pre>
  225. <div class="block">Calculates the statistics required for a <a href="../../../../org/jfree/data/statistics/BoxAndWhiskerItem.html" title="class in org.jfree.data.statistics"><code>BoxAndWhiskerItem</code></a>
  226. from a list of <code>Number</code> objects. Any items in the list
  227. that are <code>null</code>, not an instance of <code>Number</code>, or
  228. equivalent to <code>Double.NaN</code>, will be ignored.</div>
  229. <dl>
  230. <dt><span class="paramLabel">Parameters:</span></dt>
  231. <dd><code>values</code> - a list of numbers (a <code>null</code> list is not
  232. permitted).</dd>
  233. <dt><span class="returnLabel">Returns:</span></dt>
  234. <dd>A box-and-whisker item.</dd>
  235. </dl>
  236. </li>
  237. </ul>
  238. <a name="calculateBoxAndWhiskerStatistics-java.util.List-boolean-">
  239. <!-- -->
  240. </a>
  241. <ul class="blockList">
  242. <li class="blockList">
  243. <h4>calculateBoxAndWhiskerStatistics</h4>
  244. <pre>public static&nbsp;<a href="../../../../org/jfree/data/statistics/BoxAndWhiskerItem.html" title="class in org.jfree.data.statistics">BoxAndWhiskerItem</a>&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/BoxAndWhiskerCalculator.html#line.94">calculateBoxAndWhiskerStatistics</a>(java.util.List&nbsp;values,
  245. boolean&nbsp;stripNullAndNaNItems)</pre>
  246. <div class="block">Calculates the statistics required for a <a href="../../../../org/jfree/data/statistics/BoxAndWhiskerItem.html" title="class in org.jfree.data.statistics"><code>BoxAndWhiskerItem</code></a>
  247. from a list of <code>Number</code> objects. Any items in the list
  248. that are <code>null</code>, not an instance of <code>Number</code>, or
  249. equivalent to <code>Double.NaN</code>, will be ignored.</div>
  250. <dl>
  251. <dt><span class="paramLabel">Parameters:</span></dt>
  252. <dd><code>values</code> - a list of numbers (a <code>null</code> list is not
  253. permitted).</dd>
  254. <dd><code>stripNullAndNaNItems</code> - a flag that controls the handling of null
  255. and NaN items.</dd>
  256. <dt><span class="returnLabel">Returns:</span></dt>
  257. <dd>A box-and-whisker item.</dd>
  258. <dt><span class="simpleTagLabel">Since:</span></dt>
  259. <dd>1.0.3</dd>
  260. </dl>
  261. </li>
  262. </ul>
  263. <a name="calculateQ1-java.util.List-">
  264. <!-- -->
  265. </a>
  266. <ul class="blockList">
  267. <li class="blockList">
  268. <h4>calculateQ1</h4>
  269. <pre>public static&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/BoxAndWhiskerCalculator.html#line.181">calculateQ1</a>(java.util.List&nbsp;values)</pre>
  270. <div class="block">Calculates the first quartile for a list of numbers in ascending order.
  271. If the items in the list are not in ascending order, the result is
  272. unspecified. If the list contains items that are <code>null</code>, not
  273. an instance of <code>Number</code>, or equivalent to
  274. <code>Double.NaN</code>, the result is unspecified.</div>
  275. <dl>
  276. <dt><span class="paramLabel">Parameters:</span></dt>
  277. <dd><code>values</code> - the numbers in ascending order (<code>null</code> not
  278. permitted).</dd>
  279. <dt><span class="returnLabel">Returns:</span></dt>
  280. <dd>The first quartile.</dd>
  281. </dl>
  282. </li>
  283. </ul>
  284. <a name="calculateQ3-java.util.List-">
  285. <!-- -->
  286. </a>
  287. <ul class="blockListLast">
  288. <li class="blockList">
  289. <h4>calculateQ3</h4>
  290. <pre>public static&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/BoxAndWhiskerCalculator.html#line.214">calculateQ3</a>(java.util.List&nbsp;values)</pre>
  291. <div class="block">Calculates the third quartile for a list of numbers in ascending order.
  292. If the items in the list are not in ascending order, the result is
  293. unspecified. If the list contains items that are <code>null</code>, not
  294. an instance of <code>Number</code>, or equivalent to
  295. <code>Double.NaN</code>, the result is unspecified.</div>
  296. <dl>
  297. <dt><span class="paramLabel">Parameters:</span></dt>
  298. <dd><code>values</code> - the list of values (<code>null</code> not permitted).</dd>
  299. <dt><span class="returnLabel">Returns:</span></dt>
  300. <dd>The third quartile.</dd>
  301. </dl>
  302. </li>
  303. </ul>
  304. </li>
  305. </ul>
  306. </li>
  307. </ul>
  308. </div>
  309. </div>
  310. <!-- ========= END OF CLASS DATA ========= -->
  311. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  312. <div class="bottomNav"><a name="navbar.bottom">
  313. <!-- -->
  314. </a>
  315. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  316. <a name="navbar.bottom.firstrow">
  317. <!-- -->
  318. </a>
  319. <ul class="navList" title="Navigation">
  320. <li><a href="../../../../overview-summary.html">Overview</a></li>
  321. <li><a href="package-summary.html">Package</a></li>
  322. <li class="navBarCell1Rev">Class</li>
  323. <li><a href="class-use/BoxAndWhiskerCalculator.html">Use</a></li>
  324. <li><a href="package-tree.html">Tree</a></li>
  325. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  326. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  327. <li><a href="../../../../help-doc.html">Help</a></li>
  328. </ul>
  329. </div>
  330. <div class="subNav">
  331. <ul class="navList">
  332. <li>Prev&nbsp;Class</li>
  333. <li><a href="../../../../org/jfree/data/statistics/BoxAndWhiskerCategoryDataset.html" title="interface in org.jfree.data.statistics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  334. </ul>
  335. <ul class="navList">
  336. <li><a href="../../../../index.html?org/jfree/data/statistics/BoxAndWhiskerCalculator.html" target="_top">Frames</a></li>
  337. <li><a href="BoxAndWhiskerCalculator.html" target="_top">No&nbsp;Frames</a></li>
  338. </ul>
  339. <ul class="navList" id="allclasses_navbar_bottom">
  340. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  341. </ul>
  342. <div>
  343. <script type="text/javascript"><!--
  344. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  345. if(window==top) {
  346. allClassesLink.style.display = "block";
  347. }
  348. else {
  349. allClassesLink.style.display = "none";
  350. }
  351. //-->
  352. </script>
  353. </div>
  354. <div>
  355. <ul class="subNavList">
  356. <li>Summary:&nbsp;</li>
  357. <li>Nested&nbsp;|&nbsp;</li>
  358. <li>Field&nbsp;|&nbsp;</li>
  359. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  360. <li><a href="#method.summary">Method</a></li>
  361. </ul>
  362. <ul class="subNavList">
  363. <li>Detail:&nbsp;</li>
  364. <li>Field&nbsp;|&nbsp;</li>
  365. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  366. <li><a href="#method.detail">Method</a></li>
  367. </ul>
  368. </div>
  369. <a name="skip.navbar.bottom">
  370. <!-- -->
  371. </a></div>
  372. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  373. </body>
  374. </html>