Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions quantecon/game_theory/howson_lcp.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ def polym_lcp_solver(
starting_player_actions: Optional[Sequence[int]] = None,
max_iter: int = -1,
full_output: bool = False,
) -> Union[tuple[NDArray], NashResult]:
) -> Union[tuple[NDArray, ...], tuple[tuple[NDArray, ...], NashResult]]:
"""
Finds a Nash Equilbrium of a Polymatrix Game.

Expand Down Expand Up @@ -66,12 +66,15 @@ def polym_lcp_solver(

Returns
-------
tuple(ndarray(float, ndim=1)) or NashResult
The mixed actions at termination, a Nash Equilibrium if
not stopped early by reaching `max_iter`. If `full_output`,
then the number of iterations, whether it has converged,
and the initial conditions of the algorithm are included
in the returned `NashResult` alongside the actions.
NE : tuple(ndarray(float, ndim=1))
Tuple of computed Nash equilibrium mixed actions. A Nash
Equilibrium if not stopped early by reaching `max_iter`.

res : NashResult
Object containing information about the computation: the number
of iterations, whether it has converged, and the initial
conditions of the algorithm. Returned only when `full_output`
is True. See `NashResult` for details.

References
----------
Expand Down
Loading