(#2) Inroduce GameProblem for game solver and implement solve to multiple dispatch

Author: jbytecode

docs/src/game.md

@@ -1,10 +1,16 @@
 # Zero-Sum Games
 
 
+## Game Problem 
+
+```@docs 
+OperationsResearchModels.GameProblem
+```
+
 ## Game solver for the row player 
 
 ```@docs 
-OperationsResearchModels.game
+OperationsResearchModels.solve(g::GameProblem)
 ```
 
 

src/OperationsResearchModels.jl

@@ -83,7 +83,7 @@ import .Network: Connection, nodes
 import .MaximumFlow: MaximumFlowResult, MaximumFlowProblem
 import .MinimumCostFlow: MinimumCostFlowProblem, MinimumCostFlowResult
 import .Assignment: AssignmentProblem, AssignmentResult, isbalanced, balance
-import .Game: game, GameResult, game_solver
+import .Game: GameProblem, GameResult
 import .MinimumSpanningTree: hasloop, MstResult, MstProblem
 import .PMedian: pmedian, pmedian_with_distances, PMedianResult
 import .CPM: CpmActivity, earliestfinishtime, longestactivity, CpmProblem, CpmResult
@@ -99,7 +99,7 @@ export TransportationProblem, TransportationResult, balance, isbalanced, northwe
 export Connection, ShortestPathResult, MaximumFlowResult, MinimumCostFlowResult, nodes
 export ShortestPathProblem, MaximumFlowProblem, MinimumCostFlowProblem
 export AssignmentProblem, AssignmentResult, isbalanced, balance
-export game, GameResult, game_solver
+export GameProblem, GameResult
 export hasloop, MstResult, MstProblem
 export pmedian, pmedian_with_distances, PMedianResult
 export CpmActivity, earliestfinishtime, longestactivity, CpmProblem, CpmResult

src/game.jl

@@ -3,6 +3,25 @@ module Game
 using JuMP, HiGHS
 
 
+import ..OperationsResearchModels: solve
+
+
+"""
+    GameProblem 
+
+# Description
+
+Defines the problem of a zero-sum game.
+
+# Fields
+
+- `decisionMatrix::Matrix{<:Real}`: The payoff matrix of the game designed for the row player.
+"""
+struct GameProblem 
+    decisionMatrix::Matrix{<:Real}
+end 
+
+
 """
     GameResult
 
@@ -24,40 +43,27 @@ end
 
 
 """
-    game(decisionMatrix::Matrix{<:Real}; verbose::Bool = false)::Vector{GameResult}
+    solve(p::GameProblem; verbose::Bool = false)::Vector{GameResult}
 
     Solves a zero-sum game using the simplex method.
 
 # Arguments
 
-- `decisionMatrix`: The payoff matrix of the game.
+- `p::GameProblem`: The problem instance containing the decision matrix.
 - `verbose`: If true, prints the model information.
 
 # Returns
 - An array of `GameResult` objects containing the probabilities and value of the game.
 """
-function game(decisionMatrix::Matrix{<:Real}; verbose::Bool = false)::Vector{GameResult}
-    rowplayers_result = game_solver(decisionMatrix, verbose = verbose)
-    columnplayers_result = game_solver(Matrix(decisionMatrix') * -1.0, verbose = verbose)
+function solve(p::GameProblem; verbose::Bool = false)::Vector{GameResult}
+    rowplayers_result = game_solver(p.decisionMatrix, verbose = verbose)
+    columnplayers_result = game_solver(Matrix(p.decisionMatrix') * -1.0, verbose = verbose)
     return [rowplayers_result, columnplayers_result]
 end
 
 
 
-"""
-    game_solver(gamematrix::Matrix{<:Real}; verbose::Bool = false)::GameResult
-
-    Solves a zero-sum game using the simplex method.
-
-# Arguments
 
-- `gamematrix`: The payoff matrix of the game.
-- `verbose`: If true, prints the model information.
-
-# Returns
-
-- A `GameResult` object containing the probabilities and value of the game.
-"""
 function game_solver(gamematrix::Matrix{<:Real}; verbose::Bool = false)::GameResult
 
     nrow, ncol = size(gamematrix)

test/testgame.jl

@@ -8,7 +8,9 @@
             -1 2 4
         ]
 
-        result = game(mat)
+        problem = GameProblem(mat)
+
+        result = solve(problem)
 
         @test isa(result, Vector{GameResult})
         @test length(result) == 2
@@ -32,7 +34,9 @@
             -1 1 0
         ]
 
-        result = game(mat)
+        problem = GameProblem(mat)
+
+        result = solve(problem)
 
         @test isa(result, Vector{GameResult})
         @test length(result) == 2
@@ -54,7 +58,9 @@
             5 4
         ]
 
-        result = game(mat)
+        problem = GameProblem(mat)
+
+        result = solve(problem)
 
         @test isa(result, Vector{GameResult})