Merge in origin

Author: gaffney2010

axelrod/result_set.py

@@ -2,7 +2,6 @@
 import csv
 import itertools
 from multiprocessing import cpu_count
-from typing import List
 import warnings
 
 import numpy as np
@@ -427,9 +426,7 @@ def _build_initial_cooperation_rate(self, interactions_series):
         with warnings.catch_warnings():
             warnings.simplefilter("ignore")
             initial_cooperation_rate = list(
-                np.nan_to_num(
-                    np.array(self.initial_cooperation_count) / interactions_array
-                )
+                np.nan_to_num(np.array(self.initial_cooperation_count) / interactions_array)
             )
             return initial_cooperation_rate
 
@@ -612,18 +609,6 @@ def __eq__(self, other):
             other : axelrod.ResultSet
                 Another results set against which to check equality
         """
-
-        def list_equal_with_nans(v1: List[float], v2: List[float]) -> bool:
-            """Matches lists, accounting for NaNs."""
-            if len(v1) != len(v2):
-                return False
-            for i1, i2 in zip(v1, v2):
-                if np.isnan(i1) and np.isnan(i2):
-                    continue
-                if i1 != i2:
-                    return False
-            return True
-
         return all(
             [
                 self.wins == other.wins,
@@ -643,8 +628,8 @@ def list_equal_with_nans(v1: List[float], v2: List[float]) -> bool:
                 self.cooperating_rating == other.cooperating_rating,
                 self.good_partner_matrix == other.good_partner_matrix,
                 self.good_partner_rating == other.good_partner_rating,
-                list_equal_with_nans(self.eigenmoses_rating, other.eigenmoses_rating),
-                list_equal_with_nans(self.eigenjesus_rating, other.eigenjesus_rating),
+                self.eigenmoses_rating == other.eigenmoses_rating,
+                self.eigenjesus_rating == other.eigenjesus_rating,
             ]
         )
 

axelrod/strategies/zero_determinant.py

@@ -6,15 +6,44 @@
 
 
 class LRPlayer(MemoryOnePlayer):
-    """Abstraction for Linear Relation players. These players enforce a linear
-    difference in stationary payoffs s * (S_xy - l) = S_yx - l, with 0 <= l <= R.
-    The parameter `s` is called the slope and the parameter `l` the
-    baseline payoff. For extortionate strategies, the extortion factor is the
-    inverse of the slope.
-
-    This parameterization is Equation 14 in
-    http://journals.plos.org/plosone/article?id=10.1371/journal.pone.0077886.
-    See Figure 2 of the article for a more in-depth explanation.
+    """
+    Abstraction for Linear Relation players. These players enforce a linear
+    difference in stationary payoffs :math:`s (S_{xy} - l) = S_{yx} - l.`
+
+    The parameter :math:`s` is called the slope and the parameter :math:`l` the
+    baseline payoff. For extortionate strategies, the extortion factor
+    :math:`\chi` is the inverse of the slope :math:`s`.
+
+    For the standard prisoner's dilemma where :math:`T > R > P > S` and
+    :math:`R > (T + S) / 2 > P`, a pair :math:`(l, s)` is enforceable iff
+
+    .. math::
+       :nowrap:
+
+       \\begin{eqnarray}
+       &P &<= l <= R \\\\
+       &s_{min} &= -\min\\left( \\frac{T - l}{l - S}, \\frac{l - S}{T - l}\\right) <= s <= 1
+       \\end{eqnarray}
+
+    And also that there exists :math:`\\phi` such that
+
+    .. math::
+       :nowrap:
+
+       \\begin{eqnarray}
+          p_1 &= P(C|CC) &= 1 - \\phi (1 - s)(R - l) \\\\
+          p_2 &= P(C|CD) &= 1 - \\phi (s(l - S) + (T - l)) \\\\
+          p_3 &= P(C|DC) &= \\phi ((l - S) + s(T - l)) \\\\
+          p_4 &= P(C|DD) &= \\phi (1 - s)(l - P)
+       \\end{eqnarray}
+
+
+    These conditions also force :math:`\\phi >= 0`. For a given pair :math:`(l, s)`
+    there may be multiple such :math:`\\phi`.
+
+    This parameterization is Equation 14 in [Hilbe2013]_.
+    See Figure 2 of the article for a more in-depth explanation. Other game
+    parameters can alter the relations and bounds above.
 
     Names:
 

axelrod/tests/unit/test_eigen.py

@@ -15,13 +15,6 @@ def test_identity_matrices(self):
             self.assertAlmostEqual(evalue, 1)
             assert_array_almost_equal(evector, _normalise(numpy.ones(size)))
 
-    def test_zero_matrix(self):
-        mat = numpy.array([[0, 0], [0, 0]])
-        evector, evalue = principal_eigenvector(mat)
-        self.assertTrue(numpy.isnan(evalue))
-        self.assertTrue(numpy.isnan(evector[0]))
-        self.assertTrue(numpy.isnan(evector[1]))
-
     def test_2x2_matrix(self):
         mat = numpy.array([[2, 1], [1, 2]])
         evector, evalue = principal_eigenvector(mat)

axelrod/tests/unit/test_resultset.py

@@ -7,7 +7,7 @@
 import pandas as pd
 from axelrod.result_set import create_counter_dict
 from axelrod.tests.property import prob_end_tournaments, tournaments
-from numpy import mean, nan, nanmedian, std
+from numpy import mean, nanmedian, std
 
 from dask.dataframe.core import DataFrame
 from hypothesis import given, settings
@@ -190,36 +190,6 @@ def test_init(self):
         self.assertEqual(rs.players, self.players)
         self.assertEqual(rs.num_players, len(self.players))
 
-    def _clear_matrix(self, matrix):
-        for i, row in enumerate(matrix):
-            for j, _ in enumerate(row):
-                 matrix[i][j] = 0
-
-    def test_ne_vectors(self):
-        rs_1 = axelrod.ResultSet(self.filename, self.players, self.repetitions)
-
-        rs_2 = axelrod.ResultSet(self.filename, self.players, self.repetitions)
-
-        # A different vector
-        rs_2.eigenmoses_rating = (-1, -1, -1)
-
-        self.assertNotEqual(rs_1, rs_2)
-
-    def test_nan_vectors(self):
-        rs_1 = axelrod.ResultSet(self.filename, self.players, self.repetitions)
-        # Force a broken eigenmoses, by replacing vengeful_cooperation with
-        # zeroes.
-        self._clear_matrix(rs_1.vengeful_cooperation)
-        rs_1.eigenmoses_rating = rs_1._build_eigenmoses_rating()
-
-        rs_2 = axelrod.ResultSet(self.filename, self.players, self.repetitions)
-        # Force a broken eigenmoses, by replacing vengeful_cooperation with
-        # zeroes.
-        self._clear_matrix(rs_2.vengeful_cooperation)
-        rs_2.eigenmoses_rating = rs_2._build_eigenmoses_rating()
-
-        self.assertEqual(rs_1, rs_2)
-
     def test_init_multiprocessing(self):
         rs = axelrod.ResultSet(
             self.filename,