bayesian-battle

Bayesian Battle
==============================

An implementation of the Bayesian-approximation based game ranking system described by
Weng and Lin and
used by HackerRank.

##Usage
NOTE: This section is subject to change until the package reaches its first release. Use at your own risk.

###updatePlayerSkills

---

####Input Data Format

The input data format consists of an array of objects that have three properties:

1. id : a unique value to identify the given player object.
1. meanStrength : the mean strength metric of the player(μ). For new players, this should be 25.
1. standardDeviation : the standard deviation of the mean strength of the player(σ). For new players, this should be 25/3.
1. gameRanking : A zero-based ranking of the player in the game. Lower is better. Two players draw if they have the same ranking.

The object may have other properties; they will not be modified.

####Output Data Format

The output data is a copy of the input data with updated meanStrength and standardDeviation properties.

###constructor

---

####scoreUncertainty

This parameter controls the fixed amount of uncertainty between the two players. This is used along with the
standard deviation of each player's strength to calculate the total performance uncertainty of the game.

####k
This parameter is the minimum value of a user's mean strength standard deviation (more specifically, to ensure
that standard deviation is never negative.)

####scoreStandardDeviationCoefficient
This parameter is used to calculate a player's score from their mean strength and standard deviation
(the calculation is meanStrength - scoreStandardDeviationCoefficient * standardDeviation)

###calculatePlayerScoreFromPlayerMetrics

---

This function calculates a user's score from their mean strength and standard deviation. Lower standard deviation
results in higher scores.

##Contributions
If you want to contribute, fantastic! As this package is still in its early stages, the best way to collaborate
would be to either file issues or email me.

##Things to do

1. Prepare interface for first release
1. Write more tests
1. Manually verify that the program produces correct output by generating an example from the paper

##License

The MIT License (MIT)

Copyright (c) 2014 CodeCombat, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.