Range.html 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760
  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>Range (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="Range (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":10,"i5":9,"i6":9,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":9,"i16":9,"i17":9,"i18":10};
  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/Range.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/KeyToGroupMap.html" title="class in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../org/jfree/data/RangeInfo.html" title="interface in org.jfree.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../index.html?org/jfree/data/Range.html" target="_top">Frames</a></li>
  57. <li><a href="Range.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</div>
  96. <h2 title="Class Range" class="title">Class Range</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.Range</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. <dl>
  115. <dt>Direct Known Subclasses:</dt>
  116. <dd><a href="../../../org/jfree/data/time/DateRange.html" title="class in org.jfree.data.time">DateRange</a></dd>
  117. </dl>
  118. <hr>
  119. <br>
  120. <pre>public class <a href="../../../src-html/org/jfree/data/Range.html#line.72">Range</a>
  121. extends java.lang.Object
  122. implements java.io.Serializable</pre>
  123. <div class="block">Represents an immutable range of values.</div>
  124. <dl>
  125. <dt><span class="seeLabel">See Also:</span></dt>
  126. <dd><a href="../../../serialized-form.html#org.jfree.data.Range">Serialized Form</a></dd>
  127. </dl>
  128. </li>
  129. </ul>
  130. </div>
  131. <div class="summary">
  132. <ul class="blockList">
  133. <li class="blockList">
  134. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  135. <ul class="blockList">
  136. <li class="blockList"><a name="constructor.summary">
  137. <!-- -->
  138. </a>
  139. <h3>Constructor Summary</h3>
  140. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
  141. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
  142. <tr>
  143. <th class="colOne" scope="col">Constructor and Description</th>
  144. </tr>
  145. <tr class="altColor">
  146. <td class="colOne"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#Range-double-double-">Range</a></span>(double&nbsp;lower,
  147. double&nbsp;upper)</code>
  148. <div class="block">Creates a new range.</div>
  149. </td>
  150. </tr>
  151. </table>
  152. </li>
  153. </ul>
  154. <!-- ========== METHOD SUMMARY =========== -->
  155. <ul class="blockList">
  156. <li class="blockList"><a name="method.summary">
  157. <!-- -->
  158. </a>
  159. <h3>Method Summary</h3>
  160. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  161. <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="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>
  162. <tr>
  163. <th class="colFirst" scope="col">Modifier and Type</th>
  164. <th class="colLast" scope="col">Method and Description</th>
  165. </tr>
  166. <tr id="i0" class="altColor">
  167. <td class="colFirst"><code>static <a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a></code></td>
  168. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#combine-org.jfree.data.Range-org.jfree.data.Range-">combine</a></span>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range1,
  169. <a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range2)</code>
  170. <div class="block">Creates a new range by combining two existing ranges.</div>
  171. </td>
  172. </tr>
  173. <tr id="i1" class="rowColor">
  174. <td class="colFirst"><code>static <a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a></code></td>
  175. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#combineIgnoringNaN-org.jfree.data.Range-org.jfree.data.Range-">combineIgnoringNaN</a></span>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range1,
  176. <a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range2)</code>
  177. <div class="block">Returns a new range that spans both <code>range1</code> and
  178. <code>range2</code>.</div>
  179. </td>
  180. </tr>
  181. <tr id="i2" class="altColor">
  182. <td class="colFirst"><code>double</code></td>
  183. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#constrain-double-">constrain</a></span>(double&nbsp;value)</code>
  184. <div class="block">Returns the value within the range that is closest to the specified
  185. value.</div>
  186. </td>
  187. </tr>
  188. <tr id="i3" class="rowColor">
  189. <td class="colFirst"><code>boolean</code></td>
  190. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#contains-double-">contains</a></span>(double&nbsp;value)</code>
  191. <div class="block">Returns <code>true</code> if the range contains the specified value and
  192. <code>false</code> otherwise.</div>
  193. </td>
  194. </tr>
  195. <tr id="i4" class="altColor">
  196. <td class="colFirst"><code>boolean</code></td>
  197. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object&nbsp;obj)</code>
  198. <div class="block">Tests this object for equality with an arbitrary object.</div>
  199. </td>
  200. </tr>
  201. <tr id="i5" class="rowColor">
  202. <td class="colFirst"><code>static <a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a></code></td>
  203. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#expand-org.jfree.data.Range-double-double-">expand</a></span>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range,
  204. double&nbsp;lowerMargin,
  205. double&nbsp;upperMargin)</code>
  206. <div class="block">Creates a new range by adding margins to an existing range.</div>
  207. </td>
  208. </tr>
  209. <tr id="i6" class="altColor">
  210. <td class="colFirst"><code>static <a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a></code></td>
  211. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#expandToInclude-org.jfree.data.Range-double-">expandToInclude</a></span>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range,
  212. double&nbsp;value)</code>
  213. <div class="block">Returns a range that includes all the values in the specified
  214. <code>range</code> AND the specified <code>value</code>.</div>
  215. </td>
  216. </tr>
  217. <tr id="i7" class="rowColor">
  218. <td class="colFirst"><code>double</code></td>
  219. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#getCentralValue--">getCentralValue</a></span>()</code>
  220. <div class="block">Returns the central value for the range.</div>
  221. </td>
  222. </tr>
  223. <tr id="i8" class="altColor">
  224. <td class="colFirst"><code>double</code></td>
  225. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#getLength--">getLength</a></span>()</code>
  226. <div class="block">Returns the length of the range.</div>
  227. </td>
  228. </tr>
  229. <tr id="i9" class="rowColor">
  230. <td class="colFirst"><code>double</code></td>
  231. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#getLowerBound--">getLowerBound</a></span>()</code>
  232. <div class="block">Returns the lower bound for the range.</div>
  233. </td>
  234. </tr>
  235. <tr id="i10" class="altColor">
  236. <td class="colFirst"><code>double</code></td>
  237. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#getUpperBound--">getUpperBound</a></span>()</code>
  238. <div class="block">Returns the upper bound for the range.</div>
  239. </td>
  240. </tr>
  241. <tr id="i11" class="rowColor">
  242. <td class="colFirst"><code>int</code></td>
  243. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#hashCode--">hashCode</a></span>()</code>
  244. <div class="block">Returns a hash code.</div>
  245. </td>
  246. </tr>
  247. <tr id="i12" class="altColor">
  248. <td class="colFirst"><code>boolean</code></td>
  249. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#intersects-double-double-">intersects</a></span>(double&nbsp;b0,
  250. double&nbsp;b1)</code>
  251. <div class="block">Returns <code>true</code> if the range intersects with the specified
  252. range, and <code>false</code> otherwise.</div>
  253. </td>
  254. </tr>
  255. <tr id="i13" class="rowColor">
  256. <td class="colFirst"><code>boolean</code></td>
  257. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#intersects-org.jfree.data.Range-">intersects</a></span>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range)</code>
  258. <div class="block">Returns <code>true</code> if the range intersects with the specified
  259. range, and <code>false</code> otherwise.</div>
  260. </td>
  261. </tr>
  262. <tr id="i14" class="altColor">
  263. <td class="colFirst"><code>boolean</code></td>
  264. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#isNaNRange--">isNaNRange</a></span>()</code>
  265. <div class="block">Returns <code>true</code> if both the lower and upper bounds are
  266. <code>Double.NaN</code>, and <code>false</code> otherwise.</div>
  267. </td>
  268. </tr>
  269. <tr id="i15" class="rowColor">
  270. <td class="colFirst"><code>static <a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a></code></td>
  271. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#scale-org.jfree.data.Range-double-">scale</a></span>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;base,
  272. double&nbsp;factor)</code>
  273. <div class="block">Scales the range by the specified factor.</div>
  274. </td>
  275. </tr>
  276. <tr id="i16" class="altColor">
  277. <td class="colFirst"><code>static <a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a></code></td>
  278. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#shift-org.jfree.data.Range-double-">shift</a></span>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;base,
  279. double&nbsp;delta)</code>
  280. <div class="block">Shifts the range by the specified amount.</div>
  281. </td>
  282. </tr>
  283. <tr id="i17" class="rowColor">
  284. <td class="colFirst"><code>static <a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a></code></td>
  285. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#shift-org.jfree.data.Range-double-boolean-">shift</a></span>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;base,
  286. double&nbsp;delta,
  287. boolean&nbsp;allowZeroCrossing)</code>
  288. <div class="block">Shifts the range by the specified amount.</div>
  289. </td>
  290. </tr>
  291. <tr id="i18" class="altColor">
  292. <td class="colFirst"><code>java.lang.String</code></td>
  293. <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jfree/data/Range.html#toString--">toString</a></span>()</code>
  294. <div class="block">Returns a string representation of this Range.</div>
  295. </td>
  296. </tr>
  297. </table>
  298. <ul class="blockList">
  299. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  300. <!-- -->
  301. </a>
  302. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  303. <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</code></li>
  304. </ul>
  305. </li>
  306. </ul>
  307. </li>
  308. </ul>
  309. </div>
  310. <div class="details">
  311. <ul class="blockList">
  312. <li class="blockList">
  313. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  314. <ul class="blockList">
  315. <li class="blockList"><a name="constructor.detail">
  316. <!-- -->
  317. </a>
  318. <h3>Constructor Detail</h3>
  319. <a name="Range-double-double-">
  320. <!-- -->
  321. </a>
  322. <ul class="blockListLast">
  323. <li class="blockList">
  324. <h4>Range</h4>
  325. <pre>public&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.89">Range</a>(double&nbsp;lower,
  326. double&nbsp;upper)</pre>
  327. <div class="block">Creates a new range.</div>
  328. <dl>
  329. <dt><span class="paramLabel">Parameters:</span></dt>
  330. <dd><code>lower</code> - the lower bound (must be &lt;= upper bound).</dd>
  331. <dd><code>upper</code> - the upper bound (must be &gt;= lower bound).</dd>
  332. </dl>
  333. </li>
  334. </ul>
  335. </li>
  336. </ul>
  337. <!-- ============ METHOD DETAIL ========== -->
  338. <ul class="blockList">
  339. <li class="blockList"><a name="method.detail">
  340. <!-- -->
  341. </a>
  342. <h3>Method Detail</h3>
  343. <a name="getLowerBound--">
  344. <!-- -->
  345. </a>
  346. <ul class="blockList">
  347. <li class="blockList">
  348. <h4>getLowerBound</h4>
  349. <pre>public&nbsp;double&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.104">getLowerBound</a>()</pre>
  350. <div class="block">Returns the lower bound for the range.</div>
  351. <dl>
  352. <dt><span class="returnLabel">Returns:</span></dt>
  353. <dd>The lower bound.</dd>
  354. </dl>
  355. </li>
  356. </ul>
  357. <a name="getUpperBound--">
  358. <!-- -->
  359. </a>
  360. <ul class="blockList">
  361. <li class="blockList">
  362. <h4>getUpperBound</h4>
  363. <pre>public&nbsp;double&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.113">getUpperBound</a>()</pre>
  364. <div class="block">Returns the upper bound for the range.</div>
  365. <dl>
  366. <dt><span class="returnLabel">Returns:</span></dt>
  367. <dd>The upper bound.</dd>
  368. </dl>
  369. </li>
  370. </ul>
  371. <a name="getLength--">
  372. <!-- -->
  373. </a>
  374. <ul class="blockList">
  375. <li class="blockList">
  376. <h4>getLength</h4>
  377. <pre>public&nbsp;double&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.122">getLength</a>()</pre>
  378. <div class="block">Returns the length of the range.</div>
  379. <dl>
  380. <dt><span class="returnLabel">Returns:</span></dt>
  381. <dd>The length.</dd>
  382. </dl>
  383. </li>
  384. </ul>
  385. <a name="getCentralValue--">
  386. <!-- -->
  387. </a>
  388. <ul class="blockList">
  389. <li class="blockList">
  390. <h4>getCentralValue</h4>
  391. <pre>public&nbsp;double&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.131">getCentralValue</a>()</pre>
  392. <div class="block">Returns the central value for the range.</div>
  393. <dl>
  394. <dt><span class="returnLabel">Returns:</span></dt>
  395. <dd>The central value.</dd>
  396. </dl>
  397. </li>
  398. </ul>
  399. <a name="contains-double-">
  400. <!-- -->
  401. </a>
  402. <ul class="blockList">
  403. <li class="blockList">
  404. <h4>contains</h4>
  405. <pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.143">contains</a>(double&nbsp;value)</pre>
  406. <div class="block">Returns <code>true</code> if the range contains the specified value and
  407. <code>false</code> otherwise.</div>
  408. <dl>
  409. <dt><span class="paramLabel">Parameters:</span></dt>
  410. <dd><code>value</code> - the value to lookup.</dd>
  411. <dt><span class="returnLabel">Returns:</span></dt>
  412. <dd><code>true</code> if the range contains the specified value.</dd>
  413. </dl>
  414. </li>
  415. </ul>
  416. <a name="intersects-double-double-">
  417. <!-- -->
  418. </a>
  419. <ul class="blockList">
  420. <li class="blockList">
  421. <h4>intersects</h4>
  422. <pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.156">intersects</a>(double&nbsp;b0,
  423. double&nbsp;b1)</pre>
  424. <div class="block">Returns <code>true</code> if the range intersects with the specified
  425. range, and <code>false</code> otherwise.</div>
  426. <dl>
  427. <dt><span class="paramLabel">Parameters:</span></dt>
  428. <dd><code>b0</code> - the lower bound (should be &lt;= b1).</dd>
  429. <dd><code>b1</code> - the upper bound (should be &gt;= b0).</dd>
  430. <dt><span class="returnLabel">Returns:</span></dt>
  431. <dd>A boolean.</dd>
  432. </dl>
  433. </li>
  434. </ul>
  435. <a name="intersects-org.jfree.data.Range-">
  436. <!-- -->
  437. </a>
  438. <ul class="blockList">
  439. <li class="blockList">
  440. <h4>intersects</h4>
  441. <pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.175">intersects</a>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range)</pre>
  442. <div class="block">Returns <code>true</code> if the range intersects with the specified
  443. range, and <code>false</code> otherwise.</div>
  444. <dl>
  445. <dt><span class="paramLabel">Parameters:</span></dt>
  446. <dd><code>range</code> - another range (<code>null</code> not permitted).</dd>
  447. <dt><span class="returnLabel">Returns:</span></dt>
  448. <dd>A boolean.</dd>
  449. <dt><span class="simpleTagLabel">Since:</span></dt>
  450. <dd>1.0.9</dd>
  451. </dl>
  452. </li>
  453. </ul>
  454. <a name="constrain-double-">
  455. <!-- -->
  456. </a>
  457. <ul class="blockList">
  458. <li class="blockList">
  459. <h4>constrain</h4>
  460. <pre>public&nbsp;double&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.187">constrain</a>(double&nbsp;value)</pre>
  461. <div class="block">Returns the value within the range that is closest to the specified
  462. value.</div>
  463. <dl>
  464. <dt><span class="paramLabel">Parameters:</span></dt>
  465. <dd><code>value</code> - the value.</dd>
  466. <dt><span class="returnLabel">Returns:</span></dt>
  467. <dd>The constrained value.</dd>
  468. </dl>
  469. </li>
  470. </ul>
  471. <a name="combine-org.jfree.data.Range-org.jfree.data.Range-">
  472. <!-- -->
  473. </a>
  474. <ul class="blockList">
  475. <li class="blockList">
  476. <h4>combine</h4>
  477. <pre>public static&nbsp;<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.216">combine</a>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range1,
  478. <a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range2)</pre>
  479. <div class="block">Creates a new range by combining two existing ranges.
  480. <P>
  481. Note that:
  482. <ul>
  483. <li>either range can be <code>null</code>, in which case the other
  484. range is returned;</li>
  485. <li>if both ranges are <code>null</code> the return value is
  486. <code>null</code>.</li>
  487. </ul></div>
  488. <dl>
  489. <dt><span class="paramLabel">Parameters:</span></dt>
  490. <dd><code>range1</code> - the first range (<code>null</code> permitted).</dd>
  491. <dd><code>range2</code> - the second range (<code>null</code> permitted).</dd>
  492. <dt><span class="returnLabel">Returns:</span></dt>
  493. <dd>A new range (possibly <code>null</code>).</dd>
  494. </dl>
  495. </li>
  496. </ul>
  497. <a name="combineIgnoringNaN-org.jfree.data.Range-org.jfree.data.Range-">
  498. <!-- -->
  499. </a>
  500. <ul class="blockList">
  501. <li class="blockList">
  502. <h4>combineIgnoringNaN</h4>
  503. <pre>public static&nbsp;<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.240">combineIgnoringNaN</a>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range1,
  504. <a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range2)</pre>
  505. <div class="block">Returns a new range that spans both <code>range1</code> and
  506. <code>range2</code>. This method has a special handling to ignore
  507. Double.NaN values.</div>
  508. <dl>
  509. <dt><span class="paramLabel">Parameters:</span></dt>
  510. <dd><code>range1</code> - the first range (<code>null</code> permitted).</dd>
  511. <dd><code>range2</code> - the second range (<code>null</code> permitted).</dd>
  512. <dt><span class="returnLabel">Returns:</span></dt>
  513. <dd>A new range (possibly <code>null</code>).</dd>
  514. <dt><span class="simpleTagLabel">Since:</span></dt>
  515. <dd>1.0.15</dd>
  516. </dl>
  517. </li>
  518. </ul>
  519. <a name="expandToInclude-org.jfree.data.Range-double-">
  520. <!-- -->
  521. </a>
  522. <ul class="blockList">
  523. <li class="blockList">
  524. <h4>expandToInclude</h4>
  525. <pre>public static&nbsp;<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.301">expandToInclude</a>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range,
  526. double&nbsp;value)</pre>
  527. <div class="block">Returns a range that includes all the values in the specified
  528. <code>range</code> AND the specified <code>value</code>.</div>
  529. <dl>
  530. <dt><span class="paramLabel">Parameters:</span></dt>
  531. <dd><code>range</code> - the range (<code>null</code> permitted).</dd>
  532. <dd><code>value</code> - the value that must be included.</dd>
  533. <dt><span class="returnLabel">Returns:</span></dt>
  534. <dd>A range.</dd>
  535. <dt><span class="simpleTagLabel">Since:</span></dt>
  536. <dd>1.0.1</dd>
  537. </dl>
  538. </li>
  539. </ul>
  540. <a name="expand-org.jfree.data.Range-double-double-">
  541. <!-- -->
  542. </a>
  543. <ul class="blockList">
  544. <li class="blockList">
  545. <h4>expand</h4>
  546. <pre>public static&nbsp;<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.327">expand</a>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;range,
  547. double&nbsp;lowerMargin,
  548. double&nbsp;upperMargin)</pre>
  549. <div class="block">Creates a new range by adding margins to an existing range.</div>
  550. <dl>
  551. <dt><span class="paramLabel">Parameters:</span></dt>
  552. <dd><code>range</code> - the range (<code>null</code> not permitted).</dd>
  553. <dd><code>lowerMargin</code> - the lower margin (expressed as a percentage of the
  554. range length).</dd>
  555. <dd><code>upperMargin</code> - the upper margin (expressed as a percentage of the
  556. range length).</dd>
  557. <dt><span class="returnLabel">Returns:</span></dt>
  558. <dd>The expanded range.</dd>
  559. </dl>
  560. </li>
  561. </ul>
  562. <a name="shift-org.jfree.data.Range-double-">
  563. <!-- -->
  564. </a>
  565. <ul class="blockList">
  566. <li class="blockList">
  567. <h4>shift</h4>
  568. <pre>public static&nbsp;<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.348">shift</a>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;base,
  569. double&nbsp;delta)</pre>
  570. <div class="block">Shifts the range by the specified amount.</div>
  571. <dl>
  572. <dt><span class="paramLabel">Parameters:</span></dt>
  573. <dd><code>base</code> - the base range (<code>null</code> not permitted).</dd>
  574. <dd><code>delta</code> - the shift amount.</dd>
  575. <dt><span class="returnLabel">Returns:</span></dt>
  576. <dd>A new range.</dd>
  577. </dl>
  578. </li>
  579. </ul>
  580. <a name="shift-org.jfree.data.Range-double-boolean-">
  581. <!-- -->
  582. </a>
  583. <ul class="blockList">
  584. <li class="blockList">
  585. <h4>shift</h4>
  586. <pre>public static&nbsp;<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.363">shift</a>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;base,
  587. double&nbsp;delta,
  588. boolean&nbsp;allowZeroCrossing)</pre>
  589. <div class="block">Shifts the range by the specified amount.</div>
  590. <dl>
  591. <dt><span class="paramLabel">Parameters:</span></dt>
  592. <dd><code>base</code> - the base range (<code>null</code> not permitted).</dd>
  593. <dd><code>delta</code> - the shift amount.</dd>
  594. <dd><code>allowZeroCrossing</code> - a flag that determines whether or not the
  595. bounds of the range are allowed to cross
  596. zero after adjustment.</dd>
  597. <dt><span class="returnLabel">Returns:</span></dt>
  598. <dd>A new range.</dd>
  599. </dl>
  600. </li>
  601. </ul>
  602. <a name="scale-org.jfree.data.Range-double-">
  603. <!-- -->
  604. </a>
  605. <ul class="blockList">
  606. <li class="blockList">
  607. <h4>scale</h4>
  608. <pre>public static&nbsp;<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.408">scale</a>(<a href="../../../org/jfree/data/Range.html" title="class in org.jfree.data">Range</a>&nbsp;base,
  609. double&nbsp;factor)</pre>
  610. <div class="block">Scales the range by the specified factor.</div>
  611. <dl>
  612. <dt><span class="paramLabel">Parameters:</span></dt>
  613. <dd><code>base</code> - the base range (<code>null</code> not permitted).</dd>
  614. <dd><code>factor</code> - the scaling factor (must be non-negative).</dd>
  615. <dt><span class="returnLabel">Returns:</span></dt>
  616. <dd>A new range.</dd>
  617. <dt><span class="simpleTagLabel">Since:</span></dt>
  618. <dd>1.0.9</dd>
  619. </dl>
  620. </li>
  621. </ul>
  622. <a name="equals-java.lang.Object-">
  623. <!-- -->
  624. </a>
  625. <ul class="blockList">
  626. <li class="blockList">
  627. <h4>equals</h4>
  628. <pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.425">equals</a>(java.lang.Object&nbsp;obj)</pre>
  629. <div class="block">Tests this object for equality with an arbitrary object.</div>
  630. <dl>
  631. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  632. <dd><code>equals</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  633. <dt><span class="paramLabel">Parameters:</span></dt>
  634. <dd><code>obj</code> - the object to test against (<code>null</code> permitted).</dd>
  635. <dt><span class="returnLabel">Returns:</span></dt>
  636. <dd>A boolean.</dd>
  637. </dl>
  638. </li>
  639. </ul>
  640. <a name="isNaNRange--">
  641. <!-- -->
  642. </a>
  643. <ul class="blockList">
  644. <li class="blockList">
  645. <h4>isNaNRange</h4>
  646. <pre>public&nbsp;boolean&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.447">isNaNRange</a>()</pre>
  647. <div class="block">Returns <code>true</code> if both the lower and upper bounds are
  648. <code>Double.NaN</code>, and <code>false</code> otherwise.</div>
  649. <dl>
  650. <dt><span class="returnLabel">Returns:</span></dt>
  651. <dd>A boolean.</dd>
  652. <dt><span class="simpleTagLabel">Since:</span></dt>
  653. <dd>1.0.18</dd>
  654. </dl>
  655. </li>
  656. </ul>
  657. <a name="hashCode--">
  658. <!-- -->
  659. </a>
  660. <ul class="blockList">
  661. <li class="blockList">
  662. <h4>hashCode</h4>
  663. <pre>public&nbsp;int&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.457">hashCode</a>()</pre>
  664. <div class="block">Returns a hash code.</div>
  665. <dl>
  666. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  667. <dd><code>hashCode</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  668. <dt><span class="returnLabel">Returns:</span></dt>
  669. <dd>A hash code.</dd>
  670. </dl>
  671. </li>
  672. </ul>
  673. <a name="toString--">
  674. <!-- -->
  675. </a>
  676. <ul class="blockListLast">
  677. <li class="blockList">
  678. <h4>toString</h4>
  679. <pre>public&nbsp;java.lang.String&nbsp;<a href="../../../src-html/org/jfree/data/Range.html#line.474">toString</a>()</pre>
  680. <div class="block">Returns a string representation of this Range.</div>
  681. <dl>
  682. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  683. <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
  684. <dt><span class="returnLabel">Returns:</span></dt>
  685. <dd>A String "Range[lower,upper]" where lower=lower range and
  686. upper=upper range.</dd>
  687. </dl>
  688. </li>
  689. </ul>
  690. </li>
  691. </ul>
  692. </li>
  693. </ul>
  694. </div>
  695. </div>
  696. <!-- ========= END OF CLASS DATA ========= -->
  697. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  698. <div class="bottomNav"><a name="navbar.bottom">
  699. <!-- -->
  700. </a>
  701. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  702. <a name="navbar.bottom.firstrow">
  703. <!-- -->
  704. </a>
  705. <ul class="navList" title="Navigation">
  706. <li><a href="../../../overview-summary.html">Overview</a></li>
  707. <li><a href="package-summary.html">Package</a></li>
  708. <li class="navBarCell1Rev">Class</li>
  709. <li><a href="class-use/Range.html">Use</a></li>
  710. <li><a href="package-tree.html">Tree</a></li>
  711. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
  712. <li><a href="../../../index-files/index-1.html">Index</a></li>
  713. <li><a href="../../../help-doc.html">Help</a></li>
  714. </ul>
  715. </div>
  716. <div class="subNav">
  717. <ul class="navList">
  718. <li><a href="../../../org/jfree/data/KeyToGroupMap.html" title="class in org.jfree.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  719. <li><a href="../../../org/jfree/data/RangeInfo.html" title="interface in org.jfree.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  720. </ul>
  721. <ul class="navList">
  722. <li><a href="../../../index.html?org/jfree/data/Range.html" target="_top">Frames</a></li>
  723. <li><a href="Range.html" target="_top">No&nbsp;Frames</a></li>
  724. </ul>
  725. <ul class="navList" id="allclasses_navbar_bottom">
  726. <li><a href="../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  727. </ul>
  728. <div>
  729. <script type="text/javascript"><!--
  730. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  731. if(window==top) {
  732. allClassesLink.style.display = "block";
  733. }
  734. else {
  735. allClassesLink.style.display = "none";
  736. }
  737. //-->
  738. </script>
  739. </div>
  740. <div>
  741. <ul class="subNavList">
  742. <li>Summary:&nbsp;</li>
  743. <li>Nested&nbsp;|&nbsp;</li>
  744. <li>Field&nbsp;|&nbsp;</li>
  745. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
  746. <li><a href="#method.summary">Method</a></li>
  747. </ul>
  748. <ul class="subNavList">
  749. <li>Detail:&nbsp;</li>
  750. <li>Field&nbsp;|&nbsp;</li>
  751. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
  752. <li><a href="#method.detail">Method</a></li>
  753. </ul>
  754. </div>
  755. <a name="skip.navbar.bottom">
  756. <!-- -->
  757. </a></div>
  758. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  759. </body>
  760. </html>