{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Sparse arrays can be used in arithmetic operations: they support addition, subtraction, multiplication, division, and matrix power. Sparse arrays with DIAgonal storage do not support slicing." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "Format details" } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The " }, { "__type": "InlineCode", "__tag": 4051, "value": "data" }, { "__type": "Text", "__tag": 4046, "value": " array stores the diagonal elements. The alignment of these elements within the rows of " }, { "__type": "InlineCode", "__tag": 4051, "value": "data" }, { "__type": "Text", "__tag": 4046, "value": " depends on their position relative to the main diagonal:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "Main diagonal" } ] }, { "__type": "Text", "__tag": 4046, "value": " (" }, { "__type": "InlineCode", "__tag": 4051, "value": "offsets[i] == 0" }, { "__type": "Text", "__tag": 4046, "value": "): Elements start at column 0." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "Super-diagonals" } ] }, { "__type": "Text", "__tag": 4046, "value": " (" }, { "__type": "InlineCode", "__tag": 4051, "value": "offsets[i] > 0" }, { "__type": "Text", "__tag": 4046, "value": "): Elements are right-aligned (padded with zeros on the left)." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Strong", "__tag": 4048, "children": [ { "__type": "Text", "__tag": 4046, "value": "Sub-diagonals" } ] }, { "__type": "Text", "__tag": 4046, "value": " (" }, { "__type": "InlineCode", "__tag": 4051, "value": "offsets[i] < 0" }, { "__type": "Text", "__tag": 4046, "value": "): Elements are left-aligned (padded with zeros on the right)." } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Each column of " }, { "__type": "InlineCode", "__tag": 4051, "value": "data" }, { "__type": "Text", "__tag": 4046, "value": " corresponds to a diagonal in the resulting matrix." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Mathematically, the element at row " }, { "__type": "InlineCode", "__tag": 4051, "value": "r" }, { "__type": "Text", "__tag": 4046, "value": " and column " }, { "__type": "InlineCode", "__tag": 4051, "value": "c" }, { "__type": "Text", "__tag": 4046, "value": " of the matrix is stored in the " }, { "__type": "InlineCode", "__tag": 4051, "value": "data" }, { "__type": "Text", "__tag": 4046, "value": " array at row " }, { "__type": "InlineCode", "__tag": 4051, "value": "i" }, { "__type": "Text", "__tag": 4046, "value": " and column " }, { "__type": "InlineCode", "__tag": 4051, "value": "c - max(0, -offsets[i])" }, { "__type": "Text", "__tag": 4046, "value": ", where " }, { "__type": "InlineCode", "__tag": 4051, "value": "i" }, { "__type": "Text", "__tag": 4046, "value": " is the index of the diagonal in " }, { "__type": "InlineCode", "__tag": 4051, "value": "offsets" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Note that if " }, { "__type": "InlineCode", "__tag": 4051, "value": "offsets" }, { "__type": "Text", "__tag": 4046, "value": " is provided in decreasing order, this format matches the BLAS/LAPACK general band format (e.g., as used in " }, { "__type": "InlineCode", "__tag": 4051, "value": "dgbmv" }, { "__type": "Text", "__tag": 4046, "value": ")." } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Yields": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Methods": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Returns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Sparse array with DIAgonal storage." } ] } ], "title": [], "level": 0, "target": null }, "Receives": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Warnings": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Attributes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "data", "annotation": "", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "DIA format data array of the array" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "offsets", "annotation": "", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "DIA format offset array of the array" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "dtype", "annotation": "dtype", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Data type of the array" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "shape", "annotation": "2-tuple", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Shape of the array" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "ndim", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of dimensions (this is always 2)" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "format", "annotation": "str", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Three letter code for the format of the array storage, e.g. 'dia'" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "nnz", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of values stored in the array" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "size", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of values stored in the array" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "T", "annotation": "dia_array", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The transpose of the array" } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "mT", "annotation": "dia_array", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The matrix transpose of the array" } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This can be instantiated in several ways:" } ] }, "dd": [ { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "dia_array(D)" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "where D is a 2-D ndarray" } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "dia_array(S)" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "with another sparse array or matrix S (equivalent to S.todia())" } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "dia_array((M, N), [dtype])" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "to construct an empty array with shape (M, N), dtype is optional, defaulting to dtype='d'." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "dia_array((data, offsets), shape=(M, N))" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "where the " }, { "__type": "InlineCode", "__tag": 4051, "value": "data[k,:]" }, { "__type": "Text", "__tag": 4046, "value": " stores the diagonal entries for diagonal " }, { "__type": "InlineCode", "__tag": 4051, "value": "offsets[k]" }, { "__type": "Text", "__tag": 4046, "value": " (See example below)" } ] } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Other Parameters": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null } }, "_ordered_sections": [ "Summary", "Extended Summary", "Parameters", "Attributes", "Methods", "Returns", "Yields", "Receives", "Other Parameters", "Raises", "Warns", "Warnings", "Notes" ], "item_file": "build-install/usr/lib/python3.14/site-packages/scipy/sparse/_dia.py", "item_line": 530, "item_type": "ABCMeta", "aliases": [ "scipy.sparse.dia_array" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nfrom scipy.sparse import dia_array\ndia_array((3, 4), dtype=np.int8).toarray()\n", "execution_status": "success", "out": "array([[0, 0, 0, 0],\n [0, 0, 0, 0],\n [0, 0, 0, 0]], dtype=int8)\n" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "data = np.array([[1, 2, 3, 4]]).repeat(3, axis=0)\noffsets = np.array([0, -1, 2])\ndia_array((data, offsets), shape=(4, 4)).toarray()\n", "execution_status": "success", "out": "array([[1, 0, 3, 0],\n [1, 2, 0, 4],\n [0, 2, 3, 0],\n [0, 0, 3, 4]])\n" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "from scipy.sparse import dia_array\nn = 10\nex = np.ones(n)\ndata = np.array([ex, 2 * ex, ex])\noffsets = np.array([-1, 0, 1])\ndia_array((data, offsets), shape=(n, n)).toarray()\n", "execution_status": "success", "out": "array([[2., 1., 0., 0., 0., 0., 0., 0., 0., 0.],\n [1., 2., 1., 0., 0., 0., 0., 0., 0., 0.],\n [0., 1., 2., 1., 0., 0., 0., 0., 0., 0.],\n [0., 0., 1., 2., 1., 0., 0., 0., 0., 0.],\n [0., 0., 0., 1., 2., 1., 0., 0., 0., 0.],\n [0., 0., 0., 0., 1., 2., 1., 0., 0., 0.],\n [0., 0., 0., 0., 0., 1., 2., 1., 0., 0.],\n [0., 0., 0., 0., 0., 0., 1., 2., 1., 0.],\n [0., 0., 0., 0., 0., 0., 0., 1., 2., 1.],\n [0., 0., 0., 0., 0., 0., 0., 0., 1., 2.]])\n" } ], "title": [], "level": 0, "target": null }, "see_also": [], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "arg1", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "shape", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "dtype", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "copy", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__type": "SigParam", "__tag": 4030, "name": "maxprint", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "dia_array" }, "references": null, "qa": "scipy.sparse._dia:dia_array", "arbitrary": [], "local_refs": [ "T", "data", "dtype", "format", "mT", "ndim", "nnz", "offsets", "shape", "size" ] }