diff options
author | Pauli Virtanen <pav@iki.fi> | 2008-10-27 23:40:52 +0000 |
---|---|---|
committer | Pauli Virtanen <pav@iki.fi> | 2008-10-27 23:40:52 +0000 |
commit | 7a70f54f515bb8c586c3967d62731a49217eef95 (patch) | |
tree | 1b3cf9f9a890f04a90e68f65bf85d2c75b309fbb /numpy/core/numeric.py | |
parent | 78733509e3a1f61c454fb23bae857e6a56a225de (diff) | |
download | numpy-7a70f54f515bb8c586c3967d62731a49217eef95.tar.gz |
Import documentation from doc wiki (part 1)
Diffstat (limited to 'numpy/core/numeric.py')
-rw-r--r-- | numpy/core/numeric.py | 26 |
1 files changed, 12 insertions, 14 deletions
diff --git a/numpy/core/numeric.py b/numpy/core/numeric.py index a6570c0c0..c27a0ea45 100644 --- a/numpy/core/numeric.py +++ b/numpy/core/numeric.py @@ -687,20 +687,18 @@ try: except ImportError: def alterdot(): """ - Change `dot`, `vdot`, and `innerproduct` to use accelerated BLAS - functions. - - When numpy is built with an accelerated BLAS like ATLAS, the above - functions will be replaced to make use of the faster implementations. - The faster implementations only affect float32, float64, complex64, and - complex128 arrays. Furthermore, only matrix-matrix, matrix-vector, and - vector-vector products are accelerated. Products of arrays with larger - dimensionalities will not be accelerated since the BLAS API only - includes these. - - Typically, the user will never have to call this function. If numpy was - built with an accelerated BLAS, this function will be called when numpy - is imported. + Change `dot`, `vdot`, and `innerproduct` 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 -------- |