{ } Raw JSON

bundles / scipy latest / scipy / io / _harwell_boeing / hb / hb_read

function

scipy.io._harwell_boeing.hb:hb_read

source: /scipy/io/_harwell_boeing/hb.py :461

Signature

def   hb_read ( path_or_open_file * spmatrix = True )

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.

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
data = csr_array(eye(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

Aliases

  • scipy.io.hb_read