Skip to content

Commit 23dbeec

Browse files
authored
docs: add note
Signed-off-by: Athan <kgryte@gmail.com>
1 parent a764494 commit 23dbeec

File tree

1 file changed

+1
-0
lines changed
  • lib/node_modules/@stdlib/stats/meanors

1 file changed

+1
-0
lines changed

lib/node_modules/@stdlib/stats/meanors/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,7 @@ The function accepts the following options:
218218

219219
- Setting the `keepdims` option to `true` can be useful when wanting to ensure that the output [ndarray][@stdlib/ndarray/ctor] is [broadcast-compatible][@stdlib/ndarray/base/broadcast-shapes] with ndarrays having the same shape as the input [ndarray][@stdlib/ndarray/ctor].
220220
- The output data type [policy][@stdlib/ndarray/output-dtype-policies] only applies to the main function and specifies that, by default, the function must return an [ndarray][@stdlib/ndarray/ctor] having a real-valued floating-point or "generic" [data type][@stdlib/ndarray/dtypes]. For the `assign` method, the output [ndarray][@stdlib/ndarray/ctor] is allowed to have any supported output [data type][@stdlib/ndarray/dtypes].
221+
- Ordinary recursive summation (i.e., a "simple" sum) is performant, but can incur significant numerical error. If performance is paramount and error tolerated, using ordinary recursive summation to compute an arithmetic mean is acceptable; in all other cases, exercise due caution.
221222

222223
</section>
223224

0 commit comments

Comments
 (0)