`scipy.io._harwell_boeing.hb:hb_read`

source: build-install/usr/lib/python3.14/site-packages/scipy/io/_harwell_boeing/hb.py:466

Signature

def hb_read(path_or_open_file, *, spmatrix = <object object at 0x0000>)

Summary

Read HB-format file.

Parameters

path_or_open_file : path-like or file-like: If a file-like object, it is used as-is. Otherwise, it is opened before reading.
spmatrix : bool, optional (default: True): If True, return sparse matrix. Otherwise return sparse array.
deprecated 1.18.0
The default value for spmatrix is changing to False in v2.1. That means the default return value will be a sparse array. Unless you use * instead of @, ** for matrix power, or you depend on 2D shapes from e.g. A.sum(axis=0), it may not matter to you. See Migration from spmatrix to sparray.
deprecated 2.0.0
The value True for spmatrix will no longer be supported in v2.2. The spmatrix classes are deprecated and will be removed then.

Returns

data : csc_array or csc_matrix: The data read from the HB file as a sparse array.

Notes

At the moment not the full Harwell-Boeing format is supported. Supported features are:

assembled, non-symmetric, real matrices
integer for pointer/indices
exponential format for float values, and int format

Examples

We can read and write a harwell-boeing format file:

from scipy.io import hb_read, hb_write
from scipy.sparse import csr_array, eye_array
data = csr_array(eye_array(3))  # create a sparse array
hb_write("data.hb", data)  # write a hb file

✓

print(hb_read("data.hb", spmatrix=False))  # read a hb file

✗

<Compressed Sparse Column sparse array of dtype 'float64'
	with 3 stored elements and shape (3, 3)>
  Coords	Values
  (0, 0)	1.0
  (1, 1)	1.0
  (2, 2)	1.0

Aliases

scipy.io.hb_read