evt-diagnostics-sample 0.1.2.0 → 0.2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eaebb460a7afe3e75318cff5e3a456e629465e610bcba05ec5e92fa269dc3ce5
-  data.tar.gz: 861b6d711a66daae5d3ada8ee851ba63979b21b272eca714e4325ff2c6b6e4bc
+  metadata.gz: b85388ac039ba0e556809c31e671596ccf18f8f22c906e03ab2d1a024d1543e4
+  data.tar.gz: 8b59915f3a766aa2bcf19f4c6c5f7ef41d6263c4c3909bcd027868a100cce6da
 SHA512:
-  metadata.gz: 6140d6cd712f5560695aa9224d6d869fb8cf95c274fb7817cb52a9fc9ae4740d4ccd6cf01c864fde1c5418e8e1851f64beb01897c9762ae734500e855892cb6e
-  data.tar.gz: 0465da295d038744547a5c583fde76fa26324c6a793437b274d57abaa69624f116ef74fed02d6bb8f6f6089e049b929f33cf148916d604f42a527c371764b93a
+  metadata.gz: ad0d0ec1d27171db800c8f433017bd73ee321b3ed03a770ee956f8177152a8fbc008f7b9528a2fb55760c6402433871f55cd5ad6d27ea30e7a045238b443773f
+  data.tar.gz: 3efe0d3c1cb7927498b6922b7aa1da240be5c8bc24966ced2ac3f5ce1829e88b76cf22355ad75b994aaa8473ffe9e7db11fb00774940b873af0e09ba42c56c86

data/lib/diagnostics/sample/controls.rb

@@ -3,4 +3,8 @@ require 'clock/controls'
 require 'diagnostics/sample/controls/clock'
 require 'diagnostics/sample/controls/time'
 
+require 'diagnostics/sample/controls/frequency'
+require 'diagnostics/sample/controls/mean'
 require 'diagnostics/sample/controls/standard_deviation'
+
+require 'diagnostics/sample/controls/result'

data/lib/diagnostics/sample/controls/frequency.rb

@@ -0,0 +1,19 @@
+module Diagnostics
+  class Sample
+    module Controls
+      module Frequency
+        module Values
+          def self.milliseconds
+            Mean::Values.example
+          end
+        end
+
+        module Result
+          def self.example
+            1_000 / Mean::Result.example
+          end
+        end
+      end
+    end
+  end
+end

data/lib/diagnostics/sample/controls/mean.rb

@@ -0,0 +1,19 @@
+module Diagnostics
+  class Sample
+    module Controls
+      module Mean
+        module Values
+          def self.example
+            [1, 1, 1, 11, 111]
+          end
+        end
+
+        module Result
+          def self.example
+            25
+          end
+        end
+      end
+    end
+  end
+end

data/lib/diagnostics/sample/controls/result.rb

@@ -0,0 +1,35 @@
+module Diagnostics
+  class Sample
+    module Controls
+      module Result
+        def self.example
+          result = Sample::Result.new
+
+          StandardDeviation::Values.example.each do |value|
+            result.cycle(value)
+          end
+
+          result
+        end
+
+        module Digest
+          def self.example
+            values = [
+              StandardDeviation::Values.sum,
+              StandardDeviation::Values.mean,
+              StandardDeviation::Values.frequency,
+              StandardDeviation::Result.example
+            ]
+
+            <<~TEXT % values
+              Cycle Time: %fms
+              Mean Cycle Time: %fms
+              Cycles Per Second: %f
+              Cycle Time Standard Deviation: %fms
+            TEXT
+          end
+        end
+      end
+    end
+  end
+end

data/lib/diagnostics/sample/controls/standard_deviation.rb

@@ -3,12 +3,28 @@ module Diagnostics
     module Controls
       module StandardDeviation
         # Source: https://en.wikipedia.org/wiki/Standard_deviation#Population_standard_deviation_of_grades_of_eight_students (Nathan Ladd, Wed 30 May 2018)
-        def self.values
-          [2, 4, 4, 4, 5, 5, 7, 9]
+        module Values
+          def self.example
+            [2, 4, 4, 4, 5, 5, 7, 9]
+          end
+
+          def self.sum
+            40
+          end
+
+          def self.mean
+            5
+          end
+
+          def self.frequency
+            200
+          end
         end
 
-        def self.result
-          2
+        module Result
+          def self.example
+            2
+          end
         end
       end
     end

data/lib/diagnostics/sample/measure.rb

@@ -47,11 +47,11 @@ module Diagnostics
 
         ::GC.enable unless gc
 
-        elapsed_time = end_time - start_time
+        elapsed_time_nanoseconds = end_time - start_time
 
-        logger.trace { "Action measured (GC: #{gc.inspect}, Elapsed Time: #{LogText.elapsed_time_milliseconds(elapsed_time)})" }
+        logger.trace { "Action measured (GC: #{gc.inspect}, Elapsed Time: #{LogText.elapsed_time_milliseconds(elapsed_time_nanoseconds)})" }
 
-        elapsed_time
+        elapsed_time_nanoseconds
       end
 
       module LogText

data/lib/diagnostics/sample/result.rb

@@ -23,7 +23,7 @@ module Diagnostics
         cycle_time_milliseconds / cycles
       end
 
-      def cycle_frequency
+      def cycles_per_second
         cycles / (cycle_time_milliseconds / 1_000)
       end
 
@@ -32,6 +32,7 @@ module Diagnostics
 
         Math.sqrt(variance)
       end
+      alias_method :standard_deviation, :cycle_time_standard_deviation
 
       def warmup_cycle(elapsed_time)
         self.warmup_cycle_time_milliseconds += elapsed_time
@@ -45,7 +46,7 @@ module Diagnostics
         warmup_cycle_time_milliseconds / warmup_cycles
       end
 
-      def warmup_cycle_frequency
+      def warmup_cycles_per_second
         warmup_cycles / (warmup_cycle_time_milliseconds / 1_000)
       end
 
@@ -54,6 +55,16 @@ module Diagnostics
 
         Math.sqrt(variance)
       end
+
+      def digest
+        <<~TEXT % [cycle_time_milliseconds, mean_cycle_time_milliseconds, cycles_per_second, cycle_time_standard_deviation]
+          Cycle Time: %fms
+          Mean Cycle Time: %fms
+          Cycles Per Second: %f
+          Cycle Time Standard Deviation: %fms
+        TEXT
+      end
+      alias_method :to_s, :digest
     end
   end
 end

data/lib/diagnostics/sample/sample.rb

@@ -41,7 +41,9 @@ module Diagnostics
       logger.trace { "Starting warmup (Warmup Cycles: #{warmup_cycles})" }
 
       warmup_cycles.times do
-        elapsed_time = measure.()
+        elapsed_time_nanoseconds = measure.()
+
+        elapsed_time = milliseconds(elapsed_time_nanoseconds)
 
         result.warmup_cycle(elapsed_time)
       end
@@ -51,7 +53,9 @@ module Diagnostics
       logger.trace { "Starting sample (Cycles: #{cycles}, Warmup Cycles: #{warmup_cycles})" }
 
       cycles.times do
-        elapsed_time = measure.()
+        elapsed_time_nanoseconds = measure.()
+
+        elapsed_time = milliseconds(elapsed_time_nanoseconds)
 
         result.cycle(elapsed_time)
       end
@@ -60,5 +64,9 @@ module Diagnostics
 
       result
     end
+
+    def milliseconds(nanoseconds)
+      Rational(nanoseconds, 1_000_000)
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: evt-diagnostics-sample
 version: !ruby/object:Gem::Version
-  version: 0.1.2.0
+  version: 0.2.0.0
 platform: ruby
 authors:
 - The Eventide Project
@@ -75,6 +75,9 @@ files:
 - lib/diagnostics/sample.rb
 - lib/diagnostics/sample/controls.rb
 - lib/diagnostics/sample/controls/clock.rb
+- lib/diagnostics/sample/controls/frequency.rb
+- lib/diagnostics/sample/controls/mean.rb
+- lib/diagnostics/sample/controls/result.rb
 - lib/diagnostics/sample/controls/standard_deviation.rb
 - lib/diagnostics/sample/controls/time.rb
 - lib/diagnostics/sample/defaults.rb