From: Alexis Laferrière <alexis.laf@xymus.net>
Date: Mon, 18 May 2015 11:46:18 +0000 (-0400)
Subject: lib/bucketed_game: intro services to get stats on buckets
X-Git-Url: http://nitlanguage.org

lib/bucketed_game: intro services to get stats on buckets

Signed-off-by: Alexis Laferrière <alexis.laf@xymus.net>
---

diff --git a/lib/bucketed_game.nit b/lib/bucketed_game.nit
index b5542e4..2e8e3d3 100644
--- a/lib/bucketed_game.nit
+++ b/lib/bucketed_game.nit
@@ -26,6 +26,7 @@
 module bucketed_game is serialize
 
 import serialization
+import counter
 
 # Something acting on the game
 abstract class Turnable[G: Game]
@@ -65,6 +66,9 @@ class Buckets[G: Game]
 	private var buckets: Array[BUCKET] =
 		[for b in n_buckets.times do new HashSet[Bucketable[G]]] is lazy
 
+	# Stats on delays asked when adding an event with `act_in` and `act_next`
+	private var delays = new Counter[Int]
+
 	# Add the Bucketable event `e` at `at_tick`.
 	fun add_at(e: Bucketable[G], at_tick: Int)
 	do
@@ -106,6 +110,26 @@ class Buckets[G: Game]
 			end
 		end
 	end
+
+	# Get some statistics on both the current held events and historic expired events
+	fun stats: String
+	do
+		var entries = 0
+		var instances = new HashSet[Bucketable[G]]
+		var max = 0
+		var min = 100000
+		for bucket in buckets do
+			var len = bucket.length
+			entries += len
+			instances.add_all bucket
+			min = min.min(len)
+			max = max.max(len)
+		end
+		var avg = entries.to_f / buckets.length.to_f
+
+		return "{buckets.length} buckets; uniq/tot:{instances.length}/{entries}, avg:{avg.to_precision(1)}, min:{min}, max:{max}\n" +
+			"history:{delays.sum}, avg:{delays.avg}, min:{delays[delays.min.as(not null)]}, max:{delays[delays.max.as(not null)]}"
+	end
 end
 
 # Game related event
@@ -153,10 +177,18 @@ class GameTurn[G: Game]
 	end
 
 	# Insert the Bucketable event `e` to be executed at next tick.
-	fun act_next(e: Bucketable[G]) do game.buckets.add_at(e, tick + 1)
+	fun act_next(e: Bucketable[G])
+	do
+		game.buckets.add_at(e, tick + 1)
+		game.buckets.delays.inc(1)
+	end
 
 	# Insert the Bucketable event `e` to be executed at tick `t`.
-	fun act_in(e: Bucketable[G], t: Int) do game.buckets.add_at(e, tick + t)
+	fun act_in(e: Bucketable[G], t: Int)
+	do
+		game.buckets.add_at(e, tick + t)
+		game.buckets.delays.inc(t)
+	end
 
 	# Add and `apply` a game `event`.
 	fun add_event( event : GameEvent )