summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorBenji Dial <benji@benjidial.net>2023-06-22 13:27:56 -0400
committerBenji Dial <benji@benjidial.net>2023-06-22 13:27:56 -0400
commitfa874b73ff8bde0ceac9f4f29255d9d23fa79a1a (patch)
treef07fb9303d91358eb1625331768aa0cf49fbe3e1 /include
parent766ace27fc29271f22845e370d26d65d54668922 (diff)
downloadlib94-fa874b73ff8bde0ceac9f4f29255d9d23fa79a1a.tar.gz
clarify comment on single_step
Diffstat (limited to 'include')
-rw-r--r--include/lib94/lib94.hpp10
1 files changed, 5 insertions, 5 deletions
diff --git a/include/lib94/lib94.hpp b/include/lib94/lib94.hpp
index 86732de..cfbb978 100644
--- a/include/lib94/lib94.hpp
+++ b/include/lib94/lib94.hpp
@@ -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();