bandhic.full#

bandhic.full(shape, fill_value, diag_num=1, dtype=<class 'numpy.float64'>)[source]#

Create a band_hic_matrix object filled with a specified value.

Parameters:
  • shape (tuple of int) – Matrix shape as (bins, bins).

  • fill_value (scalar) – Value to fill the matrix with.

  • diag_num (int, optional) – Number of diagonals to consider. Default is 1.

  • dtype (data-type, optional) – The data type of the matrix. Default is np.float64.

Returns:

A band_hic_matrix object with all entries filled with fill_value.

Return type:

band_hic_matrix

Examples

>>> import bandhic as bh
>>> mat = bh.full((5, 5), fill_value=7, diag_num=3)
>>> print(mat)
band_hic_matrix(shape=(5, 5), diag_num=3, dtype=<class 'numpy.float64'>)