src/Pure/General/timing.scala
author wenzelm
Thu, 24 Apr 2014 11:01:14 +0200
changeset 56691 ad5d7461b370
parent 55618 995162143ef4
child 56782 433cf57550fa
permissions -rw-r--r--
tuned signature, in accordance to ML version;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
40393
2bb7ec08574a somewhat more uniform timing in ML vs. Scala;
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/General/timing.scala
46768
46acd255810d relevant timing as in ML;
wenzelm
parents: 45674
diff changeset
     2
    Module:     PIDE
40393
2bb7ec08574a somewhat more uniform timing in ML vs. Scala;
wenzelm
parents:
diff changeset
     3
    Author:     Makarius
2bb7ec08574a somewhat more uniform timing in ML vs. Scala;
wenzelm
parents:
diff changeset
     4
2bb7ec08574a somewhat more uniform timing in ML vs. Scala;
wenzelm
parents:
diff changeset
     5
Basic support for time measurement.
2bb7ec08574a somewhat more uniform timing in ML vs. Scala;
wenzelm
parents:
diff changeset
     6
*/
2bb7ec08574a somewhat more uniform timing in ML vs. Scala;
wenzelm
parents:
diff changeset
     7
2bb7ec08574a somewhat more uniform timing in ML vs. Scala;
wenzelm
parents:
diff changeset
     8
package isabelle
2bb7ec08574a somewhat more uniform timing in ML vs. Scala;
wenzelm
parents:
diff changeset
     9
45664
ac6e704dcd12 tuned signature (according to ML version);
wenzelm
parents: 45249
diff changeset
    10
ac6e704dcd12 tuned signature (according to ML version);
wenzelm
parents: 45249
diff changeset
    11
object Timing
ac6e704dcd12 tuned signature (according to ML version);
wenzelm
parents: 45249
diff changeset
    12
{
51587
7050c4656fd8 more operations on Time, Timing;
wenzelm
parents: 47653
diff changeset
    13
  val zero = Timing(Time.zero, Time.zero, Time.zero)
7050c4656fd8 more operations on Time, Timing;
wenzelm
parents: 47653
diff changeset
    14
47653
4605d4341b8b some builtin session timing;
wenzelm
parents: 46768
diff changeset
    15
  def timeit[A](message: String, enabled: Boolean = true)(e: => A) =
4605d4341b8b some builtin session timing;
wenzelm
parents: 46768
diff changeset
    16
    if (enabled) {
56691
ad5d7461b370 tuned signature, in accordance to ML version;
wenzelm
parents: 55618
diff changeset
    17
      val start = Time.now()
47653
4605d4341b8b some builtin session timing;
wenzelm
parents: 46768
diff changeset
    18
      val result = Exn.capture(e)
56691
ad5d7461b370 tuned signature, in accordance to ML version;
wenzelm
parents: 55618
diff changeset
    19
      val stop = Time.now()
46768
46acd255810d relevant timing as in ML;
wenzelm
parents: 45674
diff changeset
    20
56691
ad5d7461b370 tuned signature, in accordance to ML version;
wenzelm
parents: 55618
diff changeset
    21
      val timing = stop - start
47653
4605d4341b8b some builtin session timing;
wenzelm
parents: 46768
diff changeset
    22
      if (timing.is_relevant)
55618
995162143ef4 tuned imports;
wenzelm
parents: 51587
diff changeset
    23
        System.err.println(
47653
4605d4341b8b some builtin session timing;
wenzelm
parents: 46768
diff changeset
    24
          (if (message == null || message.isEmpty) "" else message + ": ") +
4605d4341b8b some builtin session timing;
wenzelm
parents: 46768
diff changeset
    25
            timing.message + " elapsed time")
46768
46acd255810d relevant timing as in ML;
wenzelm
parents: 45674
diff changeset
    26
47653
4605d4341b8b some builtin session timing;
wenzelm
parents: 46768
diff changeset
    27
      Exn.release(result)
4605d4341b8b some builtin session timing;
wenzelm
parents: 46768
diff changeset
    28
    }
4605d4341b8b some builtin session timing;
wenzelm
parents: 46768
diff changeset
    29
    else e
45664
ac6e704dcd12 tuned signature (according to ML version);
wenzelm
parents: 45249
diff changeset
    30
}
ac6e704dcd12 tuned signature (according to ML version);
wenzelm
parents: 45249
diff changeset
    31
51587
7050c4656fd8 more operations on Time, Timing;
wenzelm
parents: 47653
diff changeset
    32
sealed case class Timing(elapsed: Time, cpu: Time, gc: Time)
40848
8662b9b1f123 more abstract/uniform handling of time, preferring seconds as Double;
wenzelm
parents: 40393
diff changeset
    33
{
46768
46acd255810d relevant timing as in ML;
wenzelm
parents: 45674
diff changeset
    34
  def is_relevant: Boolean = elapsed.is_relevant || cpu.is_relevant || gc.is_relevant
46acd255810d relevant timing as in ML;
wenzelm
parents: 45674
diff changeset
    35
51587
7050c4656fd8 more operations on Time, Timing;
wenzelm
parents: 47653
diff changeset
    36
  def + (t: Timing): Timing = Timing(elapsed + t.elapsed, cpu + t.cpu, gc + t.gc)
7050c4656fd8 more operations on Time, Timing;
wenzelm
parents: 47653
diff changeset
    37
40848
8662b9b1f123 more abstract/uniform handling of time, preferring seconds as Double;
wenzelm
parents: 40393
diff changeset
    38
  def message: String =
8662b9b1f123 more abstract/uniform handling of time, preferring seconds as Double;
wenzelm
parents: 40393
diff changeset
    39
    elapsed.message + " elapsed time, " + cpu.message + " cpu time, " + gc.message + " GC time"
46768
46acd255810d relevant timing as in ML;
wenzelm
parents: 45674
diff changeset
    40
40848
8662b9b1f123 more abstract/uniform handling of time, preferring seconds as Double;
wenzelm
parents: 40393
diff changeset
    41
  override def toString = message
8662b9b1f123 more abstract/uniform handling of time, preferring seconds as Double;
wenzelm
parents: 40393
diff changeset
    42
}
8662b9b1f123 more abstract/uniform handling of time, preferring seconds as Double;
wenzelm
parents: 40393
diff changeset
    43