(systemds) branch main updated: [MINOR] Add doc string to Util eq

[ba...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

baunsgaard pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/systemds.git


The following commit(s) were added to refs/heads/main by this push:
     new a9b6db48e9 [MINOR] Add doc string to Util eq
a9b6db48e9 is described below

commit a9b6db48e9e23ee460ee45752e3f1e5a18cd16b8
Author: Sebastian Baunsgaard <ba...@apache.org>
AuthorDate: Fri Jul 5 17:37:16 2024 +0200

    [MINOR] Add doc string to Util eq
    
    This commit is mainly to activate CodeCov to see
    test coverage. But on the other hand it adds a doc
    string.
---
 src/main/java/org/apache/sysds/runtime/compress/utils/Util.java | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/main/java/org/apache/sysds/runtime/compress/utils/Util.java b/src/main/java/org/apache/sysds/runtime/compress/utils/Util.java
index b7a6048c27..bef5208225 100644
--- a/src/main/java/org/apache/sysds/runtime/compress/utils/Util.java
+++ b/src/main/java/org/apache/sysds/runtime/compress/utils/Util.java
@@ -103,6 +103,13 @@ public interface Util {
 		return rowVector;
 	}
 
+	/**
+	 * Nan Enabled equals operator returns true on Nan == Nan.
+	 * 
+	 * @param a value 1
+	 * @param b value 2
+	 * @return if they are equal on the bit level.
+	 */
 	public static boolean eq(double a, double b) {
 		long al = Double.doubleToRawLongBits(a);
 		long bl = Double.doubleToRawLongBits(b);