[Numpy-discussion] Documentation question.

[Mark Wiebe]

On Wed, Feb 1, 2012 at 3:29 PM, Charles R Harris
<charlesr.harris at gmail.com>wrote:

> The macro PyArray_RemoveLargest has been replaced by
> PyArray_RemoveSmallest (which seems strange), but I wonder if this
> documentation still makes sense.
>

My impression about this code is that it went through a number of rounds
trying to choose an iteration order heuristic that has improved performance
over C-order. The change of Largest to Smallest probably reflects one of
these heuristic changes. I think it's safe to say that the nditer
introduced in 1.6 completely removes the need for this functionality. I did
a grep for this function in the master branch, and it is no longer used by
NumPy internally.

-Mark


> diff --git a/doc/source/user/c-info.beyond-basics.rst b/doc/source/user/
> c-info.beyond-basics.rs
> index 9ed2ab3..3437985 100644
> --- a/doc/source/user/c-info.beyond-basics.rst
> +++ b/doc/source/user/c-info.beyond-basics.rst
> @@ -189,7 +189,7 @@ feature follows.
>          PyArray_MultiIter_NEXT(mobj);
>      }
>
> -The function :cfunc:`PyArray_RemoveLargest` ( ``multi`` ) can be used to
> +The function :cfunc:`PyArray_RemoveSmallest` ( ``multi`` ) can be used to
>  take a multi-iterator object and adjust all the iterators so that
>  iteration does not take place over the largest dimension (it makes
>  that dimension of size 1). The code being looped over that makes use
>
> Chuck
>
>
> _______________________________________________
> NumPy-Discussion mailing list
> NumPy-Discussion at scipy.org
> http://mail.scipy.org/mailman/listinfo/numpy-discussion
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/numpy-discussion/attachments/20120201/4de09b04/attachment.html>