benji/lib94
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

clarify comment on single_step

Browse source
This commit is contained in:
Benji Dial 2023-06-22 13:27:56 -04:00
parent 766ace27fc
commit fa874b73ff
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
include/lib94/lib94.hpp
View file

@ -127,11 +127,11 @@ namespace lib94 {
//does one step of the simulation. assumes that there is at least one warrior with at
//least one alive process, so check alive_warrior_count first if you aren't sure.
//if the warrior whose turn it is dies during this step, the pointer to that warrior
//is returned. otherwise, a null pointer is returned. the update_address_sets template
//parameter controls whether to update the sets returned by get_written_addresses,
//get_read_addresses, and get_executed_addresses. this is provided so that you can
//improve the performance of the simulation if you do not need that information.
//if the warrior whose turn it is has only one process, and that process dies during
//this step, the pointer to that warrior is returned. otherwise, a null pointer is
//returned. the update_address_sets template parameter controls whether to update the
//sets returned by get_*_addresses. this is provided so that you can improve the
//performance of the simulation if you do not need that information.
template <bool update_address_sets>
const warrior *single_step();