diff options
| -rw-r--r-- | doc/release/1.10.0-notes.rst | 12 | ||||
| -rw-r--r-- | numpy/add_newdocs.py | 37 | ||||
| -rw-r--r-- | numpy/core/numeric.py | 44 |
3 files changed, 56 insertions, 37 deletions
diff --git a/doc/release/1.10.0-notes.rst b/doc/release/1.10.0-notes.rst index 3f52bd5af..386edac45 100644 --- a/doc/release/1.10.0-notes.rst +++ b/doc/release/1.10.0-notes.rst @@ -11,6 +11,7 @@ Highlights Dropped Support =============== * The polytemplate.py file has been removed. +* The _dotblas module is no longer available. Future Changes @@ -33,6 +34,17 @@ Improvements Changes ======= +dotblas functionality moved to multiarray +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The cblas versions of dot, inner, and vdot have been integrated into +the multiarray module. In particular, vdot is now a multiarray function, +which it was not before. + Deprecations ============ + +alterdot, restoredot Deprecated +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The alterdot and restoredot functions no longer do anything, and are +deprecated. diff --git a/numpy/add_newdocs.py b/numpy/add_newdocs.py index 09311a536..6f3a10de4 100644 --- a/numpy/add_newdocs.py +++ b/numpy/add_newdocs.py @@ -2174,43 +2174,6 @@ add_newdoc('numpy.core', 'einsum', """) -add_newdoc('numpy.core', 'alterdot', - """ - Change `dot`, `vdot`, and `inner` to use accelerated BLAS functions. - - Typically, as a user of Numpy, you do not explicitly call this function. If - Numpy is built with an accelerated BLAS, this function is automatically - called when Numpy is imported. - - When Numpy is built with an accelerated BLAS like ATLAS, these functions - are replaced to make use of the faster implementations. The faster - implementations only affect float32, float64, complex64, and complex128 - arrays. Furthermore, the BLAS API only includes matrix-matrix, - matrix-vector, and vector-vector products. Products of arrays with larger - dimensionalities use the built in functions and are not accelerated. - - See Also - -------- - restoredot : `restoredot` undoes the effects of `alterdot`. - - """) - -add_newdoc('numpy.core', 'restoredot', - """ - Restore `dot`, `vdot`, and `innerproduct` to the default non-BLAS - implementations. - - Typically, the user will only need to call this when troubleshooting and - installation problem, reproducing the conditions of a build without an - accelerated BLAS, or when being very careful about benchmarking linear - algebra operations. - - See Also - -------- - alterdot : `restoredot` undoes the effects of `alterdot`. - - """) - add_newdoc('numpy.core', 'vdot', """ vdot(a, b) diff --git a/numpy/core/numeric.py b/numpy/core/numeric.py index e472f1d3f..ac51f5d01 100644 --- a/numpy/core/numeric.py +++ b/numpy/core/numeric.py @@ -1082,10 +1082,54 @@ inner = multiarray.inner vdot = multiarray.vdot def alterdot(): + """ + Change `dot`, `vdot`, and `inner` to use accelerated BLAS functions. + + Typically, as a user of Numpy, you do not explicitly call this + function. If Numpy is built with an accelerated BLAS, this function is + automatically called when Numpy is imported. + + When Numpy is built with an accelerated BLAS like ATLAS, these + functions are replaced to make use of the faster implementations. The + faster implementations only affect float32, float64, complex64, and + complex128 arrays. Furthermore, the BLAS API only includes + matrix-matrix, matrix-vector, and vector-vector products. Products of + arrays with larger dimensionalities use the built in functions and are + not accelerated. + + .. note:: Deprecated in Numpy 1.10 + The cblas functions have been integrated into the multarray + module and alterdot now longer does anything. It will be + removed in Numpy 1.11.0. + + See Also + -------- + restoredot : `restoredot` undoes the effects of `alterdot`. + + """ warnings.warn("alterdot no longer does anything.", DeprecationWarning) def restoredot(): + """ + Restore `dot`, `vdot`, and `innerproduct` to the default non-BLAS + implementations. + + Typically, the user will only need to call this when troubleshooting + and installation problem, reproducing the conditions of a build without + an accelerated BLAS, or when being very careful about benchmarking + linear algebra operations. + + .. note:: Deprecated in Numpy 1.10 + The cblas functions have been integrated into the multarray + module and restoredot now longer does anything. It will be + removed in Numpy 1.11.0. + + See Also + -------- + alterdot : `restoredot` undoes the effects of `alterdot`. + + """ warnings.warn("restoredot no longer does anything.", DeprecationWarning) |