diff options
| author | Sebastian Berg <sebastian@sipsolutions.net> | 2022-02-11 14:35:19 -0600 |
|---|---|---|
| committer | Sebastian Berg <sebastian@sipsolutions.net> | 2022-02-11 14:53:01 -0600 |
| commit | 0457cc7da06d98cc818a0ae1d3cc98ea93a1893d (patch) | |
| tree | 49ce408981c79c7546dca44f783c527267b32891 /doc/source/reference/global_state.rst | |
| parent | f69ddd7111048111a7e486a2d7d008bd231af33d (diff) | |
| download | numpy-0457cc7da06d98cc818a0ae1d3cc98ea93a1893d.tar.gz | |
MAINT: Remove the RELAXED_STRIDES_CHECKING env variable
An error is for now raised in `setup.py` if this is set, eventually
we should just delete that.
Diffstat (limited to 'doc/source/reference/global_state.rst')
| -rw-r--r-- | doc/source/reference/global_state.rst | 18 |
1 files changed, 7 insertions, 11 deletions
diff --git a/doc/source/reference/global_state.rst b/doc/source/reference/global_state.rst index 20874ceaa..81685ec7d 100644 --- a/doc/source/reference/global_state.rst +++ b/doc/source/reference/global_state.rst @@ -70,19 +70,15 @@ Debugging-Related Options Relaxed Strides Checking ------------------------ -The *compile-time* environment variables:: +The *compile-time* environment variable:: NPY_RELAXED_STRIDES_DEBUG=0 - NPY_RELAXED_STRIDES_CHECKING=1 - -control how NumPy reports contiguity for arrays. -The default that it is enabled and the debug mode is disabled. -This setting should always be enabled. Setting the -debug option can be interesting for testing code written -in C which iterates through arrays that may or may not be -contiguous in memory. -Most users will have no reason to change these; for details -see the :ref:`memory layout <memory-layout>` documentation. + +can be set to help debug code written in C which iteraters through arrays +manually. When an array is contiguous and iterated in a contiguous manner, +its ``strides`` should not be queried. This option can help find errors where +the ``strides`` are incorrectly used. +For details see the :ref:`memory layout <memory-layout>` documentation. Warn if no memory allocation policy when deallocating data |