Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
myers/middle_snake: correct safety doc (#11)
In the documentation for MiddleSnakeSearch::new, the safety constraints described on the `data` pointer do not exactly match how the class uses it. It is stored as the `kvec` field, and looking at the `write_xpos_at_diagonal`, `x_pos_at_diagonal`, and `pos_at_diagonal` functions (a search of `kvec` in the source code revealing that all access to `kvec` go through one of these functions): - writes could happen, not only reads - the range of access is as described in the bounds_check function Therefore, update the documentation accordingly.
- Loading branch information