Commit 60a42461 authored by Robert Bradshaw's avatar Robert Bradshaw

Update docs on boundscheck.

parent c4b15200
...@@ -144,8 +144,9 @@ Cython code. Here is the list of currently supported directives: ...@@ -144,8 +144,9 @@ Cython code. Here is the list of currently supported directives:
``boundscheck`` (True / False) ``boundscheck`` (True / False)
If set to False, Cython is free to assume that indexing operations If set to False, Cython is free to assume that indexing operations
([]-operator) in the code will not cause any IndexErrors to be ([]-operator) in the code will not cause any IndexErrors to be
raised. Currently this is only made use of for buffers, lists and raised. Lists, tuples, and stings are affected only if the index
tuples, but could be affected other types in the future. Conditions can be determined to be non-negative (or if ``wraparound`` is False).
Conditions
which would normally trigger an IndexError may instead cause which would normally trigger an IndexError may instead cause
segfaults or data corruption if this is set to False. segfaults or data corruption if this is set to False.
Default is True. Default is True.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment