Experiment with removing indexing outcomes by number

Author: tturocy

src/games/file.cc

@@ -411,10 +411,14 @@ void ReadOutcomeList(GameFileLexer &p_parser, Game &p_nfg)
 void ParseOutcomeBody(GameFileLexer &p_parser, Game &p_nfg)
 {
   ReadOutcomeList(p_parser, p_nfg);
+  const auto &outcomes = p_nfg->GetOutcomes();
+  std::vector<GameOutcome> outcome_index;
+  outcome_index.reserve(outcomes.size());
+  std::copy(outcomes.begin(), outcomes.end(), std::back_inserter(outcome_index));
   for (const auto &profile : StrategyContingencies(p_nfg)) {
     p_parser.ExpectCurrentToken(TOKEN_NUMBER, "outcome index");
     if (const int outcomeId = std::stoi(p_parser.GetLastText())) {
-      profile->SetOutcome(p_nfg->GetOutcome(outcomeId));
+      profile->SetOutcome(outcome_index[outcomeId - 1]);
     }
     p_parser.GetNextToken();
   }

src/games/game.h

@@ -1102,8 +1102,6 @@ class GameRep : public std::enable_shared_from_this<GameRep> {
 
   /// @name Outcomes
   //@{
-  /// Returns the index'th outcome defined in the game
-  GameOutcome GetOutcome(int index) const { return m_outcomes.at(index - 1); }
   /// Returns the set of outcomes in the game
   Outcomes GetOutcomes() const
   {

src/gui/gameframe.cc

@@ -969,9 +969,9 @@ void GameFrame::OnEditNode(wxCommandEvent &)
   if (dialog.ShowModal() == wxID_OK) {
     try {
       m_doc->DoSetNodeLabel(m_doc->GetSelectNode(), dialog.GetNodeName());
-      if (dialog.GetOutcome() > 0) {
-        m_doc->DoSetOutcome(m_doc->GetSelectNode(),
-                            m_doc->GetGame()->GetOutcome(dialog.GetOutcome()));
+      if (const auto outcomeId = dialog.GetOutcome(); outcomeId > 0) {
+        const auto outcome = *std::next(m_doc->GetGame()->GetOutcomes().begin(), outcomeId - 1);
+        m_doc->DoSetOutcome(m_doc->GetSelectNode(), outcome);
       }
       else {
         m_doc->DoSetOutcome(m_doc->GetSelectNode(), nullptr);

src/pygambit/gambit.pxd

@@ -264,7 +264,6 @@ cdef extern from "games/game.h":
         c_GamePlayer NewPlayer() except +
 
         int NumOutcomes() except +
-        c_GameOutcome GetOutcome(int) except +IndexError
         Outcomes GetOutcomes() except +
         c_GameOutcome NewOutcome() except +
         void DeleteOutcome(c_GameOutcome) except +

src/pygambit/game.pxi

@@ -237,7 +237,7 @@ class GameOutcomes:
         for outcome in self.game.deref().GetOutcomes():
             yield Outcome.wrap(outcome)
 
-    def __getitem__(self, index: int | str) -> Outcome:
+    def __getitem__(self, index: str) -> Outcome:
         if isinstance(index, str):
             if not index.strip():
                 raise ValueError("Outcome label cannot be empty or all whitespace")
@@ -247,9 +247,7 @@ class GameOutcomes:
             if len(matches) > 1:
                 raise ValueError(f"Game has multiple outcomes with label '{index}'")
             return matches[0]
-        if isinstance(index, int):
-            return Outcome.wrap(self.game.deref().GetOutcome(index + 1))
-        raise TypeError(f"Outcome index must be int or str, not {index.__class__.__name__}")
+        raise TypeError(f"Outcome index must be str, not {index.__class__.__name__}")
 
 
 @cython.cclass

tests/test_game.py

@@ -95,18 +95,6 @@ def test_from_dict():
     assert game.players[1].label == "b"
 
 
-def test_game_get_outcome_by_index():
-    game = gbt.Game.new_table([2, 2])
-    assert game[0, 0] == game.outcomes[0]
-
-
-def test_game_get_outcome_by_label():
-    game = gbt.Game.new_table([2, 2])
-    game.players[0].strategies[0].label = "defect"
-    game.players[1].strategies[0].label = "cooperate"
-    assert game["defect", "cooperate"] == game.outcomes[0]
-
-
 def test_game_get_outcome_invalid_tuple_size():
     game = gbt.Game.new_table([2, 2])
     with pytest.raises(KeyError):
@@ -141,7 +129,7 @@ def test_game_get_outcome_unmatched_label():
 
 def test_game_get_outcome_with_strategies():
     game = gbt.Game.new_table([2, 2])
-    assert game[game.players[0].strategies[0], game.players[1].strategies[0]] == game.outcomes[0]
+    _ = game[game.players[0].strategies[0], game.players[1].strategies[0]]
 
 
 def test_game_get_outcome_with_bad_strategies():
@@ -162,7 +150,8 @@ def test_game_dereference_invalid():
 def test_mixed_strategy_profile_game_structure_changed_no_tree():
     g = gbt.Game.from_arrays([[2, 2], [0, 0]], [[0, 0], [1, 1]])
     profiles = [g.mixed_strategy_profile(rational=b) for b in [False, True]]
-    g.outcomes[0][g.players[0]] = 3
+    outcome = next(iter(g.outcomes))
+    outcome[g.players[0]] = 3
     for profile in profiles:
         with pytest.raises(gbt.GameStructureChangedError):
             profile.copy()

tests/test_outcomes.py

@@ -17,37 +17,20 @@ def test_outcome_add(game: gbt.Game):
 )
 def test_outcome_delete(game: gbt.Game):
     outcome_count = len(game.outcomes)
-    game.delete_outcome(game.outcomes[0])
+    game.delete_outcome(next(iter(game.outcomes)))
     assert len(game.outcomes) == outcome_count - 1
 
 
-@pytest.mark.parametrize(
-    "game,label",
-    [(gbt.Game.new_table([2, 2]), "outcome label")]
-)
-def test_outcome_label(game: gbt.Game, label: str):
-    game.outcomes[0].label = label
-    assert game.outcomes[0].label == label
-
-
 @pytest.mark.parametrize(
     "game,label",
     [(gbt.Game.new_table([2, 2]), "outcome label")]
 )
 def test_outcome_index_label(game: gbt.Game, label: str):
-    game.outcomes[0].label = label
-    assert game.outcomes[0] == game.outcomes[label]
+    outcome = next(iter(game.outcomes))
+    outcome.label = label
     assert game.outcomes[label].label == label
 
 
-@pytest.mark.parametrize(
-    "game", [gbt.Game.new_table([2, 2])]
-)
-def test_outcome_index_int_range(game: gbt.Game):
-    with pytest.raises(IndexError):
-        _ = game.outcomes[2 * len(game.outcomes)]
-
-
 @pytest.mark.parametrize(
     "game", [gbt.Game.new_table([2, 2])]
 )
@@ -68,27 +51,28 @@ def test_outcome_payoff_by_player_label():
     game = gbt.Game.new_table([2, 2])
     game.players[0].label = "joe"
     game.players[1].label = "dan"
-    game.outcomes[0]["joe"] = 1
-    game.outcomes[0]["dan"] = 2
-    game.outcomes[1]["joe"] = 3
-    game.outcomes[1]["dan"] = 4
-    assert game.outcomes[0]["joe"] == 1
-    assert game.outcomes[0]["dan"] == 2
-    assert game.outcomes[1]["joe"] == 3
-    assert game.outcomes[1]["dan"] == 4
+    outcomes = list(game.outcomes)
+    outcomes[0]["joe"] = 1
+    outcomes[0]["dan"] = 2
+    outcomes[1]["joe"] = 3
+    outcomes[1]["dan"] = 4
+    assert outcomes[0]["joe"] == 1
+    assert outcomes[0]["dan"] == 2
+    assert outcomes[1]["joe"] == 3
+    assert outcomes[1]["dan"] == 4
 
 
 def test_outcome_payoff_by_player():
     game = gbt.Game.new_table([2, 2])
     game.players[0].label = "joe"
     game.players[1].label = "dan"
-    game.outcomes[0]["joe"] = 1
-    game.outcomes[0]["dan"] = 2
-    game.outcomes[1]["joe"] = 3
-    game.outcomes[1]["dan"] = 4
-    player1 = game.players[0]
-    player2 = game.players[1]
-    assert game.outcomes[0][player1] == 1
-    assert game.outcomes[0][player2] == 2
-    assert game.outcomes[1][player1] == 3
-    assert game.outcomes[1][player2] == 4
+    outcomes = list(game.outcomes)
+    outcomes[0]["joe"] = 1
+    outcomes[0]["dan"] = 2
+    outcomes[1]["joe"] = 3
+    outcomes[1]["dan"] = 4
+    player1, player2 = game.players
+    assert outcomes[0][player1] == 1
+    assert outcomes[0][player2] == 2
+    assert outcomes[1][player1] == 3
+    assert outcomes[1][player2] == 4