Type Members

1.  class Game extends AnyRef

   Tracks the result of a game between two players, maintaining the players, game result, and the player's ratings during that particular game

2.  class Matchup extends AnyRef

   Allows for creating matches before knowing winner, useful for matchmaking a pool of players or used to create a tournament of players

   Allows for creating matches before knowing winner, useful for matchmaking a pool of players or used to create a tournament of players

   Players can play matches against other players, here is an example following the example from wikipedia https://en.wikipedia.org/wiki/Elo_rating_system#Mathematical_details

   val playerA = new Player(rating = 1613)
   val opponent1 = new Player(rating = 1609)
   val opponent2 = new Player(rating = 1477)
   val opponent3 = new Player(rating = 1388)
   val opponent4 = new Player(rating = 1586)
   val opponent5 = new Player(rating = 1720)
   
   val matchOne = playerA plays opponent1
   val matchTwo = playerA plays opponent2
   val matchThree = playerA plays opponent3
   val matchFour = playerA plays opponent4
   val matchFive = playerA plays opponent5
   
   matchOne winner opponent1
   matchTwo.draw()
   matchThree loser opponent3
   matchFour.winner(playerA)
   matchFive.loser(playerA)
   
   playerA.updateRating(KFactor.USCF) // If not specified the Simple K-Factor is used
   playerA.rating // playerA now has a rating of 1601

3.  class Player extends AnyRef

   Holds player information and is backed by an ELO rating engine to update the player's rating.

   Holds player information and is backed by an ELO rating engine to update the player's rating. Also contains tournament and game history.

   Players can play games against other players, here is an example following the example from wikipedia https://en.wikipedia.org/wiki/Elo_rating_system#Mathematical_details

   val playerA = new Player(rating = 1613)
   val opponent1 = new Player(rating = 1609)
   val opponent2 = new Player(rating = 1477)
   val opponent3 = new Player(rating = 1388)
   val opponent4 = new Player(rating = 1586)
   val opponent5 = new Player(rating = 1720)
   
   playerA loses opponent1
   playerA draws opponent2
   playerA wins opponent3
   playerA wins opponent4
   playerA loses opponent5
   
   playerA.updateRating(KFactor.USCF) // If not specified the Simple K-Factor is used
   playerA.rating // playerA now has a rating of 1601

   The class can be extended as shown:

   // An example class that requires a name, rating, and player's always start at 0 games.
   class NamedPlayer(val name: String, rating: Int) extends Player(rating, 0) {
   
     // Some possible methods that can be added.
     def isPro: Boolean = if (rating > 2400) true else false
     def isNew: Boolean = if (gamesPlayed < 30) true else false
   
     // Change the default KFactor to USCF.
     def updateRating(): Unit = super.updateRating(KFactor.USCF)
   
     // Or create a custom KFactor
     def updateRating(): Unit = {
       val customerFactor = if (isPro) 10 else 400 / gamesPlayed
       super.updateRating(customerFactor)
     }
   }
   
   val myPlayer = new NamedPlayer("My Player Name", 1613)