{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If a formatter is specified for a certain type, the " }, { "__type": "ParamRef", "__tag": 4071, "name": "precision" }, { "__type": "Text", "__tag": 4046, "value": " keyword is ignored for that type." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This is a very flexible function; " }, { "__type": "InlineRole", "__tag": 4003, "value": "array_repr", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "CrossRef", "__tag": 4002, "value": "array_str", "reference": { "__type": "RefInfo", "__tag": 4000, "module": null, "version": null, "kind": "local", "path": "array_str" }, "kind": "local" }, { "__type": "Text", "__tag": 4046, "value": " are using " }, { "__type": "CrossRef", "__tag": 4002, "value": "array2string", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:array2string" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " internally so keywords with the same name should work identically in all three functions." } ] } ], "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": "TypeError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "if a callable in " }, { "__type": "ParamRef", "__tag": 4071, "name": "formatter" }, { "__type": "Text", "__tag": 4046, "value": " does not return a string." } ] } ] } ] } ], "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": "array_str", "annotation": "str", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "String representation of the array." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Return a string representation of an array." } ] } ], "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": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input array." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "max_line_width", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Inserts newlines if text is longer than " }, { "__type": "ParamRef", "__tag": 4071, "name": "max_line_width" }, { "__type": "Text", "__tag": 4046, "value": ". Defaults to " }, { "__type": "InlineCode", "__tag": 4051, "value": "numpy.get_printoptions()['linewidth']" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "precision", "annotation": "int or None, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Floating point precision. Defaults to " }, { "__type": "InlineCode", "__tag": 4051, "value": "numpy.get_printoptions()['precision']" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "suppress_small", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Represent numbers \"very close\" to zero as zero; default is False. Very close is defined by precision: if the precision is 8, e.g., numbers smaller (in absolute value) than 5e-9 are represented as zero. Defaults to " }, { "__type": "InlineCode", "__tag": 4051, "value": "numpy.get_printoptions()['suppress']" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "separator", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Inserted between elements." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "prefix", "annotation": "str, optional", "desc": [] }, { "__type": "DocParam", "__tag": 4016, "name": "suffix", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The length of the prefix and suffix strings are used to respectively align and wrap the output. An array is typically printed as " } ] }, { "__type": "Code", "__tag": 4050, "value": "prefix + array2string(a) + suffix", "execution_status": null }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The output is left-padded by the length of the prefix string, and wrapping is forced at the column " }, { "__type": "InlineCode", "__tag": 4051, "value": "max_line_width - len(suffix)" }, { "__type": "Text", "__tag": 4046, "value": ". It should be noted that the content of prefix and suffix strings are not included in the output." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "formatter", "annotation": "dict of callables, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If not None, the keys should indicate the type(s) that the respective formatting function applies to. Callables should return a string. Types that are not specified (by their corresponding keys) are handled by the default formatters. Individual types for which a formatter can be set are:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'bool'" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'int'" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'timedelta'a " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.timedelta64", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:timedelta64" }, "kind": "module" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'datetime'a " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.datetime64", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:datetime64" }, "kind": "module" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'float'" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'longfloat'128-bit floats" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'complexfloat'" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'longcomplexfloat'composed of two 128-bit floats" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'void'type " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.void", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:void" }, "kind": "module" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'numpystr'types " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.bytes_", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:bytes_" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "CrossRef", "__tag": 4002, "value": "numpy.str_", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:str_" }, "kind": "module" } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Other keys that can be used to set a group of types at once are:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'all'sets all types" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'int_kind'sets 'int'" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'float_kind'sets 'float' and 'longfloat'" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'complex_kind'sets 'complexfloat' and 'longcomplexfloat'" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'str_kind'sets 'numpystr'" } ] } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "threshold", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Total number of array elements which trigger summarization rather than full repr. Defaults to " }, { "__type": "InlineCode", "__tag": 4051, "value": "numpy.get_printoptions()['threshold']" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "edgeitems", "annotation": "int, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Number of array items in summary at beginning and end of each dimension. Defaults to " }, { "__type": "InlineCode", "__tag": 4051, "value": "numpy.get_printoptions()['edgeitems']" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "sign", "annotation": "string, either '-', '+', or ' ', optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Controls printing of the sign of floating-point types. If '+', always print the sign of positive values. If ' ', always prints a space (whitespace character) in the sign position of positive values. If '-', omit the sign character of positive values. Defaults to " }, { "__type": "InlineCode", "__tag": 4051, "value": "numpy.get_printoptions()['sign']" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionchanged", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionchanged 2.0" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The sign parameter can now be an integer type, previously types were floating-point types." } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "floatmode", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Controls the interpretation of the " }, { "__type": "ParamRef", "__tag": 4071, "name": "precision" }, { "__type": "Text", "__tag": 4046, "value": " option for floating-point types. Defaults to " }, { "__type": "InlineCode", "__tag": 4051, "value": "numpy.get_printoptions()['floatmode']" }, { "__type": "Text", "__tag": 4046, "value": ". Can take the following values:" } ] }, { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'fixed': Always print exactly " }, { "__type": "ParamRef", "__tag": 4071, "name": "precision" }, { "__type": "Text", "__tag": 4046, "value": " fractional digits, even if this would print more or fewer digits than necessary to specify the value uniquely." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'unique': Print the minimum number of fractional digits necessary to represent each value uniquely. Different elements may have a different number of digits. The value of the " }, { "__type": "ParamRef", "__tag": 4071, "name": "precision" }, { "__type": "Text", "__tag": 4046, "value": " option is ignored." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'maxprec': Print at most " }, { "__type": "ParamRef", "__tag": 4071, "name": "precision" }, { "__type": "Text", "__tag": 4046, "value": " fractional digits, but if an element can be uniquely represented with fewer digits only print it with that many." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "'maxprec_equal': Print at most " }, { "__type": "ParamRef", "__tag": 4071, "name": "precision" }, { "__type": "Text", "__tag": 4046, "value": " fractional digits, but if every element in the array can be uniquely represented with an equal number of fewer digits, use that many digits for all elements." } ] } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "legacy", "annotation": "string or `False`, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If set to the string " }, { "__type": "InlineCode", "__tag": 4051, "value": "'1.13'" }, { "__type": "Text", "__tag": 4046, "value": " enables 1.13 legacy printing mode. This approximates numpy 1.13 print output by including a space in the sign position of floats and different behavior for 0d arrays. If set to " }, { "__type": "InlineRole", "__tag": 4003, "value": "False", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": ", disables legacy mode. Unrecognized strings will be ignored with a warning for forward compatibility." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [], "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/arrayprint.py", "item_line": 635, "item_type": "_ArrayFunctionDispatcher", "aliases": [ "numpy.array2string" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nx = np.array([1e-16,1,2,3])\nnp.array2string(x, precision=2, separator=',',\n suppress_small=True)\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "x = np.arange(3.)\nnp.array2string(x, formatter={'float_kind':lambda x: \"%.2f\" % x})\n", "execution_status": "success" }, { "__type": "Text", "__tag": 4046, "value": "\n" }, { "__type": "Code", "__tag": 4050, "value": "x = np.arange(3)\nnp.array2string(x, formatter={'int':lambda x: hex(x)})\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "array_repr", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "array_repr" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "array_str", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "array_str" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "get_printoptions", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "get_printoptions" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "set_printoptions", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "set_printoptions" }, "kind": "module" }, "descriptions": [], "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": "max_line_width", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "precision", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "suppress_small", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "separator", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": " " }, { "__type": "SigParam", "__tag": 4030, "name": "prefix", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "" }, { "__type": "SigParam", "__tag": 4030, "name": "formatter", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "threshold", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "edgeitems", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "sign", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "floatmode", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "suffix", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "" }, { "__type": "SigParam", "__tag": 4030, "name": "legacy", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "array2string" }, "references": null, "qa": "numpy:array2string", "arbitrary": [], "local_refs": [ "a", "array_str", "edgeitems", "floatmode", "formatter", "legacy", "max_line_width", "precision", "prefix", "separator", "sign", "suffix", "suppress_small", "threshold" ] }