scipy 1.8.0 Pypi GitHub Homepage
Other Docs
NotesParametersReturnsBackRef
block_diag(mats, format=None, dtype=None)

Notes

versionadded

Parameters

mats : sequence of matrices

Input matrices.

format : str, optional

The sparse format of the result (e.g., "csr"). If not given, the matrix is returned in "coo" format.

dtype : dtype specifier, optional

The data-type of the output matrix. If not given, the dtype is determined from that of :None:None:`blocks`.

Returns

res : sparse matrix

Build a block diagonal sparse matrix from provided matrices.

See Also

bmat
diags

Examples

>>> from scipy.sparse import coo_matrix, block_diag
... A = coo_matrix([[1, 2], [3, 4]])
... B = coo_matrix([[5], [6]])
... C = coo_matrix([[7]])
... block_diag((A, B, C)).toarray() array([[1, 2, 0, 0], [3, 4, 0, 0], [0, 0, 5, 0], [0, 0, 6, 0], [0, 0, 0, 7]])
See :

Back References

The following pages refer to to this document either explicitly or contain code examples using this.

scipy.sparse._construct.bmat scipy.sparse._construct.block_diag

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


GitHub : /scipy/sparse/_construct.py#691
type: <class 'function'>
Commit: