Add support for timeDelta.totalMicroseconds and totalMilliseconds (#2…

…6798)

[reviewed by @DanilaFe and @bradcray]

Resolves #26658 

Note that the implementation for totalMicroseconds is strongly based on
the suggestion from ajpotts, so credit to it should go to her and the
Arkouda team.

Updated some tests and a module that were converting the result of
totalSeconds to microseconds so that they use the new method instead.

Added a test of the new methods.

Passed a standard paratest with futures and a performance run of
`test/studies/ssca2` looked to be at the same granularity for the units
printed out.

modules/packages/NPBRandom.chpl

@@ -70,7 +70,7 @@
     */
     proc oddTimeSeed(): int(64) {
       use Time;
-      const seed = (timeSinceEpoch().totalSeconds()*1_000_000): int;
+      const seed = timeSinceEpoch().totalMicroseconds();
       const oddseed = if seed % 2 == 0 then seed + 1 else seed;
       return oddseed;
     }

modules/standard/Time.chpl

@@ -1746,6 +1746,17 @@ module Time {
     return days*(24*60*60) + seconds + microseconds / 1000000.0;
   }
 
+  /* Return the total number of milliseconds represented by this object */
+  @unstable("'timeDelta.totalMilliseconds()' is unstable because it is new")
+  proc timeDelta.totalMilliseconds(): real {
+    return (days*(24*60*60) + seconds)*1000 + microseconds / 1000.0;
+  }
+
+  /* Return the total number of microseconds represented by this object */
+  @unstable("'timeDelta.totalMicroseconds()' is unstable because it is new")
+  proc timeDelta.totalMicroseconds(): int {
+    return (days*(24*60*60) + seconds)*1_000_000 + microseconds;
+  }
 
   /* Operators on timeDelta values */
 

test/library/standard/Time/dateTime/checkTotalMicro.chpl

@@ -0,0 +1,7 @@
+use Time;
+
+var a = new timeDelta(microseconds=10);
+writeln(a.totalMicroseconds());
+
+var b = new timeDelta(minutes=2, seconds=3);
+writeln(b.totalMicroseconds());

test/library/standard/Time/dateTime/checkTotalMicro.good

@@ -0,0 +1,2 @@
+10
+123000000

test/library/standard/Time/dateTime/checkTotalMilli.chpl

@@ -0,0 +1,7 @@
+use Time;
+
+var a = new timeDelta(milliseconds=10);
+writeln(isClose(a.totalMilliseconds(), 10.0));
+
+var b = new timeDelta(minutes=2, seconds=3);
+writeln(isClose(b.totalMilliseconds(), 123000.0));

test/library/standard/Time/dateTime/checkTotalMilli.good

@@ -0,0 +1,2 @@
+true
+true

test/studies/ssca2/main/SSCA2_Modules/SSCA2_RMAT_graph_generator.chpl

@@ -167,7 +167,7 @@ proc Gen_RMAT_graph ( a : real,
 
     var rndPos = 1;
     const seed = if REPRODUCIBLE_PROBLEMS then 0556707007
-                                          else (timeSinceEpoch().totalSeconds()*1_000_000+1):int;
+                                          else timeSinceEpoch().totalMicroseconds()+1;
 
     const delta = n_raw_edges + 1; // 1 corresponds to 'skip' in "old" code
     rndPos += 1;                   // start with a skip

test/users/franzf/v0/chpl/main.chpl

@@ -71,11 +71,11 @@ proc main() {
     }    
 
     //  benchmark computation
-    startTime = timeSinceEpoch().totalSeconds() * 1_000_000;
+    startTime = timeSinceEpoch().totalMicroseconds();
     for i in 1..NUMRUNS {
       fft(N, Y, X);
     }
-    execTime = (timeSinceEpoch().totalSeconds()*1_000_000 - startTime)/NUMRUNS;
+    execTime = (timeSinceEpoch().totalMicroseconds() - startTime)/NUMRUNS;
     if (printTimings) then
       writeln("fft_", N, ": ", execTime, "us = ", ops / execTime, " Mflop/s");
     else

test/users/franzf/v1/chpl/main.chpl

@@ -71,11 +71,11 @@ proc main() {
     }    
 
     //  benchmark computation
-    startTime = timeSinceEpoch().totalSeconds()*1_000_000;
+    startTime = timeSinceEpoch().totalMicroseconds();
     for i in 1..NUMRUNS {
       fft(N, Y, X);
     }
-    execTime = (timeSinceEpoch().totalSeconds()*1_000_000 - startTime)/NUMRUNS;
+    execTime = (timeSinceEpoch().totalMicroseconds() - startTime)/NUMRUNS;
     if (printTimings) then
       writeln("fft_", N, ": ", execTime, "us = ", ops / execTime, " Mflop/s");
     else

test/users/franzf/v2/chpl/main.chpl

@@ -71,11 +71,11 @@ proc main() {
         }    
 
         //  benchmark computation
-        startTime = timeSinceEpoch().totalSeconds()*1_000_000;
+        startTime = timeSinceEpoch().totalMicroseconds();
         for i in 1..NUMRUNS {
             fft(N, Y, X);
         }
-        execTime = (timeSinceEpoch().totalSeconds()*1_000_000 - startTime)/NUMRUNS;
+        execTime = (timeSinceEpoch().totalMicroseconds() - startTime)/NUMRUNS;
 	if (printTimings) then
           writeln("fft_", N, ": ", execTime, "us = ", ops / execTime, " Mflop/s");
 	else