{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Binary search is used to find the required insertion points." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "As of NumPy 1.4.0 " }, { "__type": "CrossRef", "__tag": 4002, "value": "searchsorted", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:searchsorted" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " works with real/complex arrays containing " }, { "__type": "InlineRole", "__tag": 4003, "value": "nan", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " values. The enhanced sort order is documented in " }, { "__type": "CrossRef", "__tag": 4002, "value": "sort", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:searchsorted" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This function uses the same algorithm as the builtin python " }, { "__type": "CrossRef", "__tag": 4002, "value": "bisect.bisect_left", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "_bisect", "version": "*", "kind": "api", "path": "_bisect:bisect_left" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " (" }, { "__type": "InlineCode", "__tag": 4051, "value": "side='left'" }, { "__type": "Text", "__tag": 4046, "value": ") and " }, { "__type": "CrossRef", "__tag": 4002, "value": "bisect.bisect_right", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "_bisect", "version": "*", "kind": "api", "path": "_bisect:bisect_right" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " (" }, { "__type": "InlineCode", "__tag": 4051, "value": "side='right'" }, { "__type": "Text", "__tag": 4046, "value": ") functions, which is also vectorized in the " }, { "__type": "ParamRef", "__tag": 4071, "name": "v" }, { "__type": "Text", "__tag": 4046, "value": " argument." } ] } ], "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": "indices", "annotation": "int or array of ints", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Array of insertion points with the same shape as " }, { "__type": "ParamRef", "__tag": 4071, "name": "v" }, { "__type": "Text", "__tag": 4046, "value": ", or an integer if " }, { "__type": "ParamRef", "__tag": 4071, "name": "v" }, { "__type": "Text", "__tag": 4046, "value": " is a scalar." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Find indices where elements should be inserted to maintain order." } ] } ], "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": "1-D array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input array. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "sorter" }, { "__type": "Text", "__tag": 4046, "value": " is None, then it must be sorted in ascending order, otherwise " }, { "__type": "ParamRef", "__tag": 4071, "name": "sorter" }, { "__type": "Text", "__tag": 4046, "value": " must be an array of indices that sort it." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "v", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Values to insert into " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "side", "annotation": "{'left', 'right'}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If 'left', the index of the first suitable location found is given. If 'right', return the last such index. If there is no suitable index, return either 0 or N (where N is the length of " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": ")." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "sorter", "annotation": "1-D array_like, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Optional array of integer indices that sort array a into ascending order. They are typically the result of argsort." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Find the indices into a sorted array " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " such that, if the corresponding elements in " }, { "__type": "ParamRef", "__tag": 4071, "name": "v" }, { "__type": "Text", "__tag": 4046, "value": " were inserted before the indices, the order of " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " would be preserved." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Assuming that " }, { "__type": "ParamRef", "__tag": 4071, "name": "a" }, { "__type": "Text", "__tag": 4046, "value": " is sorted:" } ] }, { "__type": "Code", "__tag": 4050, "value": "====== ============================\n`side` returned index `i` satisfies\n====== ============================\nleft ``a[i-1] < v <= a[i]``\nright ``a[i-1] <= v < a[i]``\n====== ============================", "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": "/numpy/_core/fromnumeric.py", "item_line": 1421, "item_type": "_ArrayFunctionDispatcher", "aliases": [ "numpy.searchsorted" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.searchsorted([11,12,13,14,15], 13)\nnp.searchsorted([11,12,13,14,15], 13, side='right')\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "np.searchsorted([11,12,13,14,15], [-10, 20, 12, 13])\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\nWhen `sorter` is used, the returned indices refer to the sorted\narray of `a` and not `a` itself:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "a = np.array([40, 10, 20, 30])\nsorter = np.argsort(a)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "sorter\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "result = np.searchsorted(a, 25, sorter=sorter)\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "result\na[sorter[result]]\n", "execution_status": "failure" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__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": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Produce histogram from 1-D data." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "sort", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:searchsorted" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Return a sorted copy of an array." } ] } ], "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": "v", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "side", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "left" }, { "__type": "SigParam", "__tag": 4030, "name": "sorter", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "searchsorted" }, "references": null, "qa": "numpy:searchsorted", "arbitrary": [], "local_refs": [ "a", "indices", "side", "sorter", "v" ] }