#11 - Add docs to the KotH computation

salsita · Aug 7, 2020 · 3c03408 · 3c03408
1 parent 386ab96
commit 3c03408
Showing 1 changed file with 9 additions and 3 deletions.
diff --git a/frontend/src/app/modules/players/players-computations.js b/frontend/src/app/modules/players/players-computations.js
@@ -50,6 +50,15 @@ export const getRatingStatisticsForPlayer = (players, playerId) => {
   }
 }
 
+/*
+  First, we create a hash table of players and their current scores
+  Then we iterate through matches from the latest, recompute scores of affected players and compare
+  More preciselly:
+    1. Recompute king's score in case he played the match, note whether he won the match
+    2. Recompute scores of all (other) players in the match and test if any of them tops king
+    3. Otherwise, compare his new score with scores of all other players,
+    in case the king played the match and won (thus had smaller score before).
+*/
 export const computeKingStreakDuration = (lastMatches, lastPlayers) => {
   if (lastPlayers.length < 1) {
     return null
@@ -65,21 +74,18 @@ export const computeKingStreakDuration = (lastMatches, lastPlayers) => {
   for (const match of lastMatches) {
     const players = [...match.team1, ...match.team2]
 
-    // #1 recomptute king's rating before in case he played the match
     const kingPlayer = players.find(player => player.id === kingId)
     let kingWon = false
     if (kingPlayer) {
       kingWon = playersMap[kingId] > kingPlayer.matchRating
       playersMap[kingId] = kingPlayer.matchRating
     }
 
-    // #2 check whether none of the other players beat the king
     for (const player of players) {
       playersMap[player.id] = player.matchRating
       matchFound |= (player.id !== kingId && player.matchRating > playersMap[kingId])
     }
 
-    // #3 check if king was first before winning
     if (kingPlayer && kingWon && !matchFound) {
       for (const key in playersMap) {
         matchFound |= (playersMap[key] > playersMap[kingId])