1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Precision (Apache Commons Math 3.6.1 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Precision (Apache Commons Math 3.6.1 API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Precision.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/math3/util/PivotingStrategyInterface.html" title="interface in org.apache.commons.math3.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/math3/util/RandomPivotingStrategy.html" title="class in org.apache.commons.math3.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/math3/util/Precision.html" target="_top">Frames</a></li>
<li><a href="Precision.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.commons.math3.util</div>
<h2 title="Class Precision" class="title">Class Precision</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.math3.util.Precision</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">Precision</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block">Utilities for comparing numbers.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.0</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#EPSILON">EPSILON</a></strong></code>
<div class="block">
Largest double-precision floating-point number such that
<code>1 + EPSILON</code> is numerically equal to 1.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#SAFE_MIN">SAFE_MIN</a></strong></code>
<div class="block">Safe minimum, such that <code>1 / SAFE_MIN</code> does not overflow.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#compareTo(double,%20double,%20double)">compareTo</a></strong>(double x,
double y,
double eps)</code>
<div class="block">Compares two numbers given some amount of allowed error.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#compareTo(double,%20double,%20int)">compareTo</a></strong>(double x,
double y,
int maxUlps)</code>
<div class="block">Compares two numbers given some amount of allowed error.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(double,%20double)">equals</a></strong>(double x,
double y)</code>
<div class="block">Returns true iff they are equal as defined by
<a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(double,%20double,%20int)"><code>equals(x, y, 1)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(double,%20double,%20double)">equals</a></strong>(double x,
double y,
double eps)</code>
<div class="block">Returns <code>true</code> if there is no double value strictly between the
arguments or the difference between them is within the range of allowed
error (inclusive).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(double,%20double,%20int)">equals</a></strong>(double x,
double y,
int maxUlps)</code>
<div class="block">Returns true if the arguments are equal or within the range of allowed
error (inclusive).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(float,%20float)">equals</a></strong>(float x,
float y)</code>
<div class="block">Returns true iff they are equal as defined by
<a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(float,%20float,%20int)"><code>equals(x, y, 1)</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(float,%20float,%20float)">equals</a></strong>(float x,
float y,
float eps)</code>
<div class="block">Returns true if the arguments are equal or within the range of allowed
error (inclusive).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(float,%20float,%20int)">equals</a></strong>(float x,
float y,
int maxUlps)</code>
<div class="block">Returns true if the arguments are equal or within the range of allowed
error (inclusive).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#equalsIncludingNaN(double,%20double)">equalsIncludingNaN</a></strong>(double x,
double y)</code>
<div class="block">Returns true if the arguments are both NaN or they are
equal as defined by <a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(double,%20double)"><code>equals(x, y, 1)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#equalsIncludingNaN(double,%20double,%20double)">equalsIncludingNaN</a></strong>(double x,
double y,
double eps)</code>
<div class="block">Returns true if the arguments are both NaN, are equal or are within the range
of allowed error (inclusive).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#equalsIncludingNaN(double,%20double,%20int)">equalsIncludingNaN</a></strong>(double x,
double y,
int maxUlps)</code>
<div class="block">Returns true if both arguments are NaN or if they are equal as defined
by <a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(double,%20double,%20int)"><code>equals(x, y, maxUlps)</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#equalsIncludingNaN(float,%20float)">equalsIncludingNaN</a></strong>(float x,
float y)</code>
<div class="block">Returns true if both arguments are NaN or they are
equal as defined by <a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(float,%20float)"><code>equals(x, y, 1)</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#equalsIncludingNaN(float,%20float,%20float)">equalsIncludingNaN</a></strong>(float x,
float y,
float eps)</code>
<div class="block">Returns true if the arguments are both NaN, are equal, or are within the range
of allowed error (inclusive).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#equalsIncludingNaN(float,%20float,%20int)">equalsIncludingNaN</a></strong>(float x,
float y,
int maxUlps)</code>
<div class="block">Returns true if the arguments are both NaN or if they are equal as defined
by <a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(float,%20float,%20int)"><code>equals(x, y, maxUlps)</code></a>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#equalsWithRelativeTolerance(double,%20double,%20double)">equalsWithRelativeTolerance</a></strong>(double x,
double y,
double eps)</code>
<div class="block">Returns <code>true</code> if there is no double value strictly between the
arguments or the relative difference between them is less than or equal
to the given tolerance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#representableDelta(double,%20double)">representableDelta</a></strong>(double x,
double originalDelta)</code>
<div class="block">Computes a number <code>delta</code> close to <code>originalDelta</code> with
the property that</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#round(double,%20int)">round</a></strong>(double x,
int scale)</code>
<div class="block">Rounds the given value to the specified number of decimal places.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static double</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#round(double,%20int,%20int)">round</a></strong>(double x,
int scale,
int roundingMethod)</code>
<div class="block">Rounds the given value to the specified number of decimal places.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static float</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#round(float,%20int)">round</a></strong>(float x,
int scale)</code>
<div class="block">Rounds the given value to the specified number of decimal places.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static float</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/util/Precision.html#round(float,%20int,%20int)">round</a></strong>(float x,
int scale,
int roundingMethod)</code>
<div class="block">Rounds the given value to the specified number of decimal places.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="EPSILON">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EPSILON</h4>
<pre>public static final double EPSILON</pre>
<div class="block"><p>
Largest double-precision floating-point number such that
<code>1 + EPSILON</code> is numerically equal to 1. This value is an upper
bound on the relative error due to rounding real numbers to double
precision floating-point numbers.
</p>
<p>
In IEEE 754 arithmetic, this is 2<sup>-53</sup>.
</p></div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="http://en.wikipedia.org/wiki/Machine_epsilon">Machine epsilon</a></dd></dl>
</li>
</ul>
<a name="SAFE_MIN">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SAFE_MIN</h4>
<pre>public static final double SAFE_MIN</pre>
<div class="block">Safe minimum, such that <code>1 / SAFE_MIN</code> does not overflow.
<br/>
In IEEE 754 arithmetic, this is also the smallest normalized
number 2<sup>-1022</sup>.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="compareTo(double, double, double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre>public static int compareTo(double x,
double y,
double eps)</pre>
<div class="block">Compares two numbers given some amount of allowed error.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - the first number</dd><dd><code>y</code> - the second number</dd><dd><code>eps</code> - the amount of error to allow when checking for equality</dd>
<dt><span class="strong">Returns:</span></dt><dd><ul><li>0 if <a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(double,%20double,%20double)"><code>equals(x, y, eps)</code></a></li>
<li>< 0 if !<a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(double,%20double,%20double)"><code>equals(x, y, eps)</code></a> && x < y</li>
<li>> 0 if !<a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(double,%20double,%20double)"><code>equals(x, y, eps)</code></a> && x > y or
either argument is NaN</li></ul></dd></dl>
</li>
</ul>
<a name="compareTo(double, double, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compareTo</h4>
<pre>public static int compareTo(double x,
double y,
int maxUlps)</pre>
<div class="block">Compares two numbers given some amount of allowed error.
Two float numbers are considered equal if there are <code>(maxUlps - 1)</code>
(or fewer) floating point numbers between them, i.e. two adjacent floating
point numbers are considered equal.
Adapted from <a
href="http://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/">
Bruce Dawson</a>. Returns <code>false</code> if either of the arguments is NaN.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - first value</dd><dd><code>y</code> - second value</dd><dd><code>maxUlps</code> - <code>(maxUlps - 1)</code> is the number of floating point
values between <code>x</code> and <code>y</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd><ul><li>0 if <a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(double,%20double,%20int)"><code>equals(x, y, maxUlps)</code></a></li>
<li>< 0 if !<a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(double,%20double,%20int)"><code>equals(x, y, maxUlps)</code></a> && x < y</li>
<li>> 0 if !<a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(double,%20double,%20int)"><code>equals(x, y, maxUlps)</code></a> && x > y
or either argument is NaN</li></ul></dd></dl>
</li>
</ul>
<a name="equals(float, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public static boolean equals(float x,
float y)</pre>
<div class="block">Returns true iff they are equal as defined by
<a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(float,%20float,%20int)"><code>equals(x, y, 1)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - first value</dd><dd><code>y</code> - second value</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the values are equal.</dd></dl>
</li>
</ul>
<a name="equalsIncludingNaN(float, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equalsIncludingNaN</h4>
<pre>public static boolean equalsIncludingNaN(float x,
float y)</pre>
<div class="block">Returns true if both arguments are NaN or they are
equal as defined by <a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(float,%20float)"><code>equals(x, y, 1)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - first value</dd><dd><code>y</code> - second value</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the values are equal or both are NaN.</dd><dt><span class="strong">Since:</span></dt>
<dd>2.2</dd></dl>
</li>
</ul>
<a name="equals(float, float, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public static boolean equals(float x,
float y,
float eps)</pre>
<div class="block">Returns true if the arguments are equal or within the range of allowed
error (inclusive). Returns <code>false</code> if either of the arguments
is NaN.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - first value</dd><dd><code>y</code> - second value</dd><dd><code>eps</code> - the amount of absolute error to allow.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the values are equal or within range of each other.</dd><dt><span class="strong">Since:</span></dt>
<dd>2.2</dd></dl>
</li>
</ul>
<a name="equalsIncludingNaN(float, float, float)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equalsIncludingNaN</h4>
<pre>public static boolean equalsIncludingNaN(float x,
float y,
float eps)</pre>
<div class="block">Returns true if the arguments are both NaN, are equal, or are within the range
of allowed error (inclusive).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - first value</dd><dd><code>y</code> - second value</dd><dd><code>eps</code> - the amount of absolute error to allow.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the values are equal or within range of each other,
or both are NaN.</dd><dt><span class="strong">Since:</span></dt>
<dd>2.2</dd></dl>
</li>
</ul>
<a name="equals(float, float, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public static boolean equals(float x,
float y,
int maxUlps)</pre>
<div class="block">Returns true if the arguments are equal or within the range of allowed
error (inclusive).
Two float numbers are considered equal if there are <code>(maxUlps - 1)</code>
(or fewer) floating point numbers between them, i.e. two adjacent floating
point numbers are considered equal.
Adapted from <a
href="http://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/">
Bruce Dawson</a>. Returns <code>false</code> if either of the arguments is NaN.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - first value</dd><dd><code>y</code> - second value</dd><dd><code>maxUlps</code> - <code>(maxUlps - 1)</code> is the number of floating point
values between <code>x</code> and <code>y</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if there are fewer than <code>maxUlps</code> floating
point values between <code>x</code> and <code>y</code>.</dd><dt><span class="strong">Since:</span></dt>
<dd>2.2</dd></dl>
</li>
</ul>
<a name="equalsIncludingNaN(float, float, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equalsIncludingNaN</h4>
<pre>public static boolean equalsIncludingNaN(float x,
float y,
int maxUlps)</pre>
<div class="block">Returns true if the arguments are both NaN or if they are equal as defined
by <a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(float,%20float,%20int)"><code>equals(x, y, maxUlps)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - first value</dd><dd><code>y</code> - second value</dd><dd><code>maxUlps</code> - <code>(maxUlps - 1)</code> is the number of floating point
values between <code>x</code> and <code>y</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if both arguments are NaN or if there are less than
<code>maxUlps</code> floating point values between <code>x</code> and <code>y</code>.</dd><dt><span class="strong">Since:</span></dt>
<dd>2.2</dd></dl>
</li>
</ul>
<a name="equals(double, double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public static boolean equals(double x,
double y)</pre>
<div class="block">Returns true iff they are equal as defined by
<a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(double,%20double,%20int)"><code>equals(x, y, 1)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - first value</dd><dd><code>y</code> - second value</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the values are equal.</dd></dl>
</li>
</ul>
<a name="equalsIncludingNaN(double, double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equalsIncludingNaN</h4>
<pre>public static boolean equalsIncludingNaN(double x,
double y)</pre>
<div class="block">Returns true if the arguments are both NaN or they are
equal as defined by <a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(double,%20double)"><code>equals(x, y, 1)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - first value</dd><dd><code>y</code> - second value</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the values are equal or both are NaN.</dd><dt><span class="strong">Since:</span></dt>
<dd>2.2</dd></dl>
</li>
</ul>
<a name="equals(double, double, double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public static boolean equals(double x,
double y,
double eps)</pre>
<div class="block">Returns <code>true</code> if there is no double value strictly between the
arguments or the difference between them is within the range of allowed
error (inclusive). Returns <code>false</code> if either of the arguments
is NaN.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - First value.</dd><dd><code>y</code> - Second value.</dd><dd><code>eps</code> - Amount of allowed absolute error.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the values are two adjacent floating point
numbers or they are within range of each other.</dd></dl>
</li>
</ul>
<a name="equalsWithRelativeTolerance(double, double, double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equalsWithRelativeTolerance</h4>
<pre>public static boolean equalsWithRelativeTolerance(double x,
double y,
double eps)</pre>
<div class="block">Returns <code>true</code> if there is no double value strictly between the
arguments or the relative difference between them is less than or equal
to the given tolerance. Returns <code>false</code> if either of the arguments
is NaN.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - First value.</dd><dd><code>y</code> - Second value.</dd><dd><code>eps</code> - Amount of allowed relative error.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the values are two adjacent floating point
numbers or they are within range of each other.</dd><dt><span class="strong">Since:</span></dt>
<dd>3.1</dd></dl>
</li>
</ul>
<a name="equalsIncludingNaN(double, double, double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equalsIncludingNaN</h4>
<pre>public static boolean equalsIncludingNaN(double x,
double y,
double eps)</pre>
<div class="block">Returns true if the arguments are both NaN, are equal or are within the range
of allowed error (inclusive).</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - first value</dd><dd><code>y</code> - second value</dd><dd><code>eps</code> - the amount of absolute error to allow.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the values are equal or within range of each other,
or both are NaN.</dd><dt><span class="strong">Since:</span></dt>
<dd>2.2</dd></dl>
</li>
</ul>
<a name="equals(double, double, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equals</h4>
<pre>public static boolean equals(double x,
double y,
int maxUlps)</pre>
<div class="block">Returns true if the arguments are equal or within the range of allowed
error (inclusive).
<p>
Two float numbers are considered equal if there are <code>(maxUlps - 1)</code>
(or fewer) floating point numbers between them, i.e. two adjacent
floating point numbers are considered equal.
</p>
<p>
Adapted from <a
href="http://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/">
Bruce Dawson</a>. Returns <code>false</code> if either of the arguments is NaN.
</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - first value</dd><dd><code>y</code> - second value</dd><dd><code>maxUlps</code> - <code>(maxUlps - 1)</code> is the number of floating point
values between <code>x</code> and <code>y</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if there are fewer than <code>maxUlps</code> floating
point values between <code>x</code> and <code>y</code>.</dd></dl>
</li>
</ul>
<a name="equalsIncludingNaN(double, double, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>equalsIncludingNaN</h4>
<pre>public static boolean equalsIncludingNaN(double x,
double y,
int maxUlps)</pre>
<div class="block">Returns true if both arguments are NaN or if they are equal as defined
by <a href="../../../../../org/apache/commons/math3/util/Precision.html#equals(double,%20double,%20int)"><code>equals(x, y, maxUlps)</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - first value</dd><dd><code>y</code> - second value</dd><dd><code>maxUlps</code> - <code>(maxUlps - 1)</code> is the number of floating point
values between <code>x</code> and <code>y</code>.</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if both arguments are NaN or if there are less than
<code>maxUlps</code> floating point values between <code>x</code> and <code>y</code>.</dd><dt><span class="strong">Since:</span></dt>
<dd>2.2</dd></dl>
</li>
</ul>
<a name="round(double, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>round</h4>
<pre>public static double round(double x,
int scale)</pre>
<div class="block">Rounds the given value to the specified number of decimal places.
The value is rounded using the <a href="http://docs.oracle.com/javase/7/docs/api/java/math/BigDecimal.html?is-external=true#ROUND_HALF_UP" title="class or interface in java.math"><code>BigDecimal.ROUND_HALF_UP</code></a> method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - Value to round.</dd><dd><code>scale</code> - Number of digits to the right of the decimal point.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the rounded value.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1 (previously in <code>MathUtils</code>, moved as of version 3.0)</dd></dl>
</li>
</ul>
<a name="round(double, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>round</h4>
<pre>public static double round(double x,
int scale,
int roundingMethod)</pre>
<div class="block">Rounds the given value to the specified number of decimal places.
The value is rounded using the given method which is any method defined
in <a href="http://docs.oracle.com/javase/7/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math"><code>BigDecimal</code></a>.
If <code>x</code> is infinite or <code>NaN</code>, then the value of <code>x</code> is
returned unchanged, regardless of the other parameters.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - Value to round.</dd><dd><code>scale</code> - Number of digits to the right of the decimal point.</dd><dd><code>roundingMethod</code> - Rounding method as defined in <a href="http://docs.oracle.com/javase/7/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math"><code>BigDecimal</code></a>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the rounded value.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/ArithmeticException.html?is-external=true" title="class or interface in java.lang">ArithmeticException</a></code> - if <code>roundingMethod == ROUND_UNNECESSARY</code>
and the specified scaling operation would require rounding.</dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>roundingMethod</code> does not
represent a valid rounding mode.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1 (previously in <code>MathUtils</code>, moved as of version 3.0)</dd></dl>
</li>
</ul>
<a name="round(float, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>round</h4>
<pre>public static float round(float x,
int scale)</pre>
<div class="block">Rounds the given value to the specified number of decimal places.
The value is rounded using the <a href="http://docs.oracle.com/javase/7/docs/api/java/math/BigDecimal.html?is-external=true#ROUND_HALF_UP" title="class or interface in java.math"><code>BigDecimal.ROUND_HALF_UP</code></a> method.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - Value to round.</dd><dd><code>scale</code> - Number of digits to the right of the decimal point.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the rounded value.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1 (previously in <code>MathUtils</code>, moved as of version 3.0)</dd></dl>
</li>
</ul>
<a name="round(float, int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>round</h4>
<pre>public static float round(float x,
int scale,
int roundingMethod)
throws <a href="../../../../../org/apache/commons/math3/exception/MathArithmeticException.html" title="class in org.apache.commons.math3.exception">MathArithmeticException</a>,
<a href="../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></pre>
<div class="block">Rounds the given value to the specified number of decimal places.
The value is rounded using the given method which is any method defined
in <a href="http://docs.oracle.com/javase/7/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math"><code>BigDecimal</code></a>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - Value to round.</dd><dd><code>scale</code> - Number of digits to the right of the decimal point.</dd><dd><code>roundingMethod</code> - Rounding method as defined in <a href="http://docs.oracle.com/javase/7/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math"><code>BigDecimal</code></a>.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the rounded value.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../org/apache/commons/math3/exception/MathArithmeticException.html" title="class in org.apache.commons.math3.exception">MathArithmeticException</a></code> - if an exact operation is required but result is not exact</dd>
<dd><code><a href="../../../../../org/apache/commons/math3/exception/MathIllegalArgumentException.html" title="class in org.apache.commons.math3.exception">MathIllegalArgumentException</a></code> - if <code>roundingMethod</code> is not a valid rounding method.</dd><dt><span class="strong">Since:</span></dt>
<dd>1.1 (previously in <code>MathUtils</code>, moved as of version 3.0)</dd></dl>
</li>
</ul>
<a name="representableDelta(double, double)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>representableDelta</h4>
<pre>public static double representableDelta(double x,
double originalDelta)</pre>
<div class="block">Computes a number <code>delta</code> close to <code>originalDelta</code> with
the property that <pre><code>
x + delta - x
</code></pre>
is exactly machine-representable.
This is useful when computing numerical derivatives, in order to reduce
roundoff errors.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>x</code> - Value.</dd><dd><code>originalDelta</code> - Offset value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a number <code>delta</code> so that <code>x + delta</code> and <code>x</code>
differ by a representable floating number.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Precision.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/math3/util/PivotingStrategyInterface.html" title="interface in org.apache.commons.math3.util"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/math3/util/RandomPivotingStrategy.html" title="class in org.apache.commons.math3.util"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/math3/util/Precision.html" target="_top">Frames</a></li>
<li><a href="Precision.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright © 2003–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
|