Skip to content

Commit

Permalink
add an entry to NEWS.md about the reduction functions that allow pre-…
Browse files Browse the repository at this point in the history
…allocated output
  • Loading branch information
lindahua committed Mar 18, 2014
1 parent a6c0f61 commit b2e25f9
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
3 changes: 3 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,6 +256,9 @@ Deprecated or removed

* `read` methods that modify a passed array are now called `read!` ([#5970])

* Reduction functions that accept a pre-allocated output array, including
`sum!`, `prod!`, `maximum!`, `minimum!`, `all!`, `any!` ([#6197])

[#4042]: https://github.com/JuliaLang/julia/issues/4042
[#5164]: https://github.com/JuliaLang/julia/issues/5164
[#4026]: https://github.com/JuliaLang/julia/issues/4026
Expand Down
18 changes: 12 additions & 6 deletions doc/stdlib/base.rst
Original file line number Diff line number Diff line change
Expand Up @@ -562,7 +562,8 @@ Iterable Collections

.. function:: maximum!(r, A)

Compute the maximum value of ``A`` over the singleton dimensions of ``r``, and write results to ``r``.
Compute the maximum value of ``A`` over the singleton dimensions of ``r``,
and write results to ``r``.

.. function:: minimum(itr)

Expand All @@ -574,7 +575,8 @@ Iterable Collections

.. function:: minimum!(r, A)

Compute the minimum value of ``A`` over the singleton dimensions of ``r``, and write results to ``r``.
Compute the minimum value of ``A`` over the singleton dimensions of ``r``,
and write results to ``r``.

.. function:: extrema(itr)

Expand Down Expand Up @@ -607,7 +609,8 @@ Iterable Collections

.. function:: sum!(r, A)

Sum elements of ``A`` over the singleton dimensions of ``r``, and write results to ``r``.
Sum elements of ``A`` over the singleton dimensions of ``r``,
and write results to ``r``.

.. function:: sum(f, itr)

Expand All @@ -623,7 +626,8 @@ Iterable Collections

.. function:: prod!(r, A)

Multiply elements of ``A`` over the singleton dimensions of ``r``, and write results to ``r``.
Multiply elements of ``A`` over the singleton dimensions of ``r``,
and write results to ``r``.

.. function:: any(itr) -> Bool

Expand All @@ -635,7 +639,8 @@ Iterable Collections

.. function:: any!(r, A)

Test whether any values in ``A`` along the singleton dimensions of ``r`` are true, and write results to ``r``.
Test whether any values in ``A`` along the singleton dimensions of ``r`` are true,
and write results to ``r``.

.. function:: all(itr) -> Bool

Expand All @@ -647,7 +652,8 @@ Iterable Collections

.. function:: all!(r, A)

Test whether all values in ``A`` along the singleton dimensions of ``r`` are true, and write results to ``r``.
Test whether all values in ``A`` along the singleton dimensions of ``r`` are true,
and write results to ``r``.

.. function:: count(p, itr) -> Integer

Expand Down

0 comments on commit b2e25f9

Please sign in to comment.