Fix docstrings, remove dead typedef, and fix getElapsedTimeStep off-by-one

[dweep-desai]

Summary

Code quality PR addressing 3 open issues: incorrect/copy-pasted docstrings, an unused typedef, and a newly discovered off-by-one bounds check bug in getElapsedTimeStep().

Each fix is in a distinct commit for ease of review.

Changes

Commit 1: Fix getElapsedTime* docstrings (Fixes #1392)

The docstring for CUDASimulation::getElapsedTimeExitFunctions incorrectly referred to stepFunctions() instead of exitFunctions(). As suggested in the issue, a wider pass was done over all getElapsedTime* docstrings, revealing:

• getElapsedTimeRTCInitialisation: Typo "iniitliased" corrected to "initialised".
• All four methods: Copy-pasted @return elapsed time of last simulation call in seconds. corrected to method-specific descriptions.
• getElapsedTimeSteps comment: Typos "mutabililty" and "performacne" corrected.

Commit 2: Remove unused CUDARTCFuncMapPair typedef (Fixes #1378)

CUDAAgent::CUDARTCFuncMapPair was defined as a typedef but never referenced anywhere in the codebase. The docstring described it as "Element type of CUDARTCFuncMap" but CUDARTCFuncMap is a std::map, not using this pair type. Removed the typedef and its docstring.

Commit 3: Fix getElapsedTimeStep off-by-one bounds check (Fixes #1411)

CUDASimulation::getElapsedTimeStep(unsigned int step) used step > size() instead of step >= size(). When step == size() (e.g., requesting step 10 after a 10-step simulation where valid indices are 0–9):

• The guard condition 10 > 10 evaluated to false, passing the check
• .at(10) then threw std::out_of_range instead of exception::OutOfBoundsException

Also enables the previously commented-out // @todo out-of-bounds test and adds a boundary regression test.

Files Changed

File	Change
include/flamegpu/simulation/CUDASimulation.h	Fix docstrings for all getElapsedTime* methods
include/flamegpu/simulation/detail/CUDAAgent.h	Remove unused CUDARTCFuncMapPair typedef
src/flamegpu/simulation/CUDASimulation.cu	Fix off-by-one bounds check and comment typos
tests/test_cases/simulation/test_cuda_simulation.cu	Enable + extend out-of-bounds regression tests

Validation

• cpplint passed on all 4 modified files with 0 errors.
• All changes are backwards-compatible; no API changes.

Fixes #1392, #1378, #1411

[dweep-desai]

I have read the CLA Document and I hereby sign the CLA

[Robadob]

1. Sure
2. Yeah, I've removed many others during earlier refactors ,this one must have been missed.
3. Redundant, a fix for UNIFIED_GPU_MEMORY unfinished code? #1396 is already pending, in AMD GPU Support via HIP/ROCm #1379
4. Good catch.

Presumably you're using static analysis/AI?

Ideally each fix should be in a distinct commit, this makes it easier to review them properly.

The team is currently busy at a national conference, we'll hopefully be able to discuss this internally in a week or two.

[dweep-desai]

Thanks for the review @Robadob!

I've addressed your feedback:

1. Dropped the UNIFIED_GPU_MEMORY removal (UNIFIED_GPU_MEMORY unfinished code? #1396) — I see it's already handled in PR AMD GPU Support via HIP/ROCm #1379. Apologies for the overlap.
2. Split into 3 distinct commits, one per fix:
   • e56de85 Fix incorrect and copy-pasted getElapsedTime* docstrings (getElapsedTimeExitFunctions docstring incorrect #1392)
   • d8c3cb7 Remove unused CUDARTCFuncMapPair typedef (CUDAAgent.CUDARTCFuncMapPair unused #1378)
   • a45b827 Fix getElapsedTimeStep off-by-one bounds check ([Bug]: getElapsedTimeStep off-by-one bounds check allows std::out_of_range instead of OutOfBoundsException #1411)

Force-pushed to update the branch. No rush on the review — enjoy the conference!