MeanAndStandardDeviation.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440
  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>MeanAndStandardDeviation (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="MeanAndStandardDeviation (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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/MeanAndStandardDeviation.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/HistogramType.html" title="class in org.jfree.data.statistics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/data/statistics/MultiValueCategoryDataset.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/MeanAndStandardDeviation.html" target="_top">Frames</a></li>
  57. <li><a href="MeanAndStandardDeviation.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 MeanAndStandardDeviation" class="title">Class MeanAndStandardDeviation</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.MeanAndStandardDeviation</li>
  104. </ul>
  105. </li>
  106. </ul>
  107. <div class="description">
  108. <ul class="blockList">
  109. <li class="blockList">
  110. <dl>
  111. <dt>All Implemented Interfaces:</dt>
  112. <dd>java.io.Serializable</dd>
  113. </dl>
  114. <hr>
  115. <br>
  116. <pre>public class <a href="../../../../src-html/org/jfree/data/statistics/MeanAndStandardDeviation.html#line.55">MeanAndStandardDeviation</a>
  117. extends java.lang.Object
  118. implements java.io.Serializable</pre>
  119. <div class="block">A simple data structure that holds a mean value and a standard deviation
  120. value. This is used in the
  121. <a href="../../../../org/jfree/data/statistics/DefaultStatisticalCategoryDataset.html" title="class in org.jfree.data.statistics"><code>DefaultStatisticalCategoryDataset</code></a> class.</div>
  122. <dl>
  123. <dt><span class="seeLabel">See Also:</span></dt>
  124. <dd><a href="../../../../serialized-form.html#org.jfree.data.statistics.MeanAndStandardDeviation">Serialized Form</a></dd>
  125. </dl>
  126. </li>
  127. </ul>
  128. </div>
  129. <div class="summary">
  130. <ul class="blockList">
  131. <li class="blockList">
  132. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  133. <ul class="blockList">
  134. <li class="blockList"><a name="constructor.summary">
  135. <!-- -->
  136. </a>
  137. <h3>Constructor Summary</h3>
  138. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  139. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  140. <tr>
  141. <th class="colOne" scope="col">Constructor and Description</th>
  142. </tr>
  143. <tr class="altColor">
  144. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/MeanAndStandardDeviation.html#MeanAndStandardDeviation-double-double-">MeanAndStandardDeviation</a></span>(double&nbsp;mean,
  145. double&nbsp;standardDeviation)</code>
  146. <div class="block">Creates a new mean and standard deviation record.</div>
  147. </td>
  148. </tr>
  149. <tr class="rowColor">
  150. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/MeanAndStandardDeviation.html#MeanAndStandardDeviation-java.lang.Number-java.lang.Number-">MeanAndStandardDeviation</a></span>(java.lang.Number&nbsp;mean,
  151. java.lang.Number&nbsp;standardDeviation)</code>
  152. <div class="block">Creates a new mean and standard deviation record.</div>
  153. </td>
  154. </tr>
  155. </table>
  156. </li>
  157. </ul>
  158. <!-- ========== METHOD SUMMARY =========== -->
  159. <ul class="blockList">
  160. <li class="blockList"><a name="method.summary">
  161. <!-- -->
  162. </a>
  163. <h3>Method Summary</h3>
  164. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  165. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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>
  166. <tr>
  167. <th class="colFirst" scope="col">Modifier and Type</th>
  168. <th class="colLast" scope="col">Method and Description</th>
  169. </tr>
  170. <tr id="i0" class="altColor">
  171. <td class="colFirst"><code>boolean</code></td>
  172. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/MeanAndStandardDeviation.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  173. <div class="block">Tests this instance for equality with an arbitrary object.</div>
  174. </td>
  175. </tr>
  176. <tr id="i1" class="rowColor">
  177. <td class="colFirst"><code>java.lang.Number</code></td>
  178. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/MeanAndStandardDeviation.html#getMean--">getMean</a></span>()</code>
  179. <div class="block">Returns the mean.</div>
  180. </td>
  181. </tr>
  182. <tr id="i2" class="altColor">
  183. <td class="colFirst"><code>double</code></td>
  184. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/MeanAndStandardDeviation.html#getMeanValue--">getMeanValue</a></span>()</code>
  185. <div class="block">Returns the mean as a double primitive.</div>
  186. </td>
  187. </tr>
  188. <tr id="i3" class="rowColor">
  189. <td class="colFirst"><code>java.lang.Number</code></td>
  190. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/MeanAndStandardDeviation.html#getStandardDeviation--">getStandardDeviation</a></span>()</code>
  191. <div class="block">Returns the standard deviation.</div>
  192. </td>
  193. </tr>
  194. <tr id="i4" class="altColor">
  195. <td class="colFirst"><code>double</code></td>
  196. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/MeanAndStandardDeviation.html#getStandardDeviationValue--">getStandardDeviationValue</a></span>()</code>
  197. <div class="block">Returns the standard deviation as a double primitive.</div>
  198. </td>
  199. </tr>
  200. <tr id="i5" class="rowColor">
  201. <td class="colFirst"><code>java.lang.String</code></td>
  202. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/data/statistics/MeanAndStandardDeviation.html#toString--">toString</a></span>()</code>
  203. <div class="block">Returns a string representing this instance.</div>
  204. </td>
  205. </tr>
  206. </table>
  207. <ul class="blockList">
  208. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  209. <!-- -->
  210. </a>
  211. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  212. <code>clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
  213. </ul>
  214. </li>
  215. </ul>
  216. </li>
  217. </ul>
  218. </div>
  219. <div class="details">
  220. <ul class="blockList">
  221. <li class="blockList">
  222. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  223. <ul class="blockList">
  224. <li class="blockList"><a name="constructor.detail">
  225. <!-- -->
  226. </a>
  227. <h3>Constructor Detail</h3>
  228. <a name="MeanAndStandardDeviation-double-double-">
  229. <!-- -->
  230. </a>
  231. <ul class="blockList">
  232. <li class="blockList">
  233. <h4>MeanAndStandardDeviation</h4>
  234. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/MeanAndStandardDeviation.html#line.72">MeanAndStandardDeviation</a>(double&nbsp;mean,
  235. double&nbsp;standardDeviation)</pre>
  236. <div class="block">Creates a new mean and standard deviation record.</div>
  237. <dl>
  238. <dt><span class="paramLabel">Parameters:</span></dt>
  239. <dd><code>mean</code> - the mean.</dd>
  240. <dd><code>standardDeviation</code> - the standard deviation.</dd>
  241. </dl>
  242. </li>
  243. </ul>
  244. <a name="MeanAndStandardDeviation-java.lang.Number-java.lang.Number-">
  245. <!-- -->
  246. </a>
  247. <ul class="blockListLast">
  248. <li class="blockList">
  249. <h4>MeanAndStandardDeviation</h4>
  250. <pre>public&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/MeanAndStandardDeviation.html#line.83">MeanAndStandardDeviation</a>(java.lang.Number&nbsp;mean,
  251. java.lang.Number&nbsp;standardDeviation)</pre>
  252. <div class="block">Creates a new mean and standard deviation record.</div>
  253. <dl>
  254. <dt><span class="paramLabel">Parameters:</span></dt>
  255. <dd><code>mean</code> - the mean (<code>null</code> permitted).</dd>
  256. <dd><code>standardDeviation</code> - the standard deviation (<code>null</code>
  257. permitted.</dd>
  258. </dl>
  259. </li>
  260. </ul>
  261. </li>
  262. </ul>
  263. <!-- ============ METHOD DETAIL ========== -->
  264. <ul class="blockList">
  265. <li class="blockList"><a name="method.detail">
  266. <!-- -->
  267. </a>
  268. <h3>Method Detail</h3>
  269. <a name="getMean--">
  270. <!-- -->
  271. </a>
  272. <ul class="blockList">
  273. <li class="blockList">
  274. <h4>getMean</h4>
  275. <pre>public&nbsp;java.lang.Number&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/MeanAndStandardDeviation.html#line.93">getMean</a>()</pre>
  276. <div class="block">Returns the mean.</div>
  277. <dl>
  278. <dt><span class="returnLabel">Returns:</span></dt>
  279. <dd>The mean.</dd>
  280. </dl>
  281. </li>
  282. </ul>
  283. <a name="getMeanValue--">
  284. <!-- -->
  285. </a>
  286. <ul class="blockList">
  287. <li class="blockList">
  288. <h4>getMeanValue</h4>
  289. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/MeanAndStandardDeviation.html#line.107">getMeanValue</a>()</pre>
  290. <div class="block">Returns the mean as a double primitive. If the underlying mean is
  291. <code>null</code>, this method will return <code>Double.NaN</code>.</div>
  292. <dl>
  293. <dt><span class="returnLabel">Returns:</span></dt>
  294. <dd>The mean.</dd>
  295. <dt><span class="simpleTagLabel">Since:</span></dt>
  296. <dd>1.0.7</dd>
  297. <dt><span class="seeLabel">See Also:</span></dt>
  298. <dd><a href="../../../../org/jfree/data/statistics/MeanAndStandardDeviation.html#getMean--"><code>getMean()</code></a></dd>
  299. </dl>
  300. </li>
  301. </ul>
  302. <a name="getStandardDeviation--">
  303. <!-- -->
  304. </a>
  305. <ul class="blockList">
  306. <li class="blockList">
  307. <h4>getStandardDeviation</h4>
  308. <pre>public&nbsp;java.lang.Number&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/MeanAndStandardDeviation.html#line.120">getStandardDeviation</a>()</pre>
  309. <div class="block">Returns the standard deviation.</div>
  310. <dl>
  311. <dt><span class="returnLabel">Returns:</span></dt>
  312. <dd>The standard deviation.</dd>
  313. </dl>
  314. </li>
  315. </ul>
  316. <a name="getStandardDeviationValue--">
  317. <!-- -->
  318. </a>
  319. <ul class="blockList">
  320. <li class="blockList">
  321. <h4>getStandardDeviationValue</h4>
  322. <pre>public&nbsp;double&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/MeanAndStandardDeviation.html#line.133">getStandardDeviationValue</a>()</pre>
  323. <div class="block">Returns the standard deviation as a double primitive. If the underlying
  324. standard deviation is <code>null</code>, this method will return
  325. <code>Double.NaN</code>.</div>
  326. <dl>
  327. <dt><span class="returnLabel">Returns:</span></dt>
  328. <dd>The standard deviation.</dd>
  329. <dt><span class="simpleTagLabel">Since:</span></dt>
  330. <dd>1.0.7</dd>
  331. </dl>
  332. </li>
  333. </ul>
  334. <a name="equals-java.lang.Object-">
  335. <!-- -->
  336. </a>
  337. <ul class="blockList">
  338. <li class="blockList">
  339. <h4>equals</h4>
  340. <pre>public&nbsp;boolean&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/MeanAndStandardDeviation.html#line.149">equals</a>(java.lang.Object&nbsp;obj)</pre>
  341. <div class="block">Tests this instance for equality with an arbitrary object.</div>
  342. <dl>
  343. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  344. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  345. <dt><span class="paramLabel">Parameters:</span></dt>
  346. <dd><code>obj</code> - the object (<code>null</code> permitted).</dd>
  347. <dt><span class="returnLabel">Returns:</span></dt>
  348. <dd>A boolean.</dd>
  349. </dl>
  350. </li>
  351. </ul>
  352. <a name="toString--">
  353. <!-- -->
  354. </a>
  355. <ul class="blockListLast">
  356. <li class="blockList">
  357. <h4>toString</h4>
  358. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/data/statistics/MeanAndStandardDeviation.html#line.176">toString</a>()</pre>
  359. <div class="block">Returns a string representing this instance.</div>
  360. <dl>
  361. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  362. <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  363. <dt><span class="returnLabel">Returns:</span></dt>
  364. <dd>A string.</dd>
  365. <dt><span class="simpleTagLabel">Since:</span></dt>
  366. <dd>1.0.7</dd>
  367. </dl>
  368. </li>
  369. </ul>
  370. </li>
  371. </ul>
  372. </li>
  373. </ul>
  374. </div>
  375. </div>
  376. <!-- ========= END OF CLASS DATA ========= -->
  377. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  378. <div class="bottomNav"><a name="navbar.bottom">
  379. <!-- -->
  380. </a>
  381. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  382. <a name="navbar.bottom.firstrow">
  383. <!-- -->
  384. </a>
  385. <ul class="navList" title="Navigation">
  386. <li><a href="../../../../overview-summary.html">Overview</a></li>
  387. <li><a href="package-summary.html">Package</a></li>
  388. <li class="navBarCell1Rev">Class</li>
  389. <li><a href="class-use/MeanAndStandardDeviation.html">Use</a></li>
  390. <li><a href="package-tree.html">Tree</a></li>
  391. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  392. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  393. <li><a href="../../../../help-doc.html">Help</a></li>
  394. </ul>
  395. </div>
  396. <div class="subNav">
  397. <ul class="navList">
  398. <li><a href="../../../../org/jfree/data/statistics/HistogramType.html" title="class in org.jfree.data.statistics"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  399. <li><a href="../../../../org/jfree/data/statistics/MultiValueCategoryDataset.html" title="interface in org.jfree.data.statistics"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  400. </ul>
  401. <ul class="navList">
  402. <li><a href="../../../../index.html?org/jfree/data/statistics/MeanAndStandardDeviation.html" target="_top">Frames</a></li>
  403. <li><a href="MeanAndStandardDeviation.html" target="_top">No&nbsp;Frames</a></li>
  404. </ul>
  405. <ul class="navList" id="allclasses_navbar_bottom">
  406. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  407. </ul>
  408. <div>
  409. <script type="text/javascript"><!--
  410. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  411. if(window==top) {
  412. allClassesLink.style.display = "block";
  413. }
  414. else {
  415. allClassesLink.style.display = "none";
  416. }
  417. //-->
  418. </script>
  419. </div>
  420. <div>
  421. <ul class="subNavList">
  422. <li>Summary:&nbsp;</li>
  423. <li>Nested&nbsp;|&nbsp;</li>
  424. <li>Field&nbsp;|&nbsp;</li>
  425. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  426. <li><a href="#method.summary">Method</a></li>
  427. </ul>
  428. <ul class="subNavList">
  429. <li>Detail:&nbsp;</li>
  430. <li>Field&nbsp;|&nbsp;</li>
  431. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  432. <li><a href="#method.detail">Method</a></li>
  433. </ul>
  434. </div>
  435. <a name="skip.navbar.bottom">
  436. <!-- -->
  437. </a></div>
  438. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  439. </body>
  440. </html>