diff options
| author | Adrien Hopkins <masterofnumbers17@gmail.com> | 2019-12-24 16:16:13 -0500 |
|---|---|---|
| committer | Adrien Hopkins <masterofnumbers17@gmail.com> | 2019-12-24 16:16:13 -0500 |
| commit | 2c146c894972e2c6ab701b3c66dcf242d7be656f (patch) | |
| tree | 8629866fa1cf017c02d61bd288fd336e7d8b7b49 /doc/org/unitConverter/math/DecimalComparison.html | |
| parent | e1e7e38482de8cf8f6d4fd8735b6e43ad2a13cb8 (diff) | |
Added Javadoc to the project.
Diffstat (limited to 'doc/org/unitConverter/math/DecimalComparison.html')
| -rw-r--r-- | doc/org/unitConverter/math/DecimalComparison.html | 492 |
1 files changed, 492 insertions, 0 deletions
diff --git a/doc/org/unitConverter/math/DecimalComparison.html b/doc/org/unitConverter/math/DecimalComparison.html new file mode 100644 index 0000000..6b013fc --- /dev/null +++ b/doc/org/unitConverter/math/DecimalComparison.html @@ -0,0 +1,492 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (1.8.0_232) on Tue Dec 24 16:10:16 EST 2019 --> +<title>DecimalComparison</title> +<meta name="date" content="2019-12-24"> +<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> +<script type="text/javascript" src="../../../script.js"></script> +</head> +<body> +<script type="text/javascript"><!-- + try { + if (location.href.indexOf('is-external=true') == -1) { + parent.document.title="DecimalComparison"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]}; +var altColor = "altColor"; +var rowColor = "rowColor"; +var tableTab = "tableTab"; +var activeTableTab = "activeTableTab"; +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<!-- ========= START OF TOP NAVBAR ======= --> +<div class="topNav"><a name="navbar.top"> +<!-- --> +</a> +<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> +<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/DecimalComparison.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-files/index-1.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/unitConverter/math/ConditionalExistenceCollections.html" title="class in org.unitConverter.math"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/unitConverter/math/ExpressionParser.html" title="class in org.unitConverter.math"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/unitConverter/math/DecimalComparison.html" target="_top">Frames</a></li> +<li><a href="DecimalComparison.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.unitConverter.math</div> +<h2 title="Class DecimalComparison" class="title">Class DecimalComparison</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>org.unitConverter.math.DecimalComparison</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public final class <span class="typeNameLabel">DecimalComparison</span> +extends java.lang.Object</pre> +<div class="block">A class that contains methods to compare float and double values.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-03-18, v0.2.0</dd> +<dt><span class="simpleTagLabel">Author:</span></dt> +<dd>Adrien Hopkins</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="memberSummary" 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><span class="memberNameLink"><a href="../../../org/unitConverter/math/DecimalComparison.html#DOUBLE_EPSILON">DOUBLE_EPSILON</a></span></code> +<div class="block">The value used for double comparison.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static float</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/math/DecimalComparison.html#FLOAT_EPSILON">FLOAT_EPSILON</a></span></code> +<div class="block">The value used for float comparison.</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr id="i0" class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/math/DecimalComparison.html#equals-double-double-">equals</a></span>(double a, + double b)</code> +<div class="block">Tests for equality of double values using <a href="../../../org/unitConverter/math/DecimalComparison.html#DOUBLE_EPSILON"><code>DOUBLE_EPSILON</code></a>.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/math/DecimalComparison.html#equals-double-double-double-">equals</a></span>(double a, + double b, + double epsilon)</code> +<div class="block">Tests for double equality using a custom epsilon value.</div> +</td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/math/DecimalComparison.html#equals-float-float-">equals</a></span>(float a, + float b)</code> +<div class="block">Tests for equality of float values using <a href="../../../org/unitConverter/math/DecimalComparison.html#FLOAT_EPSILON"><code>FLOAT_EPSILON</code></a>.</div> +</td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/math/DecimalComparison.html#equals-float-float-float-">equals</a></span>(float a, + float b, + float epsilon)</code> +<div class="block">Tests for float equality using a custom epsilon value.</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static int</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/unitConverter/math/DecimalComparison.html#hash-double-">hash</a></span>(double d)</code> +<div class="block">Takes the hash code of doubles.</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.Object</h3> +<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</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="DOUBLE_EPSILON"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DOUBLE_EPSILON</h4> +<pre>public static final double DOUBLE_EPSILON</pre> +<div class="block">The value used for double comparison. If two double values are within this value multiplied by the larger value, + they are considered equal.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-03-18, v0.2.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#org.unitConverter.math.DecimalComparison.DOUBLE_EPSILON">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="FLOAT_EPSILON"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>FLOAT_EPSILON</h4> +<pre>public static final float FLOAT_EPSILON</pre> +<div class="block">The value used for float comparison. If two float values are within this value multiplied by the larger value, + they are considered equal.</div> +<dl> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-03-18, v0.2.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#org.unitConverter.math.DecimalComparison.FLOAT_EPSILON">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="equals-double-double-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public static final boolean equals(double a, + double b)</pre> +<div class="block">Tests for equality of double values using <a href="../../../org/unitConverter/math/DecimalComparison.html#DOUBLE_EPSILON"><code>DOUBLE_EPSILON</code></a>. + <p> + <strong>WARNING: </strong>this method is not technically transitive. If a and b are off by slightly less than + <code>epsilon * max(abs(a), abs(b))</code>, and b and c are off by slightly less than + <code>epsilon * max(abs(b), abs(c))</code>, then equals(a, b) and equals(b, c) will both return true, but equals(a, c) + will return false. However, this situation is very unlikely to ever happen in a real programming situation. + <p> + If this does become a concern, some ways to solve this problem: + <ol> + <li>Raise the value of epsilon using <a href="../../../org/unitConverter/math/DecimalComparison.html#equals-double-double-double-"><code>equals(double, double, double)</code></a> (this does not make a violation of + transitivity impossible, it just significantly reduces the chances of it happening) + <li>Use <code>BigDecimal</code> instead of <code>double</code> (this will make a violation of transitivity 100% impossible) + </ol></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>a</code> - first value to test</dd> +<dd><code>b</code> - second value to test</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether they are equal</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-03-18, v0.2.0</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><code>#hashCode(double)</code></dd> +</dl> +</li> +</ul> +<a name="equals-double-double-double-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public static final boolean equals(double a, + double b, + double epsilon)</pre> +<div class="block">Tests for double equality using a custom epsilon value. + + <p> + <strong>WARNING: </strong>this method is not technically transitive. If a and b are off by slightly less than + <code>epsilon * max(abs(a), abs(b))</code>, and b and c are off by slightly less than + <code>epsilon * max(abs(b), abs(c))</code>, then equals(a, b) and equals(b, c) will both return true, but equals(a, c) + will return false. However, this situation is very unlikely to ever happen in a real programming situation. + <p> + If this does become a concern, some ways to solve this problem: + <ol> + <li>Raise the value of epsilon (this does not make a violation of transitivity impossible, it just significantly + reduces the chances of it happening) + <li>Use <code>BigDecimal</code> instead of <code>double</code> (this will make a violation of transitivity 100% impossible) + </ol></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>a</code> - first value to test</dd> +<dd><code>b</code> - second value to test</dd> +<dd><code>epsilon</code> - allowed difference</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether they are equal</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-03-18, v0.2.0</dd> +</dl> +</li> +</ul> +<a name="equals-float-float-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public static final boolean equals(float a, + float b)</pre> +<div class="block">Tests for equality of float values using <a href="../../../org/unitConverter/math/DecimalComparison.html#FLOAT_EPSILON"><code>FLOAT_EPSILON</code></a>. + + <p> + <strong>WARNING: </strong>this method is not technically transitive. If a and b are off by slightly less than + <code>epsilon * max(abs(a), abs(b))</code>, and b and c are off by slightly less than + <code>epsilon * max(abs(b), abs(c))</code>, then equals(a, b) and equals(b, c) will both return true, but equals(a, c) + will return false. However, this situation is very unlikely to ever happen in a real programming situation. + <p> + If this does become a concern, some ways to solve this problem: + <ol> + <li>Raise the value of epsilon using <a href="../../../org/unitConverter/math/DecimalComparison.html#equals-float-float-float-"><code>equals(float, float, float)</code></a> (this does not make a violation of + transitivity impossible, it just significantly reduces the chances of it happening) + <li>Use <code>BigDecimal</code> instead of <code>float</code> (this will make a violation of transitivity 100% impossible) + </ol></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>a</code> - first value to test</dd> +<dd><code>b</code> - second value to test</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether they are equal</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-03-18, v0.2.0</dd> +</dl> +</li> +</ul> +<a name="equals-float-float-float-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public static final boolean equals(float a, + float b, + float epsilon)</pre> +<div class="block">Tests for float equality using a custom epsilon value. + + <p> + <strong>WARNING: </strong>this method is not technically transitive. If a and b are off by slightly less than + <code>epsilon * max(abs(a), abs(b))</code>, and b and c are off by slightly less than + <code>epsilon * max(abs(b), abs(c))</code>, then equals(a, b) and equals(b, c) will both return true, but equals(a, c) + will return false. However, this situation is very unlikely to ever happen in a real programming situation. + <p> + If this does become a concern, some ways to solve this problem: + <ol> + <li>Raise the value of epsilon (this does not make a violation of transitivity impossible, it just significantly + reduces the chances of it happening) + <li>Use <code>BigDecimal</code> instead of <code>float</code> (this will make a violation of transitivity 100% impossible) + </ol></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>a</code> - first value to test</dd> +<dd><code>b</code> - second value to test</dd> +<dd><code>epsilon</code> - allowed difference</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether they are equal</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-03-18, v0.2.0</dd> +</dl> +</li> +</ul> +<a name="hash-double-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>hash</h4> +<pre>public static final int hash(double d)</pre> +<div class="block">Takes the hash code of doubles. Values that are equal according to <a href="../../../org/unitConverter/math/DecimalComparison.html#equals-double-double-"><code>equals(double, double)</code></a> will have the + same hash code.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>d</code> - double to hash</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>hash code of double</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>2019-10-16</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> +<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> +<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/DecimalComparison.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-files/index-1.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../org/unitConverter/math/ConditionalExistenceCollections.html" title="class in org.unitConverter.math"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/unitConverter/math/ExpressionParser.html" title="class in org.unitConverter.math"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/unitConverter/math/DecimalComparison.html" target="_top">Frames</a></li> +<li><a href="DecimalComparison.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 ======= --> +</body> +</html> |