diff options
| author | Matti Picus <matti.picus@gmail.com> | 2018-05-15 20:11:56 +0300 |
|---|---|---|
| committer | Charles Harris <charlesr.harris@gmail.com> | 2018-05-15 11:11:56 -0600 |
| commit | 9584c2f8ed78194ec18d20aea9616d4a89ee74fa (patch) | |
| tree | dabbb34bd2491c8a0cf7b179ea901ecd5e331da9 /doc/source/reference | |
| parent | 5023c3b8decf91f435676e0e3767a3ca68eee316 (diff) | |
| download | numpy-9584c2f8ed78194ec18d20aea9616d4a89ee74fa.tar.gz | |
DOC: Mention we can return unitinitialized values (#11086)
* DOC: mention we can return unitinitialized values
* squash and rebase, extend explanation and improve docstring template
* MAINT: Spelling fixes for docstrings.
[ci skip]
* MAINT: Update following feedback.
Diffstat (limited to 'doc/source/reference')
| -rw-r--r-- | doc/source/reference/ufuncs.rst | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/source/reference/ufuncs.rst b/doc/source/reference/ufuncs.rst index 59d25a9ca..bebd047f6 100644 --- a/doc/source/reference/ufuncs.rst +++ b/doc/source/reference/ufuncs.rst @@ -327,6 +327,13 @@ advanced usage and will not typically be used. multiple outputs is deprecated, and will raise a warning in numpy 1.10, and an error in a future release. + If 'out' is None (the default), a uninitialized return array is created. + The output array is then filled with the results of the ufunc in the places + that the broadcast 'where' is True. If 'where' is the scalar True (the + default), then this corresponds to the entire output being filled. + Note that outputs not explicitly filled are left with their + uninitialized values. + *where* .. versionadded:: 1.7 @@ -336,6 +343,9 @@ advanced usage and will not typically be used. of False indicate to leave the value in the output alone. This argument cannot be used for generalized ufuncs as those take non-scalar input. + Note that if an uninitialized return array is created, values of False + will leave those values **uninitialized**. + *axes* .. versionadded:: 1.15 |
