diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2014-08-22 12:54:21 -0600 |
|---|---|---|
| committer | Julian Taylor <jtaylor.debian@googlemail.com> | 2014-09-04 21:47:14 +0200 |
| commit | d8a837714c241b729cdd823ae498adce242f3a75 (patch) | |
| tree | d44d59c4ecc422bf9b44d03ff15303e86393c1f4 /numpy/add_newdocs.py | |
| parent | 9c1d5538b5bf8682b82f0290615d3e9d7f97d746 (diff) | |
| download | numpy-d8a837714c241b729cdd823ae498adce242f3a75.tar.gz | |
DOC: Update docs to reflect deprecation of alterdot and restoredot.
Also move docstrings into the versions in numpy/core/numeric.py as
the functions are no longer in the defunct _dotblas module.
Diffstat (limited to 'numpy/add_newdocs.py')
| -rw-r--r-- | numpy/add_newdocs.py | 37 |
1 files changed, 0 insertions, 37 deletions
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) |