<div dir="ltr"><div dir="ltr">On Fri, Nov 1, 2024 at 8:42 PM Joseph D. Darcy <<a href="mailto:joe.darcy@oracle.com">joe.darcy@oracle.com</a>> wrote:</div><div class="gmail_quote"><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><u></u>

  
  <div>
    <p>A few releases back, a discussion of "quality, equivalence, and
      comparison of floating-point values" was added to
      java.lang.Double:</p>
    <p><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Double.html#equivalenceRelation" target="_blank">https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Double.html#equivalenceRelation</a></p>
    <p>That note discusses the topics in question.</p></div></blockquote><div>Thanks Joe, that's exactly what I was missing. Saying "equivalent to" without defining the equivalence relation seems to leave room for confusion.  </div><div><br></div><div>I see the API note of Float/Double::equals link to this note. Do you think it would be useful / worthwhile to add a @linkplain from the NaN descriptions as well, like this?</div><div><br></div></div><span style="font-family:monospace">     /**</span><br><span style="font-family:monospace">      * A constant holding a Not-a-Number (NaN) value of type</span><br><span style="font-family:monospace">-     * {@code float}.  It is equivalent to the value returned by</span><br><span style="font-family:monospace">-     * {@code Float.intBitsToFloat(0x7fc00000)}.</span><br><span style="font-family:monospace">+     * {@code float}.  It is {@linkplain Double##equivalenceRelation equivalent}</span><br><span style="font-family:monospace">+     * to the value returned by {@code Float.intBitsToFloat(0x7fc00000)}.</span><br><span style="font-family:monospace">      */</span><br><div class="gmail_quote"><div><font face="monospace">     public static final float NaN = 0.0f / 0.0f;</font></div></div><div class="gmail_quote"><div><br>Cheers,<br></div><div>Eirik.</div></div></div>