{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [], "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": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "astype", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "argsort", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "copy", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "count", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "decode", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "dump", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "dumps", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "encode", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "endswith", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "expandtabs", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "fill", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "find", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "flatten", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "getfield", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "index", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "isalnum", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "isalpha", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "isdecimal", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "isdigit", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "islower", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "isnumeric", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "isspace", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "istitle", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "isupper", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "item", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "join", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "ljust", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "lower", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "lstrip", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "nonzero", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "put", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "ravel", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "repeat", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "replace", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "reshape", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "resize", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "rfind", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "rindex", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "rjust", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "rsplit", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "rstrip", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "searchsorted", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "setfield", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "setflags", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "sort", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "split", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "splitlines", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "squeeze", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "startswith", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "strip", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "swapaxes", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "swapcase", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "take", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "title", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "tofile", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "tolist", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "translate", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "transpose", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "upper", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "view", "annotation": "", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "zfill", "annotation": "", "desc": [] } ] } ], "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": "Provides a convenient view on arrays of string and unicode values." } ] } ], "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": "shape", "annotation": "tuple", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Shape of the array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "itemsize", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Length of each array element, in number of characters. Default is 1." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "unicode", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Are the array elements of type unicode (True) or string (False). Default is False." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "buffer", "annotation": "object exposing the buffer interface or str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Memory address of the start of the array data. Default is None, in which case a new array is created." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "offset", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Fixed stride displacement from the beginning of an axis? Default is 0. Needs to be >=0." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "strides", "annotation": "array_like of ints, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Strides for the array (see " }, { "__type": "InlineRole", "__tag": 4003, "value": "~numpy.ndarray.strides", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " for full description). Default is None." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "order", "annotation": "{'C', 'F'}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The order in which the array data is stored in memory: 'C' -> \"row major\" order (the default), 'F' -> \"column major\" (Fortran) order." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Admonition", "__tag": 4056, "kind": "note", "base_type": "note", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "note " } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The " }, { "__type": "CrossRef", "__tag": 4002, "value": "chararray", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.char:chararray" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " class exists for backwards compatibility with Numarray, it is not recommended for new development. Starting from numpy 1.4, if one needs arrays of strings, it is recommended to use arrays of " }, { "__type": "CrossRef", "__tag": 4002, "value": "dtype", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:dtype" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " " }, { "__type": "CrossRef", "__tag": 4002, "value": "object_", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:object_" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "CrossRef", "__tag": 4002, "value": "bytes_", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:bytes_" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "CrossRef", "__tag": 4002, "value": "str_", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:str_" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", and use the free functions in the " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.char", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.char" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " module for fast vectorized string operations." } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Versus a NumPy array of dtype " }, { "__type": "CrossRef", "__tag": 4002, "value": "bytes_", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:bytes_" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "CrossRef", "__tag": 4002, "value": "str_", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:str_" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", this class adds the following functionality:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": true, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "values automatically have whitespace removed from the end when indexed" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "comparison operators automatically remove whitespace from the end when comparing values" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "vectorized string operations are provided as methods (e.g. " }, { "__type": "InlineRole", "__tag": 4003, "value": ".endswith", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ") and infix operators (e.g. " }, { "__type": "InlineCode", "__tag": 4051, "value": "\"+\", \"*\", \"%\"" }, { "__type": "Text", "__tag": 4046, "value": ")" } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "chararrays should be created using " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.char.array", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.char:array" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.char.asarray", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.char:asarray" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", rather than this constructor directly." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This constructor creates the array, using " }, { "__type": "ParamRef", "__tag": 4071, "name": "buffer" }, { "__type": "Text", "__tag": 4046, "value": " (with " }, { "__type": "ParamRef", "__tag": 4071, "name": "offset" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "strides" }, { "__type": "Text", "__tag": 4046, "value": ") if it is not " }, { "__type": "InlineCode", "__tag": 4051, "value": "None" }, { "__type": "Text", "__tag": 4046, "value": ". If " }, { "__type": "ParamRef", "__tag": 4071, "name": "buffer" }, { "__type": "Text", "__tag": 4046, "value": " is " }, { "__type": "InlineCode", "__tag": 4051, "value": "None" }, { "__type": "Text", "__tag": 4046, "value": ", then constructs a new array with " }, { "__type": "ParamRef", "__tag": 4071, "name": "strides" }, { "__type": "Text", "__tag": 4046, "value": " in \"C order\", unless both " }, { "__type": "InlineCode", "__tag": 4051, "value": "len(shape) >= 2" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "order='F'" }, { "__type": "Text", "__tag": 4046, "value": ", in which case " }, { "__type": "ParamRef", "__tag": 4071, "name": "strides" }, { "__type": "Text", "__tag": 4046, "value": " is in \"Fortran order\"." } ] } ], "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/numpy/char/__init__.py", "item_line": null, "item_type": "class", "aliases": [ "numpy.char.chararray" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\ncharar = np.char.chararray((3, 3))\ncharar[:] = 'a'\ncharar\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "charar = np.char.chararray(charar.shape, itemsize=5)\ncharar[:] = 'abc'\ncharar\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [], "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": "itemsize", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "1" }, { "__type": "SigParam", "__tag": 4030, "name": "unicode", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "False" }, { "__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": "chararray" }, "references": null, "qa": "numpy.char:chararray", "arbitrary": [], "local_refs": [ "argsort", "astype", "buffer", "copy", "count", "decode", "dump", "dumps", "encode", "endswith", "expandtabs", "fill", "find", "flatten", "getfield", "index", "isalnum", "isalpha", "isdecimal", "isdigit", "islower", "isnumeric", "isspace", "istitle", "isupper", "item", "itemsize", "join", "ljust", "lower", "lstrip", "nonzero", "offset", "order", "put", "ravel", "repeat", "replace", "reshape", "resize", "rfind", "rindex", "rjust", "rsplit", "rstrip", "searchsorted", "setfield", "setflags", "shape", "sort", "split", "splitlines", "squeeze", "startswith", "strides", "strip", "swapaxes", "swapcase", "take", "title", "tofile", "tolist", "translate", "transpose", "unicode", "upper", "view", "zfill" ] }