diff options
| author | Steve <steve@steve-Inspiron14z.(none)> | 2013-02-04 22:13:34 -0500 |
|---|---|---|
| committer | Steve <steve@steve-Inspiron14z.(none)> | 2013-02-04 22:13:34 -0500 |
| commit | 637dbd84d5b80d91aa2eecd950a0e509d44f112e (patch) | |
| tree | 4bcd2444e10ff5c536458aa4c6a36c3032268a37 /numpy/add_newdocs.py | |
| parent | 0a87823d048fca997684e86718be0d46459ad4fd (diff) | |
| download | numpy-637dbd84d5b80d91aa2eecd950a0e509d44f112e.tar.gz | |
DOC -- add another paragraph note to ndarray.view docs
Since most numpy operations are not sensitive to underlying data
structure (C-ordered arrays vs fortran-ordered arrays, versus slices or
transposes of arrays, etc.), but structured-array views ARE sensitive to
that, it is worth saying it explicitly in the documentation.
Diffstat (limited to 'numpy/add_newdocs.py')
| -rw-r--r-- | numpy/add_newdocs.py | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index 26711f177..d1f6b3285 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -4460,6 +4460,12 @@ add_newdoc('numpy.core.multiarray', 'ndarray', ('view', (same shape, dtype, etc.) This does not cause a reinterpretation of the memory. + In cases when ``a.view(some_dtype)`` causes a reinterpretation of the + bytes of memory, its behavior cannot necessarily be predicted just from + the superficial appearance of ``a`` (shown by ``print(a)``). If ``a`` is + C-ordered versus fortran-ordered, versus defined as a transpose, versus + defined as a slice, etc., the view may give different results. + Examples -------- |