{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "By eliminating the inner loop in the description above, and using " }, { "__type": "InlineRole", "__tag": 4003, "value": "s_", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " to build simple slice objects, " }, { "__type": "InlineRole", "__tag": 4003, "value": "take", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " can be expressed in terms of applying fancy indexing to each 1-d slice " } ] }, { "__type": "Code", "__tag": 4050, "value": "Ni, Nk = a.shape[:axis], a.shape[axis+1:]\nfor ii in ndindex(Ni):\n for kk in ndindex(Nk):\n out[ii + s_[...,] + kk] = a[ii + s_[:,] + kk][indices]", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For this reason, it is equivalent to (but faster than) the following use of " }, { "__type": "InlineRole", "__tag": 4003, "value": "apply_along_axis", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ": " } ] }, { "__type": "Code", "__tag": 4050, "value": "out = np.apply_along_axis(lambda a_1d: a_1d[indices], axis, a)", "execution_status": null } ], "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": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "out", "annotation": "ndarray (Ni..., Nj..., Nk...)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The returned array has the same type as " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Take elements from an array along an axis." } ] } ], "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": [], "title": [], "level": 0, "target": null }, "Parameters": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "a", "annotation": "array_like (Ni..., M, Nk...)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The source array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "indices", "annotation": "array_like (Nj...)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The indices of the values to extract. Also allow scalars for indices." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "axis", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The axis over which to select values. By default, the flattened input array is used." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "out", "annotation": "ndarray, optional (Ni..., Nj..., Nk...)", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If provided, the result will be placed in this array. It should be of the appropriate shape and dtype. Note that " }, { "__type": "ParamRef", "__tag": 4071, "name": "out" }, { "__type": "Text", "__tag": 4046, "value": " is always buffered if " }, { "__type": "InlineRole", "__tag": 4003, "value": "mode='raise'", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": "; use other modes for better performance." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "mode", "annotation": "{'raise', 'wrap', 'clip'}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Specifies how out-of-bounds indices will behave." } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'raise' -- raise an error (default)" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'wrap' -- wrap around" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'clip' -- clip to the range" } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'clip' mode means that all indices that are too large are replaced by the index that addresses the last element along that axis. Note that this disables indexing with negative numbers." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When axis is not None, this function does the same thing as \"fancy\" indexing (indexing arrays using arrays); however, it can be easier to use if you need elements along a given axis. A call such as " }, { "__type": "InlineCode", "__tag": 4051, "value": "np.take(arr, indices, axis=3)" }, { "__type": "Text", "__tag": 4046, "value": " is equivalent to " }, { "__type": "InlineCode", "__tag": 4051, "value": "arr[:,:,:,indices,...]" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Explained without fancy indexing, this is equivalent to the following use of " }, { "__type": "InlineRole", "__tag": 4003, "value": "ndindex", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", which sets each of " }, { "__type": "InlineCode", "__tag": 4051, "value": "ii" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "InlineCode", "__tag": 4051, "value": "jj" }, { "__type": "Text", "__tag": 4046, "value": ", and " }, { "__type": "InlineCode", "__tag": 4051, "value": "kk" }, { "__type": "Text", "__tag": 4046, "value": " to a tuple of indices " } ] }, { "__type": "Code", "__tag": 4050, "value": "Ni, Nk = a.shape[:axis], a.shape[axis+1:]\nNj = indices.shape\nfor ii in ndindex(Ni):\n for jj in ndindex(Nj):\n for kk in ndindex(Nk):\n out[ii + jj + kk] = a[ii + (indices[jj],) + kk]", "execution_status": null } ], "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": "/dev/numpy/build-install/usr/lib/python3.14/site-packages/numpy/_core/fromnumeric.py", "item_line": 106, "item_type": "_ArrayFunctionDispatcher", "aliases": [ "numpy.take" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\na = [4, 3, 5, 7, 6, 8]\nindices = [0, 1, 4]\nnp.take(a, indices)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nIn this example if `a` is an ndarray, \"fancy\" indexing can be used.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "a = np.array(a)\na[indices]\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nIf `indices` is not one dimensional, the output also has these dimensions.\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.take(a, [[0, 1], [2, 3]])\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "compress", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "compress" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Take elements using a boolean mask" } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "ndarray.take", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "ndarray.take" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "equivalent method" } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "take_along_axis", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:take_along_axis" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Take elements by matching the array and the index arrays" } ] } ], "type": null } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "a", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "indices", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "axis", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "out", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "mode", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "raise" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "take" }, "references": null, "qa": "numpy:take", "arbitrary": [], "local_refs": [ "a", "axis", "indices", "mode", "out" ] }