corewise_sum#

t3toolbox.corewise.corewise_sum(X, axis=None)#
def corewise_sum(
        X:      NDArrayTree,                              # any nested tree of ints/floats/arrays
        axis:   typ.Union[int, typ.Sequence[int], None] = None,  # axis/axes summed in every leaf (None -> all)
) -> NDArrayTree:                                        # same tree structure as X, summed axes removed

Sum each array in a nested object along the given axis or axes, X -> sum(X, axis).

The same axis or axes are summed in every leaf array, leaving the tree structure intact.

Examples

>>> import numpy as np
>>> import t3toolbox.corewise as cw
>>> X = (np.ones((2,3)), (np.ones((2,4)),))
>>> print(cw.corewise_sum(X, axis=0))
(array([2., 2., 2.]), (array([2., 2., 2., 2.]),))
Parameters:

  • X (NDArrayTree)

  • axis (t3toolbox.backend.common.typ.Union[int, t3toolbox.backend.common.typ.Sequence[int], None])

Return type:

NDArrayTree