Skip to content

Commit 1f4f2d7

Browse files
Merge pull request #784 from theref/docfix
Fix docstrings to remove any mention of Dual of Strategy
2 parents d620960 + f93e5df commit 1f4f2d7

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

axelrod/fingerprint.py

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,7 @@ def create_edges(points):
9292
edges : list of tuples
9393
A list containing tuples of length 2. All tuples will have 0 as the
9494
first element. The second element is the index of the
95-
corresponding probe (+1 to allow for including the Strategy and its
96-
Dual).
95+
corresponding probe (+1 to allow for including the Strategy).
9796
"""
9897
edges = [(0, index + 1) for index, point in enumerate(points)]
9998
return edges
@@ -134,12 +133,11 @@ def construct_tournament_elements(self, step):
134133
edges : list of tuples
135134
A list containing tuples of length 2. All tuples will have either 0
136135
or 1 as the first element. The second element is the index of the
137-
corresponding probe (+2 to allow for including the Strategy and its
138-
Dual).
136+
corresponding probe (+1 to allow for including the Strategy).
139137
140138
tournament_players : list
141139
A list containing instances of axelrod.Player. The first item is the
142-
original player, the second is the dual, the rest are the probes.
140+
original player, the rest are the probes.
143141
144142
"""
145143
probe_points = create_points(step)
@@ -168,8 +166,7 @@ def generate_data(interactions, points, edges):
168166
edges : list of tuples
169167
A list containing tuples of length 2. All tuples will have either 0
170168
or 1 as the first element. The second element is the index of the
171-
corresponding probe (+2 to allow for including the Strategy and its
172-
Dual).
169+
corresponding probe (+1 to allow for including the Strategy).
173170
174171
Returns
175172
----------
@@ -186,10 +183,11 @@ def fingerprint(self, turns=50, repetitions=10, step=0.01, processes=None,
186183
filename=None, in_memory=False, progress_bar=True):
187184
"""Build and play the spatial tournament.
188185
189-
Creates the probes and their edges then builds a spatial tournament
190-
where the original strategy only plays probes whose coordinates sum to
191-
less than 1 (or equal). Probes whose coordinates sum to more than 1 play
192-
the Dual Strategy.
186+
Creates the probes and their edges then builds a spatial tournament.
187+
When the coordinates of the probe sum to more than 1, the dual of the
188+
probe is taken instead and then the Joss-Ann Transformer is applied. If
189+
the coordinates sum to less than 1 (or equal), then only the Joss-Ann is
190+
applied, a dual is not required.
193191
194192
Parameters
195193
----------

0 commit comments

Comments
 (0)