Home Explore Help
Sign In
jonas.rehn
/
praktikum-holons
forked from carlos.garcia/praktikum-holons
1
0
Fork 0
Files
Tree: f87d359898
Branches Tags
praktikum-ho...
/
jars
/
jfreechart-1.0.19
/
jfreechart-1.0.19-fx-javadocs
/
src-html
/
org
/
jfree
/
data
/
statistics
/
BoxAndWhiskerXYDataset.html

BoxAndWhiskerXYDataset.html 17 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4. <title>Source code</title>
    5. 

  5. <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
    6. 

  6. </head>
    7. 

  7. <body>
    8. 

  8. <div class="sourceContainer">
    9. 

  9. <pre><span class="sourceLineNo">001</span>/* ===========================================================<a name="line.1"></a>
    10. 

  10. <span class="sourceLineNo">002</span> * JFreeChart : a free chart library for the Java(tm) platform<a name="line.2"></a>
    11. 

  11. <span class="sourceLineNo">003</span> * ===========================================================<a name="line.3"></a>
    12. 

  12. <span class="sourceLineNo">004</span> *<a name="line.4"></a>
    13. 

  13. <span class="sourceLineNo">005</span> * (C) Copyright 2000-2013, by Object Refinery Limited and Contributors.<a name="line.5"></a>
    14. 

  14. <span class="sourceLineNo">006</span> *<a name="line.6"></a>
    15. 

  15. <span class="sourceLineNo">007</span> * Project Info:  http://www.jfree.org/jfreechart/index.html<a name="line.7"></a>
    16. 

  16. <span class="sourceLineNo">008</span> *<a name="line.8"></a>
    17. 

  17. <span class="sourceLineNo">009</span> * This library is free software; you can redistribute it and/or modify it<a name="line.9"></a>
    18. 

  18. <span class="sourceLineNo">010</span> * under the terms of the GNU Lesser General Public License as published by<a name="line.10"></a>
    19. 

  19. <span class="sourceLineNo">011</span> * the Free Software Foundation; either version 2.1 of the License, or<a name="line.11"></a>
    20. 

  20. <span class="sourceLineNo">012</span> * (at your option) any later version.<a name="line.12"></a>
    21. 

  21. <span class="sourceLineNo">013</span> *<a name="line.13"></a>
    22. 

  22. <span class="sourceLineNo">014</span> * This library is distributed in the hope that it will be useful, but<a name="line.14"></a>
    23. 

  23. <span class="sourceLineNo">015</span> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY<a name="line.15"></a>
    24. 

  24. <span class="sourceLineNo">016</span> * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public<a name="line.16"></a>
    25. 

  25. <span class="sourceLineNo">017</span> * License for more details.<a name="line.17"></a>
    26. 

  26. <span class="sourceLineNo">018</span> *<a name="line.18"></a>
    27. 

  27. <span class="sourceLineNo">019</span> * You should have received a copy of the GNU Lesser General Public<a name="line.19"></a>
    28. 

  28. <span class="sourceLineNo">020</span> * License along with this library; if not, write to the Free Software<a name="line.20"></a>
    29. 

  29. <span class="sourceLineNo">021</span> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,<a name="line.21"></a>
    30. 

  30. <span class="sourceLineNo">022</span> * USA.<a name="line.22"></a>
    31. 

  31. <span class="sourceLineNo">023</span> *<a name="line.23"></a>
    32. 

  32. <span class="sourceLineNo">024</span> * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. <a name="line.24"></a>
    33. 

  33. <span class="sourceLineNo">025</span> * Other names may be trademarks of their respective owners.]<a name="line.25"></a>
    34. 

  34. <span class="sourceLineNo">026</span> *<a name="line.26"></a>
    35. 

  35. <span class="sourceLineNo">027</span> * ---------------------------<a name="line.27"></a>
    36. 

  36. <span class="sourceLineNo">028</span> * BoxAndWhiskerXYDataset.java<a name="line.28"></a>
    37. 

  37. <span class="sourceLineNo">029</span> * ---------------------------<a name="line.29"></a>
    38. 

  38. <span class="sourceLineNo">030</span> * (C) Copyright 2003-2008, by David Browning and Contributors.<a name="line.30"></a>
    39. 

  39. <span class="sourceLineNo">031</span> *<a name="line.31"></a>
    40. 

  40. <span class="sourceLineNo">032</span> * Original Author:  David Browning (for Australian Institute of Marine<a name="line.32"></a>
    41. 

  41. <span class="sourceLineNo">033</span> *                   Science);<a name="line.33"></a>
    42. 

  42. <span class="sourceLineNo">034</span> * Contributor(s):   David Gilbert (for Object Refinery Limited);<a name="line.34"></a>
    43. 

  43. <span class="sourceLineNo">035</span> *<a name="line.35"></a>
    44. 

  44. <span class="sourceLineNo">036</span> * Changes<a name="line.36"></a>
    45. 

  45. <span class="sourceLineNo">037</span> * -------<a name="line.37"></a>
    46. 

  46. <span class="sourceLineNo">038</span> * 05-Aug-2003 : Version 1, contributed by David Browning (DG);<a name="line.38"></a>
    47. 

  47. <span class="sourceLineNo">039</span> * 12-Aug-2003 : Added new methods: getMaxNonOutlierValue<a name="line.39"></a>
    48. 

  48. <span class="sourceLineNo">040</span> *                                  getMaxNonFaroutValue<a name="line.40"></a>
    49. 

  49. <span class="sourceLineNo">041</span> *                                  getOutlierCoefficient<a name="line.41"></a>
    50. 

  50. <span class="sourceLineNo">042</span> *                                  setOutlierCoefficient<a name="line.42"></a>
    51. 

  51. <span class="sourceLineNo">043</span> *                                  getFaroutCoefficient<a name="line.43"></a>
    52. 

  52. <span class="sourceLineNo">044</span> *                                  setFaroutCoefficient<a name="line.44"></a>
    53. 

  53. <span class="sourceLineNo">045</span> *                                  getInterquartileRange (DB)<a name="line.45"></a>
    54. 

  54. <span class="sourceLineNo">046</span> * 27-Aug-2003 : Renamed BoxAndWhiskerDataset --&gt; BoxAndWhiskerXYDataset, and<a name="line.46"></a>
    55. 

  55. <span class="sourceLineNo">047</span> *               cut down methods (DG);<a name="line.47"></a>
    56. 

  56. <span class="sourceLineNo">048</span> * ------------- JFREECHART 1.0.x ---------------------------------------------<a name="line.48"></a>
    57. 

  57. <span class="sourceLineNo">049</span> * 02-Feb-2007 : Removed author tags from all over JFreeChart sources (DG);<a name="line.49"></a>
    58. 

  58. <span class="sourceLineNo">050</span> *<a name="line.50"></a>
    59. 

  59. <span class="sourceLineNo">051</span> */<a name="line.51"></a>
    60. 

  60. <span class="sourceLineNo">052</span><a name="line.52"></a>
    61. 

  61. <span class="sourceLineNo">053</span>package org.jfree.data.statistics;<a name="line.53"></a>
    62. 

  62. <span class="sourceLineNo">054</span><a name="line.54"></a>
    63. 

  63. <span class="sourceLineNo">055</span>import java.util.List;<a name="line.55"></a>
    64. 

  64. <span class="sourceLineNo">056</span><a name="line.56"></a>
    65. 

  65. <span class="sourceLineNo">057</span>import org.jfree.data.xy.XYDataset;<a name="line.57"></a>
    66. 

  66. <span class="sourceLineNo">058</span><a name="line.58"></a>
    67. 

  67. <span class="sourceLineNo">059</span>/**<a name="line.59"></a>
    68. 

  68. <span class="sourceLineNo">060</span> * An interface that defines data in the form of (x, max, min, average, median)<a name="line.60"></a>
    69. 

  69. <span class="sourceLineNo">061</span> * tuples.<a name="line.61"></a>
    70. 

  70. <span class="sourceLineNo">062</span> * &lt;P&gt;<a name="line.62"></a>
    71. 

  71. <span class="sourceLineNo">063</span> * Example: JFreeChart uses this interface to obtain data for AIMS<a name="line.63"></a>
    72. 

  72. <span class="sourceLineNo">064</span> * max-min-average-median plots.<a name="line.64"></a>
    73. 

  73. <span class="sourceLineNo">065</span> */<a name="line.65"></a>
    74. 

  74. <span class="sourceLineNo">066</span>public interface BoxAndWhiskerXYDataset extends XYDataset {<a name="line.66"></a>
    75. 

  75. <span class="sourceLineNo">067</span><a name="line.67"></a>
    76. 

  76. <span class="sourceLineNo">068</span>    /**<a name="line.68"></a>
    77. 

  77. <span class="sourceLineNo">069</span>     * Returns the mean for the specified series and item.<a name="line.69"></a>
    78. 

  78. <span class="sourceLineNo">070</span>     *<a name="line.70"></a>
    79. 

  79. <span class="sourceLineNo">071</span>     * @param series  the series (zero-based index).<a name="line.71"></a>
    80. 

  80. <span class="sourceLineNo">072</span>     * @param item  the item (zero-based index).<a name="line.72"></a>
    81. 

  81. <span class="sourceLineNo">073</span>     *<a name="line.73"></a>
    82. 

  82. <span class="sourceLineNo">074</span>     * @return The mean for the specified series and item.<a name="line.74"></a>
    83. 

  83. <span class="sourceLineNo">075</span>     */<a name="line.75"></a>
    84. 

  84. <span class="sourceLineNo">076</span>    public Number getMeanValue(int series, int item);<a name="line.76"></a>
    85. 

  85. <span class="sourceLineNo">077</span><a name="line.77"></a>
    86. 

  86. <span class="sourceLineNo">078</span>    /**<a name="line.78"></a>
    87. 

  87. <span class="sourceLineNo">079</span>     * Returns the median-value for the specified series and item.<a name="line.79"></a>
    88. 

  88. <span class="sourceLineNo">080</span>     *<a name="line.80"></a>
    89. 

  89. <span class="sourceLineNo">081</span>     * @param series  the series (zero-based index).<a name="line.81"></a>
    90. 

  90. <span class="sourceLineNo">082</span>     * @param item  the item (zero-based index).<a name="line.82"></a>
    91. 

  91. <span class="sourceLineNo">083</span>     *<a name="line.83"></a>
    92. 

  92. <span class="sourceLineNo">084</span>     * @return The median-value for the specified series and item.<a name="line.84"></a>
    93. 

  93. <span class="sourceLineNo">085</span>     */<a name="line.85"></a>
    94. 

  94. <span class="sourceLineNo">086</span>    public Number getMedianValue(int series, int item);<a name="line.86"></a>
    95. 

  95. <span class="sourceLineNo">087</span><a name="line.87"></a>
    96. 

  96. <span class="sourceLineNo">088</span>    /**<a name="line.88"></a>
    97. 

  97. <span class="sourceLineNo">089</span>     * Returns the Q1 median-value for the specified series and item.<a name="line.89"></a>
    98. 

  98. <span class="sourceLineNo">090</span>     *<a name="line.90"></a>
    99. 

  99. <span class="sourceLineNo">091</span>     * @param series  the series (zero-based index).<a name="line.91"></a>
    100. 

  100. <span class="sourceLineNo">092</span>     * @param item  the item (zero-based index).<a name="line.92"></a>
    101. 

  101. <span class="sourceLineNo">093</span>     *<a name="line.93"></a>
    102. 

  102. <span class="sourceLineNo">094</span>     * @return The Q1 median-value for the specified series and item.<a name="line.94"></a>
    103. 

  103. <span class="sourceLineNo">095</span>     */<a name="line.95"></a>
    104. 

  104. <span class="sourceLineNo">096</span>    public Number getQ1Value(int series, int item);<a name="line.96"></a>
    105. 

  105. <span class="sourceLineNo">097</span><a name="line.97"></a>
    106. 

  106. <span class="sourceLineNo">098</span>    /**<a name="line.98"></a>
    107. 

  107. <span class="sourceLineNo">099</span>     * Returns the Q3 median-value for the specified series and item.<a name="line.99"></a>
    108. 

  108. <span class="sourceLineNo">100</span>     *<a name="line.100"></a>
    109. 

  109. <span class="sourceLineNo">101</span>     * @param series  the series (zero-based index).<a name="line.101"></a>
    110. 

  110. <span class="sourceLineNo">102</span>     * @param item  the item (zero-based index).<a name="line.102"></a>
    111. 

  111. <span class="sourceLineNo">103</span>     *<a name="line.103"></a>
    112. 

  112. <span class="sourceLineNo">104</span>     * @return The Q3 median-value for the specified series and item.<a name="line.104"></a>
    113. 

  113. <span class="sourceLineNo">105</span>     */<a name="line.105"></a>
    114. 

  114. <span class="sourceLineNo">106</span>    public Number getQ3Value(int series, int item);<a name="line.106"></a>
    115. 

  115. <span class="sourceLineNo">107</span><a name="line.107"></a>
    116. 

  116. <span class="sourceLineNo">108</span>    /**<a name="line.108"></a>
    117. 

  117. <span class="sourceLineNo">109</span>     * Returns the min-value for the specified series and item.<a name="line.109"></a>
    118. 

  118. <span class="sourceLineNo">110</span>     *<a name="line.110"></a>
    119. 

  119. <span class="sourceLineNo">111</span>     * @param series  the series (zero-based index).<a name="line.111"></a>
    120. 

  120. <span class="sourceLineNo">112</span>     * @param item  the item (zero-based index).<a name="line.112"></a>
    121. 

  121. <span class="sourceLineNo">113</span>     *<a name="line.113"></a>
    122. 

  122. <span class="sourceLineNo">114</span>     * @return The min-value for the specified series and item.<a name="line.114"></a>
    123. 

  123. <span class="sourceLineNo">115</span>     */<a name="line.115"></a>
    124. 

  124. <span class="sourceLineNo">116</span>    public Number getMinRegularValue(int series, int item);<a name="line.116"></a>
    125. 

  125. <span class="sourceLineNo">117</span><a name="line.117"></a>
    126. 

  126. <span class="sourceLineNo">118</span>    /**<a name="line.118"></a>
    127. 

  127. <span class="sourceLineNo">119</span>     * Returns the max-value for the specified series and item.<a name="line.119"></a>
    128. 

  128. <span class="sourceLineNo">120</span>     *<a name="line.120"></a>
    129. 

  129. <span class="sourceLineNo">121</span>     * @param series  the series (zero-based index).<a name="line.121"></a>
    130. 

  130. <span class="sourceLineNo">122</span>     * @param item  the item (zero-based index).<a name="line.122"></a>
    131. 

  131. <span class="sourceLineNo">123</span>     *<a name="line.123"></a>
    132. 

  132. <span class="sourceLineNo">124</span>     * @return The max-value for the specified series and item.<a name="line.124"></a>
    133. 

  133. <span class="sourceLineNo">125</span>     */<a name="line.125"></a>
    134. 

  134. <span class="sourceLineNo">126</span>    public Number getMaxRegularValue(int series, int item);<a name="line.126"></a>
    135. 

  135. <span class="sourceLineNo">127</span><a name="line.127"></a>
    136. 

  136. <span class="sourceLineNo">128</span>    /**<a name="line.128"></a>
    137. 

  137. <span class="sourceLineNo">129</span>     * Returns the minimum value which is not a farout.<a name="line.129"></a>
    138. 

  138. <span class="sourceLineNo">130</span>     * @param series  the series (zero-based index).<a name="line.130"></a>
    139. 

  139. <span class="sourceLineNo">131</span>     * @param item  the item (zero-based index).<a name="line.131"></a>
    140. 

  140. <span class="sourceLineNo">132</span>     *<a name="line.132"></a>
    141. 

  141. <span class="sourceLineNo">133</span>     * @return A &lt;code&gt;Number&lt;/code&gt; representing the maximum non-farout value.<a name="line.133"></a>
    142. 

  142. <span class="sourceLineNo">134</span>     */<a name="line.134"></a>
    143. 

  143. <span class="sourceLineNo">135</span>    public Number getMinOutlier(int series, int item);<a name="line.135"></a>
    144. 

  144. <span class="sourceLineNo">136</span><a name="line.136"></a>
    145. 

  145. <span class="sourceLineNo">137</span>    /**<a name="line.137"></a>
    146. 

  146. <span class="sourceLineNo">138</span>     * Returns the maximum value which is not a farout, ie Q3 + (interquartile<a name="line.138"></a>
    147. 

  147. <span class="sourceLineNo">139</span>     * range * farout coefficient).<a name="line.139"></a>
    148. 

  148. <span class="sourceLineNo">140</span>     *<a name="line.140"></a>
    149. 

  149. <span class="sourceLineNo">141</span>     * @param series  the series (zero-based index).<a name="line.141"></a>
    150. 

  150. <span class="sourceLineNo">142</span>     * @param item  the item (zero-based index).<a name="line.142"></a>
    151. 

  151. <span class="sourceLineNo">143</span>     *<a name="line.143"></a>
    152. 

  152. <span class="sourceLineNo">144</span>     * @return A &lt;code&gt;Number&lt;/code&gt; representing the maximum non-farout value.<a name="line.144"></a>
    153. 

  153. <span class="sourceLineNo">145</span>     */<a name="line.145"></a>
    154. 

  154. <span class="sourceLineNo">146</span>    public Number getMaxOutlier(int series, int item);<a name="line.146"></a>
    155. 

  155. <span class="sourceLineNo">147</span><a name="line.147"></a>
    156. 

  156. <span class="sourceLineNo">148</span>    /**<a name="line.148"></a>
    157. 

  157. <span class="sourceLineNo">149</span>     * Returns a list of outliers for the specified series and item.<a name="line.149"></a>
    158. 

  158. <span class="sourceLineNo">150</span>     *<a name="line.150"></a>
    159. 

  159. <span class="sourceLineNo">151</span>     * @param series  the series (zero-based index).<a name="line.151"></a>
    160. 

  160. <span class="sourceLineNo">152</span>     * @param item  the item (zero-based index).<a name="line.152"></a>
    161. 

  161. <span class="sourceLineNo">153</span>     *<a name="line.153"></a>
    162. 

  162. <span class="sourceLineNo">154</span>     * @return The list of outliers for the specified series and item<a name="line.154"></a>
    163. 

  163. <span class="sourceLineNo">155</span>     *         (possibly &lt;code&gt;null&lt;/code&gt;).<a name="line.155"></a>
    164. 

  164. <span class="sourceLineNo">156</span>     */<a name="line.156"></a>
    165. 

  165. <span class="sourceLineNo">157</span>    public List getOutliers(int series, int item);<a name="line.157"></a>
    166. 

  166. <span class="sourceLineNo">158</span><a name="line.158"></a>
    167. 

  167. <span class="sourceLineNo">159</span>    /**<a name="line.159"></a>
    168. 

  168. <span class="sourceLineNo">160</span>     * Returns the value used as the outlier coefficient. The outlier<a name="line.160"></a>
    169. 

  169. <span class="sourceLineNo">161</span>     * coefficient gives an indication of the degree of certainty in an<a name="line.161"></a>
    170. 

  170. <span class="sourceLineNo">162</span>     * unskewed distribution.  Increasing the coefficient increases the number<a name="line.162"></a>
    171. 

  171. <span class="sourceLineNo">163</span>     * of values included.  Currently only used to ensure farout coefficient<a name="line.163"></a>
    172. 

  172. <span class="sourceLineNo">164</span>     * is greater than the outlier coefficient<a name="line.164"></a>
    173. 

  173. <span class="sourceLineNo">165</span>     *<a name="line.165"></a>
    174. 

  174. <span class="sourceLineNo">166</span>     * @return A &lt;code&gt;double&lt;/code&gt; representing the value used to calculate<a name="line.166"></a>
    175. 

  175. <span class="sourceLineNo">167</span>     *         outliers<a name="line.167"></a>
    176. 

  176. <span class="sourceLineNo">168</span>     */<a name="line.168"></a>
    177. 

  177. <span class="sourceLineNo">169</span>    public double getOutlierCoefficient();<a name="line.169"></a>
    178. 

  178. <span class="sourceLineNo">170</span><a name="line.170"></a>
    179. 

  179. <span class="sourceLineNo">171</span>    /**<a name="line.171"></a>
    180. 

  180. <span class="sourceLineNo">172</span>     * Returns the value used as the farout coefficient. The farout coefficient<a name="line.172"></a>
    181. 

  181. <span class="sourceLineNo">173</span>     * allows the calculation of which values will be off the graph.<a name="line.173"></a>
    182. 

  182. <span class="sourceLineNo">174</span>     *<a name="line.174"></a>
    183. 

  183. <span class="sourceLineNo">175</span>     * @return A &lt;code&gt;double&lt;/code&gt; representing the value used to calculate<a name="line.175"></a>
    184. 

  184. <span class="sourceLineNo">176</span>     *         farouts<a name="line.176"></a>
    185. 

  185. <span class="sourceLineNo">177</span>     */<a name="line.177"></a>
    186. 

  186. <span class="sourceLineNo">178</span>    public double getFaroutCoefficient();<a name="line.178"></a>
    187. 

  187. <span class="sourceLineNo">179</span><a name="line.179"></a>
    188. 

  188. <span class="sourceLineNo">180</span>}<a name="line.180"></a>
    189. 

  189. 

  190. 

  191. 

  192. 

  193. 

  194. 

  195. 

  196. 

  197. 

  198. 

  199. 

  200. 

  201. 

  202. 

  203. 

  204. 

  205. 

  206. 

  207. 

  208. 

  209. 

  210. 

  211. 

  212. 

  213. 

  214. 

  215. 

  216. 

  217. 

  218. 

  219. 

  220. 

  221. 

  222. 

  223. 

  224. 

  225. 

  226. 

  227. 

  228. 

  229. 

  230. 

  231. 

  232. 

  233. 

  234. 

  235. 

  236. 

  237. 

  238. 

  239. 

  240. 

  241. 

  242. 

  243. 

  244. 

  245. 

  246. 

  247. 

  248. 

  249. </pre>
    250. 

  250. </div>
    251. 

  251. </body>
    252. 

  252. </html>
    253.