{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "There are two modes of creating an array using " }, { "__type": "InlineCode", "__tag": 4051, "value": "__new__" }, { "__type": "Text", "__tag": 4046, "value": ":" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": true, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "buffer" }, { "__type": "Text", "__tag": 4046, "value": " is None, then only " }, { "__type": "ParamRef", "__tag": 4071, "name": "shape" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "ParamRef", "__tag": 4071, "name": "dtype" }, { "__type": "Text", "__tag": 4046, "value": ", and " }, { "__type": "ParamRef", "__tag": 4071, "name": "order" }, { "__type": "Text", "__tag": 4046, "value": " are used." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "buffer" }, { "__type": "Text", "__tag": 4046, "value": " is an object exposing the buffer interface, then all keywords are interpreted." } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "No " }, { "__type": "InlineCode", "__tag": 4051, "value": "__init__" }, { "__type": "Text", "__tag": 4046, "value": " method is needed because the array is fully initialized after the " }, { "__type": "InlineCode", "__tag": 4051, "value": "__new__" }, { "__type": "Text", "__tag": 4046, "value": " method." } ] } ], "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": "An array object represents a multidimensional, homogeneous array of fixed-size items. An associated data-type object describes the format of each element in the array (its byte-order, how many bytes it occupies in memory, whether it is an integer, a floating point number, or something else, etc.)" } ] } ], "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": "T", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Transpose of the array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "data", "annotation": "buffer", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The array's elements, in memory." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "dtype", "annotation": "dtype object", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Describes the format of the elements in the array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "flags", "annotation": "dict", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Dictionary containing information related to memory use, e.g., 'C_CONTIGUOUS', 'OWNDATA', 'WRITEABLE', etc." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "flat", "annotation": "numpy.flatiter object", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Flattened version of the array as an iterator. The iterator allows assignments, e.g., " }, { "__type": "InlineCode", "__tag": 4051, "value": "x.flat = 3" }, { "__type": "Text", "__tag": 4046, "value": " (See " }, { "__type": "InlineRole", "__tag": 4003, "value": "ndarray.flat", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for assignment examples; TODO)." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "imag", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Imaginary part of the array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "real", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Real part of the array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "size", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of elements in the array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "itemsize", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The memory use of each array element in bytes." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "nbytes", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The total number of bytes required to store the array data, i.e., " }, { "__type": "InlineCode", "__tag": 4051, "value": "itemsize * size" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "ndim", "annotation": "int", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The array's number of dimensions." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "shape", "annotation": "tuple of ints", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Shape of the array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "strides", "annotation": "tuple of ints", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The step-size required to move from one element to the next in memory. For example, a contiguous " }, { "__type": "InlineCode", "__tag": 4051, "value": "(3, 4)" }, { "__type": "Text", "__tag": 4046, "value": " array of type " }, { "__type": "InlineCode", "__tag": 4051, "value": "int16" }, { "__type": "Text", "__tag": 4046, "value": " in C-order has strides " }, { "__type": "InlineCode", "__tag": 4051, "value": "(8, 2)" }, { "__type": "Text", "__tag": 4046, "value": ". This implies that to move from element to element in memory requires jumps of 2 bytes. To move from row-to-row, one needs to jump 8 bytes at a time (" }, { "__type": "InlineCode", "__tag": 4051, "value": "2 * 4" }, { "__type": "Text", "__tag": 4046, "value": ")." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "ctypes", "annotation": "ctypes object", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Class containing properties of the array needed for interaction with ctypes." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "base", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If the array is a view into another array, that array is its " }, { "__type": "CrossRef", "__tag": 4002, "value": "base", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "base" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " (unless that array is also a view). The " }, { "__type": "CrossRef", "__tag": 4002, "value": "base", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "base" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " array is where the array data is actually stored." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "(for the __new__ method; see Notes below)", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "shape", "annotation": "tuple of ints", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Shape of created array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "dtype", "annotation": "data-type, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Any object that can be interpreted as a numpy data type. Default is " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.float64", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:float64" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "buffer", "annotation": "object exposing buffer interface, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Used to fill the array with data." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "offset", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Offset of array data in buffer." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "strides", "annotation": "tuple of ints, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Strides of data in memory." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "order", "annotation": "{'C', 'F'}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Row-major (C-style) or column-major (Fortran-style) order." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Arrays should be constructed using " }, { "__type": "CrossRef", "__tag": 4002, "value": "array", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:ndarray" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineRole", "__tag": 4003, "value": "zeros", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineRole", "__tag": 4003, "value": "empty", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " (refer to the See Also section below). The parameters given here refer to a low-level method (" }, { "__type": "InlineRole", "__tag": 4003, "value": "ndarray(...)", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ") for instantiating an array." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For more information, refer to the " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " module and examine the methods and attributes of an array." } ] } ], "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": "/opt/hostedtoolcache/Python/3.14.5/x64/lib/python3.14/types.py", "item_line": null, "item_type": "GenericAlias", "aliases": [ "numpy.ndarray", "numpy.typing.NDArray" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "These examples illustrate the low-level `ndarray` constructor. Refer\nto the `See Also` section above for easier ways of constructing an\nndarray.\n\nFirst mode, `buffer` is None:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "import numpy as np\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.ndarray(shape=(2,2), dtype=float, order='F')\n", "execution_status": "failure" }, { "__type": "Text", "__tag": 4046, "value": "\nSecond mode:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.ndarray((2,), buffer=np.array([1,2,3]),\n offset=np.int_().itemsize,\n dtype=int) # offset = 1*itemsize, i.e. skip first element\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "array", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:ndarray" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Construct an array." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "dtype", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "dtype" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Create a data-type." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "empty", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "empty" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Create an array, but leave its allocated memory unchanged (i.e., it contains \"garbage\")." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "numpy.typing.NDArray", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "numpy.typing.NDArray" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "An ndarray alias " }, { "__type": "InlineRole", "__tag": 4003, "value": "generic ", "domain": null, "role": "term", "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " w.r.t. its " }, { "__type": "InlineRole", "__tag": 4003, "value": "dtype.type ", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "zeros", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "zeros" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Create an array, each element of which is zero." } ] } ], "type": null } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "shape", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "dtype", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "" }, { "__type": "SigParam", "__tag": 4030, "name": "buffer", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "offset", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0" }, { "__type": "SigParam", "__tag": 4030, "name": "strides", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "order", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "ndarray" }, "references": null, "qa": "numpy:ndarray", "arbitrary": [], "local_refs": [ "(for the __new__ method; see Notes below)", "T", "base", "buffer", "ctypes", "data", "dtype", "flags", "flat", "imag", "itemsize", "nbytes", "ndim", "offset", "order", "real", "shape", "size", "strides" ] }