Ensure ordering whenever we create a profile.

Author: tturocy

src/pygambit/game.pxi

@@ -1844,30 +1844,25 @@ class Game:
     def sort_infosets(self) -> None:
         """Sort information sets into a standard order.
 
-        When iterating the information sets of a player, the order in which information
-        sets are visited may be dependent on the order of the operations used to build
-        the extensive game.  This function sorts each player's information sets into
-        a standard order, namely, the order in which they are encountered in a depth-first
-        traversal of the tree, and likewise sorts the members of each information set
-        by the order in which they are encountered in a depth-first traversal.
-
-        .. versionadded:: 16.4.0
+        .. deprecated:: 16.5.0
+           This operation is deprecated as efficient management of the iteration orders of
+           information sets and their members is now handled by the representation objects.
 
         Raises
         ------
         UndefinedOperationError
             If the game does not have a tree representation.
-
-        See also
-        --------
-        Player.infosets
-        Infoset.members
         """
+        warnings.warn(
+            "sort_infosets() is deprecated; This operation is now done automatically when"
+            " required. "
+            "This function will be removed in a future release.",
+            FutureWarning
+        )
         if not self.is_tree:
             raise UndefinedOperationError(
                 "Operation only defined for games with a tree representation"
             )
-        pass
 
     def add_player(self, label: str = "") -> Player:
         """Add a new player to the game.

src/pygambit/infoset.pxi

@@ -206,19 +206,13 @@ class Infoset:
     def members(self) -> InfosetMembers:
         """The set of nodes which are members of the information set.
 
-        The order in which members are iterated is dependent on the order of
-        operations used to define the game.  A standard ordering, in which members
-        are iterated in the order encountered in a depth-first traversal of the tree,
-        can be obtained by calling `Game.sort_infosets` on the game after construction.
+        The iteration order of information set members is the order in which they
+        are encountered in the pre-order depth first traversal of the game tree.
 
-        .. versionchanged:: 16.4.0
-           The ordering of members is now dependent on the order of operations;
-           previously, members sets were (expensively) re-sorted after every change
-           to the game tree.
+        .. versionchanged:: 16.5.0
+           It is no longer necessary to call `Game.sort_infosets` to standardise
+           iteration order.
 
-        See also
-        --------
-        Game.sort_infosets
         """
         return InfosetMembers.wrap(self.infoset)
 

src/pygambit/player.pxi

@@ -218,24 +218,17 @@ class Player:
     def infosets(self) -> PlayerInfosets:
         """Returns the set of information sets at which the player has the decision.
 
-        The order in which information sets are iterated is dependent on the order of
-        operations used to define the game.  A standard ordering, in which information
-        sets are iterated in the order encountered in a depth-first traversal of the tree,
-        can be obtained by calling `Game.sort_infosets` on the game after construction.
+        The iteration order of information sets is the order in which they
+        are encountered in the pre-order depth first traversal of the game tree.
 
-        .. versionchanged:: 16.4.0
-           The ordering of information sets is now dependent on the order of operations;
-           previously, information sets were (expensively) re-sorted after every change
-           to the game tree.
+        .. versionchanged:: 16.5.0
+           It is no longer necessary to call `Game.sort_infosets` to standardise
+           iteration order.
 
         Raises
         ------
         UndefinedOperationError
             If the game does not have a tree representation.
-
-        See also
-        --------
-        Game.sort_infosets
         """
         if not self.game.is_tree:
             raise UndefinedOperationError(

tests/games.py

@@ -5,6 +5,7 @@
 from abc import ABC, abstractmethod
 
 import numpy as np
+import pytest
 
 import pygambit as gbt
 
@@ -651,7 +652,8 @@ def create_kuhn_poker_efg(nonterm_outcomes: bool = False) -> gbt.Game:
         g = _create_kuhn_poker_efg_only_term_outcomes()
 
     # Ensure infosets are in the same order as if game was written to efg and read back in
-    g.sort_infosets()
+    with pytest.warns(FutureWarning):
+        g.sort_infosets()
     return g
 
 

tests/test_strategic.py

@@ -43,7 +43,7 @@ def test_strategic_game_nodes():
 
 def test_strategic_game_sort_infosets():
     game = gbt.Game.new_table([2, 2])
-    with pytest.raises(gbt.UndefinedOperationError):
+    with pytest.warns(FutureWarning), pytest.raises(gbt.UndefinedOperationError):
         _ = game.sort_infosets()