bandhic.band_hic_matrix.sum#

band_hic_matrix.sum(axis=None)[source]#

Compute the sum of the values in the matrix or along a given axis.

Parameters:

axis (None, int, or {'row','col','diag'}, optional) –

Axis along which to compute the sum:

  • None: sum over all stored values (and default for missing).

  • 0 or ‘row’: per-row reduction.

  • 1 or ‘col’: per-column reduction.

  • ’diag’: per-diagonal reduction.

Default is None.

Returns:

Sum(s) along the specified axis.

Return type:

scalar or ndarray

Raises:

ValueError – If axis is not one of the supported values.

Examples

>>> import bandhic as bh
>>> mat = bh.band_hic_matrix(np.arange(9).reshape(3,3), diag_num=2)
>>> mat.sum()  # sum of all elements
24
>>> mat.sum(axis='row')
array([ 1, 10, 13])