{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If values in " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": " are such that they fall outside the bin range, attempting to index " }, { "__type": "ParamRef", "__tag": 4071, "name": "bins" }, { "__type": "Text", "__tag": 4046, "value": " with the indices that " }, { "__type": "CrossRef", "__tag": 4002, "value": "digitize", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:digitize" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " returns will result in an IndexError." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 1.10.0" } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "numpy.digitize", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:digitize" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " is implemented in terms of " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.searchsorted", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:searchsorted" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ". This means that a binary search is used to bin the values, which scales much better for larger number of bins than the previous linear search. It also removes the requirement for the input array to be 1-dimensional." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For monotonically " }, { "__type": "Emphasis", "__tag": 4047, "children": [ { "__type": "Text", "__tag": 4046, "value": "increasing" } ] }, { "__type": "Text", "__tag": 4046, "value": " " }, { "__type": "ParamRef", "__tag": 4071, "name": "bins" }, { "__type": "Text", "__tag": 4046, "value": ", the following are equivalent " } ] }, { "__type": "Code", "__tag": 4050, "value": "np.digitize(x, bins, right=True)\nnp.searchsorted(bins, x, side='left')", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Note that as the order of the arguments are reversed, the side must be too. The " }, { "__type": "InlineRole", "__tag": 4003, "value": "searchsorted", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " call is marginally faster, as it does not do any monotonicity checks. Perhaps more importantly, it supports all dtypes." } ] } ], "title": [], "level": 0, "target": null }, "Warns": { "__type": "Section", "__tag": 4015, "children": [], "title": [], "level": 0, "target": null }, "Raises": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "ValueError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "bins" }, { "__type": "Text", "__tag": 4046, "value": " is not monotonic." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "TypeError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If the type of the input is complex." } ] } ] } ] } ], "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": "indices", "annotation": "ndarray of ints", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Output array of indices, of same shape as " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__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": "Return the indices of the bins to which each value in input array belongs." } ] } ], "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": "x", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input array to be binned. Prior to NumPy 1.10.0, this array had to be 1-dimensional, but can now have any shape." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "bins", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Array of bins. It has to be 1-dimensional and monotonic." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "right", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Indicating whether the intervals include the right or the left bin edge. Default behavior is (right==False) indicating that the interval does not include the right edge. The left bin end is open in this case, i.e., bins[i-1] <= x < bins[i] is the default behavior for monotonically increasing bins." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "========= ============= ============================\n`right` order of bins returned index `i` satisfies\n========= ============= ============================\n``False`` increasing ``bins[i-1] <= x < bins[i]``\n``True`` increasing ``bins[i-1] < x <= bins[i]``\n``False`` decreasing ``bins[i-1] > x >= bins[i]``\n``True`` decreasing ``bins[i-1] >= x > bins[i]``\n========= ============= ============================", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If values in " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": " are beyond the bounds of " }, { "__type": "ParamRef", "__tag": 4071, "name": "bins" }, { "__type": "Text", "__tag": 4046, "value": ", 0 or " }, { "__type": "InlineCode", "__tag": 4051, "value": "len(bins)" }, { "__type": "Text", "__tag": 4046, "value": " is returned as appropriate." } ] } ], "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": "/numpy/lib/_function_base_impl.py", "item_line": 5651, "item_type": "_ArrayFunctionDispatcher", "aliases": [ "numpy.digitize" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nx = np.array([0.2, 6.4, 3.0, 1.6])\nbins = np.array([0.0, 1.0, 2.5, 4.0, 10.0])\ninds = np.digitize(x, bins)\ninds\nfor n in range(x.size):\n print(bins[inds[n]-1], \"<=\", x[n], \"<\", bins[inds[n]])\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "x = np.array([1.2, 10.0, 12.4, 15.5, 20.])\nbins = np.array([0, 5, 10, 15, 20])\nnp.digitize(x,bins,right=True)\nnp.digitize(x,bins,right=False)\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "bincount", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "bincount" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "histogram", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "histogram" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "searchsorted", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "searchsorted" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "unique", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "unique" }, "kind": "module" }, "descriptions": [], "type": null } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "x", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "bins", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "right", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "digitize" }, "references": null, "qa": "numpy:digitize", "arbitrary": [], "local_refs": [ "bins", "indices", "right", "x" ] }