File: arrays.md

package info (click to toggle)
flox 0.11.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,884 kB
  • sloc: python: 8,581; makefile: 154
file content (22 lines) | stat: -rw-r--r-- 1,354 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
# Duck Array Support

## Sparse Arrays

`sparse.COO` arrays from the `pydata/sparse` project are supported using algorithms that work on the underlying dense data.
See `aggregate_sparse.py` for details.
At the moment the following reductions are supported: `sum`, `nansum`, `min`, `nanmin`, `max`, `nanmax`, `count`.

## Other array types

Aggregating over other array types will work if the array types supports the following methods, [ufunc.reduceat](https://numpy.org/doc/stable/reference/generated/numpy.ufunc.reduceat.html) or [ufunc.at](https://numpy.org/doc/stable/reference/generated/numpy.ufunc.at.html)

| Reduction                      | `method="numpy"` | `method="flox"`   |
| ------------------------------ | ---------------- | ----------------- |
| sum, nansum                    | bincount         | add.reduceat      |
| mean, nanmean                  | bincount         | add.reduceat      |
| var, nanvar                    | bincount         | add.reduceat      |
| std, nanstd                    | bincount         | add.reduceat      |
| count                          | bincount         | add.reduceat      |
| prod                           | multiply.at      | multiply.reduceat |
| max, nanmax, argmax, nanargmax | maximum.at       | maximum.reduceat  |
| min, nanmin, argmin, nanargmin | minimum.at       | minimum.reduceat  |