egttools.games.pgg.sample_simplex

sample_simplex()

Convert a state index into a group composition vector.

This function is the inverse of calculate_state.

Parameters:
  • index (int) – Index of the population state.

  • pop_size (int) – Total number of individuals.

  • nb_strategies (int) – Number of available strategies.

Returns:

One-dimensional integer array containing the number of individuals using each strategy.

Return type:

numpy.ndarray

Examples

>>> sample_simplex(0, 3, 3)
array([3, 0, 0])
>>> sample_simplex(3, 3, 3)
array([1, 1, 1])