diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2019-12-02 17:32:30 -0700 |
|---|---|---|
| committer | Charles Harris <charlesr.harris@gmail.com> | 2019-12-02 17:47:54 -0700 |
| commit | 0cc8fd684e7880d30b58a78c7038c8a09e5d0a6e (patch) | |
| tree | c8a4addc05695ce7e4ba837452fa1b4f8790fd6c | |
| parent | dc96c4f59cdf93aa5512ede037a5b3690eaa2b1f (diff) | |
| download | numpy-0cc8fd684e7880d30b58a78c7038c8a09e5d0a6e.tar.gz | |
DOC: Create 1.18.0 release note.
45 files changed, 348 insertions, 237 deletions
diff --git a/doc/release/upcoming_changes/10151.improvement.rst b/doc/release/upcoming_changes/10151.improvement.rst deleted file mode 100644 index 3706a5132..000000000 --- a/doc/release/upcoming_changes/10151.improvement.rst +++ /dev/null @@ -1,9 +0,0 @@ -Different C numeric types of the same size have unique names ------------------------------------------------------------- -On any given platform, two of ``np.intc``, ``np.int_``, and ``np.longlong`` -would previously appear indistinguishable through their ``repr``, despite -their corresponding ``dtype`` having different properties. -A similar problem existed for the unsigned counterparts to these types, and on -some platforms for ``np.double`` and ``np.longdouble`` - -These types now always print with a unique ``__name__``. diff --git a/doc/release/upcoming_changes/12284.new_feature.rst b/doc/release/upcoming_changes/12284.new_feature.rst deleted file mode 100644 index 25321cd9b..000000000 --- a/doc/release/upcoming_changes/12284.new_feature.rst +++ /dev/null @@ -1,5 +0,0 @@ - -Add our own ``*.pxd`` cython import file --------------------------------------------- -Added a ``numpy/__init__.pxd`` file. It will be used for `cimport numpy` - diff --git a/doc/release/upcoming_changes/12658.change.rst b/doc/release/upcoming_changes/12658.change.rst deleted file mode 100644 index d150d5e91..000000000 --- a/doc/release/upcoming_changes/12658.change.rst +++ /dev/null @@ -1,5 +0,0 @@ -``NaT`` now sorts to the end of arrays --------------------------------------- -``NaT`` is now effectively treated as the largest integer for sorting -purposes, so that it sorts to the end of arrays. This change is for consistency -with ``NaN`` sorting behavior. diff --git a/doc/release/upcoming_changes/13605.deprecation.rst b/doc/release/upcoming_changes/13605.deprecation.rst deleted file mode 100644 index bff12e965..000000000 --- a/doc/release/upcoming_changes/13605.deprecation.rst +++ /dev/null @@ -1,9 +0,0 @@ -`np.fromfile` and `np.fromstring` will error on bad data --------------------------------------------------------- - -In future numpy releases, the functions `np.fromfile` and `np.fromstring` -will throw an error when parsing bad data. -This will now give a ``DeprecationWarning`` where previously partial or -even invalid data was silently returned. This deprecation also affects -the C defined functions c:func:`PyArray_FromString`` and -c:func:`PyArray_FromFile` diff --git a/doc/release/upcoming_changes/13610.improvement.rst b/doc/release/upcoming_changes/13610.improvement.rst deleted file mode 100644 index 6f97b43ad..000000000 --- a/doc/release/upcoming_changes/13610.improvement.rst +++ /dev/null @@ -1,5 +0,0 @@ -``argwhere`` now produces a consistent result on 0d arrays ----------------------------------------------------------- -On N-d arrays, `numpy.argwhere` now always produces an array of shape -``(n_non_zero, arr.ndim)``, even when ``arr.ndim == 0``. Previously, the -last axis would have a dimension of 1 in this case. diff --git a/doc/release/upcoming_changes/13698.deprecation.rst b/doc/release/upcoming_changes/13698.deprecation.rst deleted file mode 100644 index 923957058..000000000 --- a/doc/release/upcoming_changes/13698.deprecation.rst +++ /dev/null @@ -1,5 +0,0 @@ -Deprecate non-scalar arrays as fill values in ``ma.fill_value`` ---------------------------------------------------------------- -Setting a ``MaskedArray.fill_value`` to a non-scalar array is deprecated -since the logic to broadcast the fill value to the array is fragile, -especially when slicing. diff --git a/doc/release/upcoming_changes/13794.new_function.rst b/doc/release/upcoming_changes/13794.new_function.rst deleted file mode 100644 index cf8b38bb0..000000000 --- a/doc/release/upcoming_changes/13794.new_function.rst +++ /dev/null @@ -1,5 +0,0 @@ -Multivariate hypergeometric distribution added to `numpy.random` ----------------------------------------------------------------- -The method `multivariate_hypergeometric` has been added to the class -`numpy.random.Generator`. This method generates random variates from -the multivariate hypergeometric probability distribution. diff --git a/doc/release/upcoming_changes/13829.improvement.rst b/doc/release/upcoming_changes/13829.improvement.rst deleted file mode 100644 index ede1b2a53..000000000 --- a/doc/release/upcoming_changes/13829.improvement.rst +++ /dev/null @@ -1,6 +0,0 @@ -Add ``axis`` argument for ``random.permutation`` and ``random.shuffle`` ------------------------------------------------------------------------ - -Previously the ``random.permutation`` and ``random.shuffle`` functions -can only shuffle an array along the first axis; they now have a -new argument ``axis`` which allows shuffle along a specified axis. diff --git a/doc/release/upcoming_changes/13899.change.rst b/doc/release/upcoming_changes/13899.change.rst deleted file mode 100644 index da8277347..000000000 --- a/doc/release/upcoming_changes/13899.change.rst +++ /dev/null @@ -1,4 +0,0 @@ -Incorrect ``threshold`` in ``np.set_printoptions`` raises ``TypeError`` or ``ValueError`` ------------------------------------------------------------------------------------------ -Previously an incorrect ``threshold`` raised ``ValueError``; it now raises ``TypeError`` -for non-numeric types and ``ValueError`` for ``nan`` values. diff --git a/doc/release/upcoming_changes/14036.deprecation.rst b/doc/release/upcoming_changes/14036.deprecation.rst deleted file mode 100644 index 3d997b9a2..000000000 --- a/doc/release/upcoming_changes/14036.deprecation.rst +++ /dev/null @@ -1,4 +0,0 @@ -Deprecate `PyArray_As1D`, `PyArray_As2D` ----------------------------------------- -`PyArray_As1D`, `PyArray_As2D` are deprecated, use -`PyArray_AsCArray` instead
\ No newline at end of file diff --git a/doc/release/upcoming_changes/14036.expired.rst b/doc/release/upcoming_changes/14036.expired.rst deleted file mode 100644 index 05164aa38..000000000 --- a/doc/release/upcoming_changes/14036.expired.rst +++ /dev/null @@ -1,2 +0,0 @@ -* ``PyArray_As1D`` and ``PyArray_As2D`` have been removed in favor of - ``PyArray_AsCArray`` diff --git a/doc/release/upcoming_changes/14039.expired.rst b/doc/release/upcoming_changes/14039.expired.rst deleted file mode 100644 index effee0626..000000000 --- a/doc/release/upcoming_changes/14039.expired.rst +++ /dev/null @@ -1,2 +0,0 @@ -* ``np.rank`` has been removed. This was deprecated in NumPy 1.10 - and has been replaced by ``np.ndim``. diff --git a/doc/release/upcoming_changes/14051.expired.rst b/doc/release/upcoming_changes/14051.expired.rst deleted file mode 100644 index 8e00ae575..000000000 --- a/doc/release/upcoming_changes/14051.expired.rst +++ /dev/null @@ -1,2 +0,0 @@ -* The deprecation of ``expand_dims`` out-of-range axes in 1.13.0 has - expired. diff --git a/doc/release/upcoming_changes/14051.new_feature.rst b/doc/release/upcoming_changes/14051.new_feature.rst deleted file mode 100644 index 617e06482..000000000 --- a/doc/release/upcoming_changes/14051.new_feature.rst +++ /dev/null @@ -1,4 +0,0 @@ -A tuple of axes can now be input to ``expand_dims`` ---------------------------------------------------- -The `numpy.expand_dims` ``axis`` keyword can now accept a tuple of -axes. Previously, ``axis`` was required to be an integer. diff --git a/doc/release/upcoming_changes/14100.expired.rst b/doc/release/upcoming_changes/14100.expired.rst deleted file mode 100644 index e9ea9eeb4..000000000 --- a/doc/release/upcoming_changes/14100.expired.rst +++ /dev/null @@ -1,3 +0,0 @@ -* ``PyArray_FromDimsAndDataAndDescr`` and ``PyArray_FromDims`` have been - removed (they will always raise an error). Use ``PyArray_NewFromDescr`` - and ``PyArray_SimpleNew`` instead. diff --git a/doc/release/upcoming_changes/14142.change.rst b/doc/release/upcoming_changes/14142.change.rst deleted file mode 100644 index 9660f2f90..000000000 --- a/doc/release/upcoming_changes/14142.change.rst +++ /dev/null @@ -1,6 +0,0 @@ -Warn when saving a dtype with metadata --------------------------------------- -A ``UserWarning`` will be emitted when saving an array via `numpy.save` with -``metadata``. Saving such an array may not preserve metadata, and if metadata -is preserved, loading it will cause a ``ValueError``. This shortcoming in save -and load will be addressed in a future release. diff --git a/doc/release/upcoming_changes/14181.deprecation.rst b/doc/release/upcoming_changes/14181.deprecation.rst deleted file mode 100644 index 9979b2246..000000000 --- a/doc/release/upcoming_changes/14181.deprecation.rst +++ /dev/null @@ -1,3 +0,0 @@ -Deprecate `np.alen` -------------------- -`np.alen` was deprecated. Use `len` instead. diff --git a/doc/release/upcoming_changes/14197.improvement.rst b/doc/release/upcoming_changes/14197.improvement.rst deleted file mode 100644 index c0c52580a..000000000 --- a/doc/release/upcoming_changes/14197.improvement.rst +++ /dev/null @@ -1,7 +0,0 @@ -``method`` keyword argument for `np.random.multivariate_normal` ---------------------------------------------------------------- -A ``method`` keyword argument is now available for -`np.random.multivariate_normal` with possible values -``{'svd', 'eigh', 'cholesky'}``. To use it, write -``np.random.multivariate_normal(..., method=<method>)``. - diff --git a/doc/release/upcoming_changes/14227.improvement.rst b/doc/release/upcoming_changes/14227.improvement.rst deleted file mode 100644 index 6e45f47c1..000000000 --- a/doc/release/upcoming_changes/14227.improvement.rst +++ /dev/null @@ -1,3 +0,0 @@ -Add complex number support for ``numpy.fromstring`` ---------------------------------------------------- -Now ``numpy.fromstring`` can read complex numbers. diff --git a/doc/release/upcoming_changes/14248.change.rst b/doc/release/upcoming_changes/14248.change.rst deleted file mode 100644 index 9ae0f16bc..000000000 --- a/doc/release/upcoming_changes/14248.change.rst +++ /dev/null @@ -1,10 +0,0 @@ -`numpy.distutils`: append behavior changed for LDFLAGS and similar ------------------------------------------------------------------- -`numpy.distutils` has always overridden rather than appended to ``LDFLAGS`` and -other similar such environment variables for compiling Fortran extensions. Now -the default behavior has changed to appending - which is the expected behavior -in most situations. To preserve the old (overwriting) behavior, set the -``NPY_DISTUTILS_APPEND_FLAGS`` environment variable to 0. This applies to: -``LDFLAGS``, ``F77FLAGS``, ``F90FLAGS``, ``FREEFLAGS``, ``FOPT``, ``FDEBUG``, -and ``FFLAGS``. NumPy 1.16 and 1.17 gave build warnings in situations where this -change in behavior would have affected the compile flags used. diff --git a/doc/release/upcoming_changes/14255.improvement.rst b/doc/release/upcoming_changes/14255.improvement.rst deleted file mode 100644 index e17835efd..000000000 --- a/doc/release/upcoming_changes/14255.improvement.rst +++ /dev/null @@ -1,4 +0,0 @@ -`numpy.unique` has consistent axes order (except the chosen one) when ``axis`` is not None ------------------------------------------------------------------------------------------- -Using ``moveaxis`` instead of ``swapaxes`` in `numpy.unique`, so that the ordering of axes -except the axis in arguments will not be broken. diff --git a/doc/release/upcoming_changes/14256.expired.rst b/doc/release/upcoming_changes/14256.expired.rst deleted file mode 100644 index 229514171..000000000 --- a/doc/release/upcoming_changes/14256.expired.rst +++ /dev/null @@ -1,3 +0,0 @@ -* ``numeric.loads``, ``numeric.load``, ``np.ma.dump``, - ``np.ma.dumps``, ``np.ma.load``, ``np.ma.loads`` are removed, - use ``pickle`` methods instead
\ No newline at end of file diff --git a/doc/release/upcoming_changes/14259.expired.rst b/doc/release/upcoming_changes/14259.expired.rst deleted file mode 100644 index fee44419b..000000000 --- a/doc/release/upcoming_changes/14259.expired.rst +++ /dev/null @@ -1,6 +0,0 @@ -* ``arrayprint.FloatFormat``, ``arrayprint.LongFloatFormat`` has been removed, - use ``FloatingFormat`` instead -* ``arrayprint.ComplexFormat``, ``arrayprint.LongComplexFormat`` has been - removed, use ``ComplexFloatingFormat`` instead -* ``arrayprint.StructureFormat`` has been removed, use ``StructureVoidFormat`` - instead
\ No newline at end of file diff --git a/doc/release/upcoming_changes/14325.expired.rst b/doc/release/upcoming_changes/14325.expired.rst deleted file mode 100644 index 348b3d524..000000000 --- a/doc/release/upcoming_changes/14325.expired.rst +++ /dev/null @@ -1,2 +0,0 @@ -* ``np.testing.rand`` has been removed. This was deprecated in NumPy 1.11 - and has been replaced by ``np.random.rand``. diff --git a/doc/release/upcoming_changes/14335.expired.rst b/doc/release/upcoming_changes/14335.expired.rst deleted file mode 100644 index 53598cea1..000000000 --- a/doc/release/upcoming_changes/14335.expired.rst +++ /dev/null @@ -1,2 +0,0 @@ -* Class ``SafeEval`` in ``numpy/lib/utils.py`` has been removed. This was deprecated in NumPy 1.10. - Use ``np.safe_eval`` instead.
\ No newline at end of file diff --git a/doc/release/upcoming_changes/14393.c_api.rst b/doc/release/upcoming_changes/14393.c_api.rst deleted file mode 100644 index 0afd27584..000000000 --- a/doc/release/upcoming_changes/14393.c_api.rst +++ /dev/null @@ -1,5 +0,0 @@ -PyDataType_ISUNSIZED(descr) now returns False for structured datatypes ----------------------------------------------------------------------- -Previously this returned True for any datatype of itemsize 0, but now this -returns false for the non-flexible datatype with itemsize 0, ``np.dtype([])``. - diff --git a/doc/release/upcoming_changes/14464.improvement.rst b/doc/release/upcoming_changes/14464.improvement.rst deleted file mode 100644 index 36ee4090b..000000000 --- a/doc/release/upcoming_changes/14464.improvement.rst +++ /dev/null @@ -1,6 +0,0 @@ -`numpy.matmul` with boolean output now converts to boolean values ------------------------------------------------------------------ -Calling `numpy.matmul` where the output is a boolean array would fill the array -with uint8 equivalents of the result, rather than 0/1. Now it forces the output -to 0 or 1 (``NPY_TRUE`` or ``NPY_FALSE``). - diff --git a/doc/release/upcoming_changes/14498.change.rst b/doc/release/upcoming_changes/14498.change.rst deleted file mode 100644 index fd784e289..000000000 --- a/doc/release/upcoming_changes/14498.change.rst +++ /dev/null @@ -1,7 +0,0 @@ -Remove ``numpy.random.entropy`` without a deprecation ------------------------------------------------------ - -``numpy.random.entropy`` was added to the `numpy.random` namespace in 1.17.0. -It was meant to be a private c-extension module, but was exposed as public. -It has been replaced by `numpy.random.SeedSequence` so the module was -completely removed. diff --git a/doc/release/upcoming_changes/14501.improvement.rst b/doc/release/upcoming_changes/14501.improvement.rst deleted file mode 100644 index f397ecccf..000000000 --- a/doc/release/upcoming_changes/14501.improvement.rst +++ /dev/null @@ -1,6 +0,0 @@ -`numpy.random.randint` produced incorrect value when the range was ``2**32`` ----------------------------------------------------------------------------- -The implementation introduced in 1.17.0 had an incorrect check when -determining whether to use the 32-bit path or the full 64-bit -path that incorrectly redirected random integer generation with a high - low -range of ``2**32`` to the 64-bit generator. diff --git a/doc/release/upcoming_changes/14510.compatibility.rst b/doc/release/upcoming_changes/14510.compatibility.rst deleted file mode 100644 index fc5edbc39..000000000 --- a/doc/release/upcoming_changes/14510.compatibility.rst +++ /dev/null @@ -1,12 +0,0 @@ -`numpy.lib.recfunctions.drop_fields` can no longer return None --------------------------------------------------------------- -If ``drop_fields`` is used to drop all fields, previously the array would -be completely discarded and None returned. Now it returns an array of the -same shape as the input, but with no fields. The old behavior can be retained -with:: - - dropped_arr = drop_fields(arr, ['a', 'b']) - if dropped_arr.dtype.names == (): - dropped_arr = None - -converting the empty recarray to None diff --git a/doc/release/upcoming_changes/14518.change.rst b/doc/release/upcoming_changes/14518.change.rst deleted file mode 100644 index ba3844c85..000000000 --- a/doc/release/upcoming_changes/14518.change.rst +++ /dev/null @@ -1,18 +0,0 @@ -Add options to quiet build configuration and build with ``-Werror`` -------------------------------------------------------------------- -Added two new configuration options. During the ``build_src`` subcommand, as -part of configuring NumPy, the files ``_numpyconfig.h`` and ``config.h`` are -created by probing support for various runtime functions and routines. -Previously, the very verbose compiler output during this stage clouded more -important information. By default the output is silenced. Running ``runtests.py ---debug-info`` will add ``--verbose-cfg`` to the ``build_src`` subcommand, -which will restore the previous behaviour. - -Adding ``CFLAGS=-Werror`` to turn warnings into errors would trigger errors -during the configuration. Now ``runtests.py --warn-error`` will add -``--warn-error`` to the ``build`` subcommand, which will percolate to the -``build_ext`` and ``build_lib`` subcommands. This will add the compiler flag -to those stages and turn compiler warnings into errors while actually building -NumPy itself, avoiding the ``build_src`` subcommand compiler calls. - -(`gh-14527 <https://github.com/numpy/numpy/pull/14527>`__) diff --git a/doc/release/upcoming_changes/14567.expired.rst b/doc/release/upcoming_changes/14567.expired.rst deleted file mode 100644 index 59cb600fb..000000000 --- a/doc/release/upcoming_changes/14567.expired.rst +++ /dev/null @@ -1,5 +0,0 @@ -The files ``numpy/testing/decorators.py``, ``numpy/testing/noseclasses.py`` -and ``numpy/testing/nosetester.py`` have been removed. They were never -meant to be public (all relevant objects are present in the -``numpy.testing`` namespace), and importing them has given a deprecation -warning since NumPy 1.15.0 diff --git a/doc/release/upcoming_changes/14583.expired.rst b/doc/release/upcoming_changes/14583.expired.rst deleted file mode 100644 index 1fad06309..000000000 --- a/doc/release/upcoming_changes/14583.expired.rst +++ /dev/null @@ -1,2 +0,0 @@ -* Remove deprecated support for boolean and empty condition lists in - `numpy.select` diff --git a/doc/release/upcoming_changes/14596.expired.rst b/doc/release/upcoming_changes/14596.expired.rst deleted file mode 100644 index 3831d5401..000000000 --- a/doc/release/upcoming_changes/14596.expired.rst +++ /dev/null @@ -1,2 +0,0 @@ -* Array order only accepts 'C', 'F', 'A', and 'K'. More permissive options - were deprecated in NumPy 1.11. diff --git a/doc/release/upcoming_changes/14620.expired.rst b/doc/release/upcoming_changes/14620.expired.rst deleted file mode 100644 index e35589b53..000000000 --- a/doc/release/upcoming_changes/14620.expired.rst +++ /dev/null @@ -1 +0,0 @@ -* np.linspace param num must be an integer. This was deprecated in NumPy 1.12. diff --git a/doc/release/upcoming_changes/14682.expired.rst b/doc/release/upcoming_changes/14682.expired.rst deleted file mode 100644 index e9a8107ec..000000000 --- a/doc/release/upcoming_changes/14682.expired.rst +++ /dev/null @@ -1,2 +0,0 @@ -* UFuncs with multiple outputs must use a tuple for the `out` kwarg. This - finishes a deprecation started in NumPy 1.10. diff --git a/doc/release/upcoming_changes/14717.compatibility.rst b/doc/release/upcoming_changes/14717.compatibility.rst deleted file mode 100644 index f6f0ec8e5..000000000 --- a/doc/release/upcoming_changes/14717.compatibility.rst +++ /dev/null @@ -1,4 +0,0 @@ -``numpy.argmin/argmax/min/max`` returns ``NaT`` if it exists in array ---------------------------------------------------------------------- -``numpy.argmin``, ``numpy.argmax``, ``numpy.min``, and ``numpy.max`` will return -``NaT`` if it exists in the array. diff --git a/doc/release/upcoming_changes/14718.compatibility.rst b/doc/release/upcoming_changes/14718.compatibility.rst deleted file mode 100644 index 3d6e71ead..000000000 --- a/doc/release/upcoming_changes/14718.compatibility.rst +++ /dev/null @@ -1,8 +0,0 @@ -``np.can_cast(np.uint64, np.timedelta64, casting='safe')`` is now ``False`` ---------------------------------------------------------------------------- - -Previously this was ``True`` - however, this was inconsistent with ``uint64`` -not being safely castable to ``int64``, and resulting in strange type -resolution. - -If this impacts your code, cast ``uint64`` to ``int64`` first. diff --git a/doc/release/upcoming_changes/14720.deprecation.rst b/doc/release/upcoming_changes/14720.deprecation.rst deleted file mode 100644 index 46ad6d8f7..000000000 --- a/doc/release/upcoming_changes/14720.deprecation.rst +++ /dev/null @@ -1,8 +0,0 @@ -Deprecate the financial functions ---------------------------------- -In accordance with -`NEP-32 <https://numpy.org/neps/nep-0032-remove-financial-functions.html>`_, -the functions `fv`, `ipmt`, `irr`, `mirr`, `nper`, `npv`, `pmt`, `ppmt`, -`pv` and `rate` are deprecated, and will be removed from NumPy 1.20. -The replacement for these functions is the Python package -`numpy-financial <https://pypi.org/project/numpy-financial>`_. diff --git a/doc/release/upcoming_changes/14730.improvement.rst b/doc/release/upcoming_changes/14730.improvement.rst deleted file mode 100644 index ee073d234..000000000 --- a/doc/release/upcoming_changes/14730.improvement.rst +++ /dev/null @@ -1,3 +0,0 @@ -Add complex number support for ``numpy.fromfile`` -------------------------------------------------- -Now ``numpy.fromfile`` can read complex numbers. diff --git a/doc/release/upcoming_changes/14771.improvement.rst b/doc/release/upcoming_changes/14771.improvement.rst deleted file mode 100644 index aaea8f8ed..000000000 --- a/doc/release/upcoming_changes/14771.improvement.rst +++ /dev/null @@ -1,5 +0,0 @@ -``std=c99`` added if compiler is named ``gcc`` ----------------------------------------------- -GCC before version 5 requires the ``-std=c99`` command line argument. Newer -compilers automatically turn on C99 mode. The compiler setup code will -automatically add the code if the compiler name has ``gcc`` in it. diff --git a/doc/release/upcoming_changes/14777.compatibility.rst b/doc/release/upcoming_changes/14777.compatibility.rst deleted file mode 100644 index d594463de..000000000 --- a/doc/release/upcoming_changes/14777.compatibility.rst +++ /dev/null @@ -1,5 +0,0 @@ -Changed random variate stream from `numpy.random.Generator.integers` --------------------------------------------------------------------- -There was a bug in `numpy.random.Generator.integers` that caused biased -sampling of 8 and 16 bit integer types. Fixing that bug has changed the -output stream from what it was in previous releases. diff --git a/doc/release/upcoming_changes/14841.compatibility.rst b/doc/release/upcoming_changes/14841.compatibility.rst deleted file mode 100644 index 51c32114a..000000000 --- a/doc/release/upcoming_changes/14841.compatibility.rst +++ /dev/null @@ -1,11 +0,0 @@ -Add more ufunc loops for ``datetime64``, ``timedelta64`` --------------------------------------------------------- -``np.datetime('NaT')`` should behave more like ``float('Nan')``. Add needed -infrastructure so ``np.isinf(a)`` and ``np.isnan(a)`` will run on -``datetime64`` and ``timedelta64`` dtypes. Also added specific loops for -`numpy.fmin` and `numpy.fmax` that mask ``NaT``. This may require adjustment to user- -facing code. Specifically, code that either disallowed the calls to -`numpy.isinf` or `numpy.isnan` or checked that they raised an exception will -require adaptation, and code that mistakenly called `numpy.fmax` and -`numpy.fmin` instead of `numpy.maximum` or `numpy.minimum` respectively will -requre adjustment. This also affects `numpy.nanmax` and `numpy.nanmin`. diff --git a/doc/release/upcoming_changes/14996.deprecation.rst b/doc/release/upcoming_changes/14996.deprecation.rst deleted file mode 100644 index b4a66fce7..000000000 --- a/doc/release/upcoming_changes/14996.deprecation.rst +++ /dev/null @@ -1,3 +0,0 @@ -The ``axis`` argument to `numpy.ma.mask_cols` and `numpy.ma.mask_row` is deprecated ------------------------------------------------------------------------------------ -This argument was always ignored. diff --git a/doc/source/release/1.18.0-notes.rst b/doc/source/release/1.18.0-notes.rst index 60e11da4a..e0b89ba67 100644 --- a/doc/source/release/1.18.0-notes.rst +++ b/doc/source/release/1.18.0-notes.rst @@ -1,8 +1,348 @@ -The NumPy 1.18 release is currently in development. Please check -the ``numpy/doc/release/upcoming_changes/`` folder for upcoming -release notes. -The ``numpy/doc/release/upcoming_changes/README.txt`` details how -to add new release notes. - -For the work in progress release notes for the current development -version, see the `devdocs <https://numpy.org/devdocs/release.html>`__. +================================ +NumPy NumPy 1.18.0 Release Notes +================================ + + +New functions +============= + +Multivariate hypergeometric distribution added to `numpy.random` +---------------------------------------------------------------- +The method `multivariate_hypergeometric` has been added to the class +`numpy.random.Generator`. This method generates random variates from +the multivariate hypergeometric probability distribution. +(`gh-13794 <https://github.com/numpy/numpy/pull/13794>`__) + + +Deprecations +============ + +`np.fromfile` and `np.fromstring` will error on bad data +-------------------------------------------------------- + +In future numpy releases, the functions `np.fromfile` and `np.fromstring` +will throw an error when parsing bad data. +This will now give a ``DeprecationWarning`` where previously partial or +even invalid data was silently returned. This deprecation also affects +the C defined functions c:func:`PyArray_FromString`` and +c:func:`PyArray_FromFile` +(`gh-13605 <https://github.com/numpy/numpy/pull/13605>`__) + +Deprecate non-scalar arrays as fill values in ``ma.fill_value`` +--------------------------------------------------------------- +Setting a ``MaskedArray.fill_value`` to a non-scalar array is deprecated +since the logic to broadcast the fill value to the array is fragile, +especially when slicing. +(`gh-13698 <https://github.com/numpy/numpy/pull/13698>`__) + +Deprecate `PyArray_As1D`, `PyArray_As2D` +---------------------------------------- +`PyArray_As1D`, `PyArray_As2D` are deprecated, use +`PyArray_AsCArray` instead +(`gh-14036 <https://github.com/numpy/numpy/pull/14036>`__) + +Deprecate `np.alen` +------------------- +`np.alen` was deprecated. Use `len` instead. +(`gh-14181 <https://github.com/numpy/numpy/pull/14181>`__) + +Deprecate the financial functions +--------------------------------- +In accordance with +`NEP-32 <https://numpy.org/neps/nep-0032-remove-financial-functions.html>`_, +the functions `fv`, `ipmt`, `irr`, `mirr`, `nper`, `npv`, `pmt`, `ppmt`, +`pv` and `rate` are deprecated, and will be removed from NumPy 1.20. +The replacement for these functions is the Python package +`numpy-financial <https://pypi.org/project/numpy-financial>`_. +(`gh-14720 <https://github.com/numpy/numpy/pull/14720>`__) + +The ``axis`` argument to `numpy.ma.mask_cols` and `numpy.ma.mask_row` is deprecated +----------------------------------------------------------------------------------- +This argument was always ignored. +(`gh-14996 <https://github.com/numpy/numpy/pull/14996>`__) + + +Expired deprecations +==================== + +* ``PyArray_As1D`` and ``PyArray_As2D`` have been removed in favor of + ``PyArray_AsCArray`` + (`gh-14036 <https://github.com/numpy/numpy/pull/14036>`__) + +* ``np.rank`` has been removed. This was deprecated in NumPy 1.10 + and has been replaced by ``np.ndim``. + (`gh-14039 <https://github.com/numpy/numpy/pull/14039>`__) + +* The deprecation of ``expand_dims`` out-of-range axes in 1.13.0 has + expired. + (`gh-14051 <https://github.com/numpy/numpy/pull/14051>`__) + +* ``PyArray_FromDimsAndDataAndDescr`` and ``PyArray_FromDims`` have been + removed (they will always raise an error). Use ``PyArray_NewFromDescr`` + and ``PyArray_SimpleNew`` instead. + (`gh-14100 <https://github.com/numpy/numpy/pull/14100>`__) + +* ``numeric.loads``, ``numeric.load``, ``np.ma.dump``, + ``np.ma.dumps``, ``np.ma.load``, ``np.ma.loads`` are removed, + use ``pickle`` methods instead + (`gh-14256 <https://github.com/numpy/numpy/pull/14256>`__) + +* ``arrayprint.FloatFormat``, ``arrayprint.LongFloatFormat`` has been removed, + use ``FloatingFormat`` instead +* ``arrayprint.ComplexFormat``, ``arrayprint.LongComplexFormat`` has been + removed, use ``ComplexFloatingFormat`` instead +* ``arrayprint.StructureFormat`` has been removed, use ``StructureVoidFormat`` + instead + (`gh-14259 <https://github.com/numpy/numpy/pull/14259>`__) + +* ``np.testing.rand`` has been removed. This was deprecated in NumPy 1.11 + and has been replaced by ``np.random.rand``. + (`gh-14325 <https://github.com/numpy/numpy/pull/14325>`__) + +* Class ``SafeEval`` in ``numpy/lib/utils.py`` has been removed. This was deprecated in NumPy 1.10. + Use ``np.safe_eval`` instead. + (`gh-14335 <https://github.com/numpy/numpy/pull/14335>`__) + +* Remove deprecated support for boolean and empty condition lists in + `numpy.select` + (`gh-14583 <https://github.com/numpy/numpy/pull/14583>`__) + +* Array order only accepts 'C', 'F', 'A', and 'K'. More permissive options + were deprecated in NumPy 1.11. + (`gh-14596 <https://github.com/numpy/numpy/pull/14596>`__) + +* np.linspace param num must be an integer. This was deprecated in NumPy 1.12. + (`gh-14620 <https://github.com/numpy/numpy/pull/14620>`__) + +* UFuncs with multiple outputs must use a tuple for the `out` kwarg. This + finishes a deprecation started in NumPy 1.10. + (`gh-14682 <https://github.com/numpy/numpy/pull/14682>`__) + +The files ``numpy/testing/decorators.py``, ``numpy/testing/noseclasses.py`` +and ``numpy/testing/nosetester.py`` have been removed. They were never +meant to be public (all relevant objects are present in the +``numpy.testing`` namespace), and importing them has given a deprecation +warning since NumPy 1.15.0 +(`gh-14567 <https://github.com/numpy/numpy/pull/14567>`__) + + +Compatibility notes +=================== + +`numpy.lib.recfunctions.drop_fields` can no longer return None +-------------------------------------------------------------- +If ``drop_fields`` is used to drop all fields, previously the array would +be completely discarded and None returned. Now it returns an array of the +same shape as the input, but with no fields. The old behavior can be retained +with:: + + dropped_arr = drop_fields(arr, ['a', 'b']) + if dropped_arr.dtype.names == (): + dropped_arr = None + +converting the empty recarray to None +(`gh-14510 <https://github.com/numpy/numpy/pull/14510>`__) + +``numpy.argmin/argmax/min/max`` returns ``NaT`` if it exists in array +--------------------------------------------------------------------- +``numpy.argmin``, ``numpy.argmax``, ``numpy.min``, and ``numpy.max`` will return +``NaT`` if it exists in the array. +(`gh-14717 <https://github.com/numpy/numpy/pull/14717>`__) + +``np.can_cast(np.uint64, np.timedelta64, casting='safe')`` is now ``False`` +--------------------------------------------------------------------------- + +Previously this was ``True`` - however, this was inconsistent with ``uint64`` +not being safely castable to ``int64``, and resulting in strange type +resolution. + +If this impacts your code, cast ``uint64`` to ``int64`` first. +(`gh-14718 <https://github.com/numpy/numpy/pull/14718>`__) + +Changed random variate stream from `numpy.random.Generator.integers` +-------------------------------------------------------------------- +There was a bug in `numpy.random.Generator.integers` that caused biased +sampling of 8 and 16 bit integer types. Fixing that bug has changed the +output stream from what it was in previous releases. +(`gh-14777 <https://github.com/numpy/numpy/pull/14777>`__) + +Add more ufunc loops for ``datetime64``, ``timedelta64`` +-------------------------------------------------------- +``np.datetime('NaT')`` should behave more like ``float('Nan')``. Add needed +infrastructure so ``np.isinf(a)`` and ``np.isnan(a)`` will run on +``datetime64`` and ``timedelta64`` dtypes. Also added specific loops for +`numpy.fmin` and `numpy.fmax` that mask ``NaT``. This may require adjustment to user- +facing code. Specifically, code that either disallowed the calls to +`numpy.isinf` or `numpy.isnan` or checked that they raised an exception will +require adaptation, and code that mistakenly called `numpy.fmax` and +`numpy.fmin` instead of `numpy.maximum` or `numpy.minimum` respectively will +requre adjustment. This also affects `numpy.nanmax` and `numpy.nanmin`. +(`gh-14841 <https://github.com/numpy/numpy/pull/14841>`__) + + +C API changes +============= + +PyDataType_ISUNSIZED(descr) now returns False for structured datatypes +---------------------------------------------------------------------- +Previously this returned True for any datatype of itemsize 0, but now this +returns false for the non-flexible datatype with itemsize 0, ``np.dtype([])``. +(`gh-14393 <https://github.com/numpy/numpy/pull/14393>`__) + + +New Features +============ + + +Add our own ``*.pxd`` cython import file +-------------------------------------------- +Added a ``numpy/__init__.pxd`` file. It will be used for `cimport numpy` +(`gh-12284 <https://github.com/numpy/numpy/pull/12284>`__) + +A tuple of axes can now be input to ``expand_dims`` +--------------------------------------------------- +The `numpy.expand_dims` ``axis`` keyword can now accept a tuple of +axes. Previously, ``axis`` was required to be an integer. +(`gh-14051 <https://github.com/numpy/numpy/pull/14051>`__) + + +Improvements +============ + +Different C numeric types of the same size have unique names +------------------------------------------------------------ +On any given platform, two of ``np.intc``, ``np.int_``, and ``np.longlong`` +would previously appear indistinguishable through their ``repr``, despite +their corresponding ``dtype`` having different properties. +A similar problem existed for the unsigned counterparts to these types, and on +some platforms for ``np.double`` and ``np.longdouble`` + +These types now always print with a unique ``__name__``. +(`gh-10151 <https://github.com/numpy/numpy/pull/10151>`__) + +``argwhere`` now produces a consistent result on 0d arrays +---------------------------------------------------------- +On N-d arrays, `numpy.argwhere` now always produces an array of shape +``(n_non_zero, arr.ndim)``, even when ``arr.ndim == 0``. Previously, the +last axis would have a dimension of 1 in this case. +(`gh-13610 <https://github.com/numpy/numpy/pull/13610>`__) + +Add ``axis`` argument for ``random.permutation`` and ``random.shuffle`` +----------------------------------------------------------------------- + +Previously the ``random.permutation`` and ``random.shuffle`` functions +can only shuffle an array along the first axis; they now have a +new argument ``axis`` which allows shuffle along a specified axis. +(`gh-13829 <https://github.com/numpy/numpy/pull/13829>`__) + +``method`` keyword argument for `np.random.multivariate_normal` +--------------------------------------------------------------- +A ``method`` keyword argument is now available for +`np.random.multivariate_normal` with possible values +``{'svd', 'eigh', 'cholesky'}``. To use it, write +``np.random.multivariate_normal(..., method=<method>)``. +(`gh-14197 <https://github.com/numpy/numpy/pull/14197>`__) + +Add complex number support for ``numpy.fromstring`` +--------------------------------------------------- +Now ``numpy.fromstring`` can read complex numbers. +(`gh-14227 <https://github.com/numpy/numpy/pull/14227>`__) + +`numpy.unique` has consistent axes order (except the chosen one) when ``axis`` is not None +------------------------------------------------------------------------------------------ +Using ``moveaxis`` instead of ``swapaxes`` in `numpy.unique`, so that the ordering of axes +except the axis in arguments will not be broken. +(`gh-14255 <https://github.com/numpy/numpy/pull/14255>`__) + +`numpy.matmul` with boolean output now converts to boolean values +----------------------------------------------------------------- +Calling `numpy.matmul` where the output is a boolean array would fill the array +with uint8 equivalents of the result, rather than 0/1. Now it forces the output +to 0 or 1 (``NPY_TRUE`` or ``NPY_FALSE``). +(`gh-14464 <https://github.com/numpy/numpy/pull/14464>`__) + +`numpy.random.randint` produced incorrect value when the range was ``2**32`` +---------------------------------------------------------------------------- +The implementation introduced in 1.17.0 had an incorrect check when +determining whether to use the 32-bit path or the full 64-bit +path that incorrectly redirected random integer generation with a high - low +range of ``2**32`` to the 64-bit generator. +(`gh-14501 <https://github.com/numpy/numpy/pull/14501>`__) + +Add complex number support for ``numpy.fromfile`` +------------------------------------------------- +Now ``numpy.fromfile`` can read complex numbers. +(`gh-14730 <https://github.com/numpy/numpy/pull/14730>`__) + +``std=c99`` added if compiler is named ``gcc`` +---------------------------------------------- +GCC before version 5 requires the ``-std=c99`` command line argument. Newer +compilers automatically turn on C99 mode. The compiler setup code will +automatically add the code if the compiler name has ``gcc`` in it. +(`gh-14771 <https://github.com/numpy/numpy/pull/14771>`__) + + +Changes +======= + +``NaT`` now sorts to the end of arrays +-------------------------------------- +``NaT`` is now effectively treated as the largest integer for sorting +purposes, so that it sorts to the end of arrays. This change is for consistency +with ``NaN`` sorting behavior. +(`gh-12658 <https://github.com/numpy/numpy/pull/12658>`__) + +Incorrect ``threshold`` in ``np.set_printoptions`` raises ``TypeError`` or ``ValueError`` +----------------------------------------------------------------------------------------- +Previously an incorrect ``threshold`` raised ``ValueError``; it now raises ``TypeError`` +for non-numeric types and ``ValueError`` for ``nan`` values. +(`gh-13899 <https://github.com/numpy/numpy/pull/13899>`__) + +Warn when saving a dtype with metadata +-------------------------------------- +A ``UserWarning`` will be emitted when saving an array via `numpy.save` with +``metadata``. Saving such an array may not preserve metadata, and if metadata +is preserved, loading it will cause a ``ValueError``. This shortcoming in save +and load will be addressed in a future release. +(`gh-14142 <https://github.com/numpy/numpy/pull/14142>`__) + +`numpy.distutils`: append behavior changed for LDFLAGS and similar +------------------------------------------------------------------ +`numpy.distutils` has always overridden rather than appended to ``LDFLAGS`` and +other similar such environment variables for compiling Fortran extensions. Now +the default behavior has changed to appending - which is the expected behavior +in most situations. To preserve the old (overwriting) behavior, set the +``NPY_DISTUTILS_APPEND_FLAGS`` environment variable to 0. This applies to: +``LDFLAGS``, ``F77FLAGS``, ``F90FLAGS``, ``FREEFLAGS``, ``FOPT``, ``FDEBUG``, +and ``FFLAGS``. NumPy 1.16 and 1.17 gave build warnings in situations where this +change in behavior would have affected the compile flags used. +(`gh-14248 <https://github.com/numpy/numpy/pull/14248>`__) + +Remove ``numpy.random.entropy`` without a deprecation +----------------------------------------------------- + +``numpy.random.entropy`` was added to the `numpy.random` namespace in 1.17.0. +It was meant to be a private c-extension module, but was exposed as public. +It has been replaced by `numpy.random.SeedSequence` so the module was +completely removed. +(`gh-14498 <https://github.com/numpy/numpy/pull/14498>`__) + +Add options to quiet build configuration and build with ``-Werror`` +------------------------------------------------------------------- +Added two new configuration options. During the ``build_src`` subcommand, as +part of configuring NumPy, the files ``_numpyconfig.h`` and ``config.h`` are +created by probing support for various runtime functions and routines. +Previously, the very verbose compiler output during this stage clouded more +important information. By default the output is silenced. Running ``runtests.py +--debug-info`` will add ``--verbose-cfg`` to the ``build_src`` subcommand, +which will restore the previous behaviour. + +Adding ``CFLAGS=-Werror`` to turn warnings into errors would trigger errors +during the configuration. Now ``runtests.py --warn-error`` will add +``--warn-error`` to the ``build`` subcommand, which will percolate to the +``build_ext`` and ``build_lib`` subcommands. This will add the compiler flag +to those stages and turn compiler warnings into errors while actually building +NumPy itself, avoiding the ``build_src`` subcommand compiler calls. + +(`gh-14527 <https://github.com/numpy/numpy/pull/14527>`__) +(`gh-14518 <https://github.com/numpy/numpy/pull/14518>`__) |