MAINT: document minimum dim cache size == 2

juliantaylor · juliantaylor · commit c1141697d67a · 2017-07-11T12:34:13.000+02:00
Remove unlikely, as it is being used now more it may not be correct
anymore.
diff --git a/numpy/core/src/multiarray/alloc.c b/numpy/core/src/multiarray/alloc.c
@@ -126,8 +126,11 @@ npy_free_cache(void * p, npy_uintp sz)
 NPY_NO_EXPORT void *
 npy_alloc_cache_dim(npy_uintp sz)
 {
-    /* dims + strides */
-    if (NPY_UNLIKELY(sz < 2)) {
+    /*
+     * make sure any temporary allocation can be used for array metadata which
+     * uses one memory block for both dimensions and strides
+     */
+    if (sz < 2) {
         sz = 2;
     }
     return _npy_alloc_cache(sz, sizeof(npy_intp), NBUCKETS_DIM, dimcache,
@@ -137,8 +140,8 @@ npy_alloc_cache_dim(npy_uintp sz)
 NPY_NO_EXPORT void
 npy_free_cache_dim(void * p, npy_uintp sz)
 {
-    /* dims + strides */
-    if (NPY_UNLIKELY(sz < 2)) {
+    /* see npy_alloc_cache_dim */
+    if (sz < 2) {
         sz = 2;
     }
     _npy_free_cache(p, sz, NBUCKETS_DIM, dimcache,

Original file line number	Diff line number	Diff line change
`@@ -126,8 +126,11 @@ npy_free_cache(void * p, npy_uintp sz)`
`126`	`126`	`NPY_NO_EXPORT void *`
`127`	`127`	`npy_alloc_cache_dim(npy_uintp sz)`
`128`	`128`	`{`
`129`		`- /* dims + strides */`
`130`		`- if (NPY_UNLIKELY(sz < 2)) {`
	`129`	`+ /*`
	`130`	`+ * make sure any temporary allocation can be used for array metadata which`
	`131`	`+ * uses one memory block for both dimensions and strides`
	`132`	`+ */`
	`133`	`+ if (sz < 2) {`
`131`	`134`	`sz = 2;`
`132`	`135`	`}`
`133`	`136`	`return _npy_alloc_cache(sz, sizeof(npy_intp), NBUCKETS_DIM, dimcache,`
`@@ -137,8 +140,8 @@ npy_alloc_cache_dim(npy_uintp sz)`
`137`	`140`	`NPY_NO_EXPORT void`
`138`	`141`	`npy_free_cache_dim(void * p, npy_uintp sz)`
`139`	`142`	`{`
`140`		`- /* dims + strides */`
`141`		`- if (NPY_UNLIKELY(sz < 2)) {`
	`143`	`+ /* see npy_alloc_cache_dim */`
	`144`	`+ if (sz < 2) {`
`142`	`145`	`sz = 2;`
`143`	`146`	`}`
`144`	`147`	`_npy_free_cache(p, sz, NBUCKETS_DIM, dimcache,`