{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Further explanation of the " }, { "__type": "ParamRef", "__tag": 4071, "name": "fmt" }, { "__type": "Text", "__tag": 4046, "value": " parameter (" }, { "__type": "InlineCode", "__tag": 4051, "value": "%[flag]width[.precision]specifier" }, { "__type": "Text", "__tag": 4046, "value": "):" } ] }, { "__type": "DefList", "__tag": 4033, "children": [ { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "flags:" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "-" }, { "__type": "Text", "__tag": 4046, "value": "left justify" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "+" }, { "__type": "Text", "__tag": 4046, "value": "Forces to precede result with + or -." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "0" }, { "__type": "Text", "__tag": 4046, "value": "Left pad the number with zeros instead of space (see width)." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "width:" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Minimum number of characters to be printed. The value is not truncated if it has more characters." } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "precision:" } ] }, "dd": [ { "__type": "BulletList", "__tag": 4053, "ordered": false, "start": 1, "children": [ { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For integer specifiers (eg. " }, { "__type": "InlineCode", "__tag": 4051, "value": "d,i,o,x" }, { "__type": "Text", "__tag": 4046, "value": "), the minimum number of digits." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For " }, { "__type": "InlineCode", "__tag": 4051, "value": "e, E" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "f" }, { "__type": "Text", "__tag": 4046, "value": " specifiers, the number of digits to print after the decimal point." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For " }, { "__type": "InlineCode", "__tag": 4051, "value": "g" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "G" }, { "__type": "Text", "__tag": 4046, "value": ", the maximum number of significant digits." } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For " }, { "__type": "InlineCode", "__tag": 4051, "value": "s" }, { "__type": "Text", "__tag": 4046, "value": ", the maximum number of characters." } ] } ] } ] } ] }, { "__type": "DefListItem", "__tag": 4037, "dt": { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "specifiers:" } ] }, "dd": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "c" }, { "__type": "Text", "__tag": 4046, "value": "character" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "d" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineCode", "__tag": 4051, "value": "i" }, { "__type": "Text", "__tag": 4046, "value": "signed decimal integer" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "e" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineCode", "__tag": 4051, "value": "E" }, { "__type": "Text", "__tag": 4046, "value": "scientific notation with " }, { "__type": "InlineCode", "__tag": 4051, "value": "e" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineCode", "__tag": 4051, "value": "E" }, { "__type": "Text", "__tag": 4046, "value": "." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "f" }, { "__type": "Text", "__tag": 4046, "value": "decimal floating point" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "g,G" }, { "__type": "Text", "__tag": 4046, "value": "use the shorter of " }, { "__type": "InlineCode", "__tag": 4051, "value": "e,E" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "InlineCode", "__tag": 4051, "value": "f" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "o" }, { "__type": "Text", "__tag": 4046, "value": "signed octal" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "s" }, { "__type": "Text", "__tag": 4046, "value": "string of characters" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "u" }, { "__type": "Text", "__tag": 4046, "value": "unsigned decimal integer" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "InlineCode", "__tag": 4051, "value": "x,X" }, { "__type": "Text", "__tag": 4046, "value": "unsigned hexadecimal integer" } ] } ] } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "This explanation of " }, { "__type": "InlineCode", "__tag": 4051, "value": "fmt" }, { "__type": "Text", "__tag": 4046, "value": " is not complete, for an exhaustive specification see " }, { "__type": "FootnoteReference", "__tag": 4066, "label": "1" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ], "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": [], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Save an array to a text file." } ] } ], "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": "fname", "annotation": "filename, file handle or pathlib.Path", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If the filename ends in " }, { "__type": "InlineCode", "__tag": 4051, "value": ".gz" }, { "__type": "Text", "__tag": 4046, "value": ", the file is automatically saved in compressed gzip format. " }, { "__type": "InlineRole", "__tag": 4003, "value": "loadtxt", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " understands gzipped files transparently." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "X", "annotation": "1D or 2D array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Data to be saved to a text file." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "fmt", "annotation": "str or sequence of strs, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "A single format (%10.5f), a sequence of formats, or a multi-format string, e.g. 'Iteration %d -- %10.5f', in which case " }, { "__type": "ParamRef", "__tag": 4071, "name": "delimiter" }, { "__type": "Text", "__tag": 4046, "value": " is ignored. For complex " }, { "__type": "ParamRef", "__tag": 4071, "name": "X" }, { "__type": "Text", "__tag": 4046, "value": ", the legal options for " }, { "__type": "ParamRef", "__tag": 4071, "name": "fmt" }, { "__type": "Text", "__tag": 4046, "value": " 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": "a single specifier, " }, { "__type": "InlineCode", "__tag": 4051, "value": "fmt='%.4e'" }, { "__type": "Text", "__tag": 4046, "value": ", resulting in numbers formatted like " }, { "__type": "InlineCode", "__tag": 4051, "value": "' (%s+%sj)' % (fmt, fmt)" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "a full string specifying every real and imaginary part, e.g. " }, { "__type": "InlineCode", "__tag": 4051, "value": "' %.4e %+.4ej %.4e %+.4ej %.4e %+.4ej'" }, { "__type": "Text", "__tag": 4046, "value": " for 3 columns" } ] } ] }, { "__type": "ListItem", "__tag": 4054, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "a list of specifiers, one per column - in this case, the real and imaginary part must have separate specifiers, e.g. " }, { "__type": "InlineCode", "__tag": 4051, "value": "['%.3e + %.3ej', '(%.15e%+.15ej)']" }, { "__type": "Text", "__tag": 4046, "value": " for 2 columns" } ] } ] } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "delimiter", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "String or character separating columns." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "newline", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "String or character separating lines." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "header", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "String that will be written at the beginning of the file." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "footer", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "String that will be written at the end of the file." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "comments", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "String that will be prepended to the " }, { "__type": "InlineCode", "__tag": 4051, "value": "header" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "InlineCode", "__tag": 4051, "value": "footer" }, { "__type": "Text", "__tag": 4046, "value": " strings, to mark them as comments. Default: '# ', as expected by e.g. " }, { "__type": "InlineCode", "__tag": 4051, "value": "numpy.loadtxt" }, { "__type": "Text", "__tag": 4046, "value": "." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "encoding", "annotation": "{None, str}, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Encoding used to encode the outputfile. Does not apply to output streams. If the encoding is something other than 'bytes' or 'latin1' you will not be able to load the file in NumPy versions < 1.14. Default is 'latin1'." } ] } ] } ] } ], "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": "/dev/numpy/build-install/usr/lib/python3.14/site-packages/numpy/lib/_npyio_impl.py", "item_line": 1401, "item_type": "_ArrayFunctionDispatcher", "aliases": [ "numpy.savetxt" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Code", "__tag": 4050, "value": "import numpy as np\nx = y = z = np.arange(0.0,5.0,1.0)\nnp.savetxt('test.out', x, delimiter=',') # X is an array\nnp.savetxt('test.out', (x,y,z)) # x,y,z equal sized 1D arrays\nnp.savetxt('test.out', x, fmt='%1.4e') # use exponential notation\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "save", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:savetxt" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Save an array to a binary file in NumPy " }, { "__type": "InlineCode", "__tag": 4051, "value": ".npy" }, { "__type": "Text", "__tag": 4046, "value": " format" } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "savez", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "savez" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Save several arrays into an uncompressed " }, { "__type": "InlineCode", "__tag": 4051, "value": ".npz" }, { "__type": "Text", "__tag": 4046, "value": " archive" } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "savez_compressed", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "savez_compressed" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Save several arrays into a compressed " }, { "__type": "InlineCode", "__tag": 4051, "value": ".npz" }, { "__type": "Text", "__tag": 4046, "value": " archive" } ] } ], "type": null } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "fname", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__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": "fmt", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "%.18e" }, { "__type": "SigParam", "__tag": 4030, "name": "delimiter", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": " " }, { "__type": "SigParam", "__tag": 4030, "name": "newline", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "\n" }, { "__type": "SigParam", "__tag": 4030, "name": "header", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "" }, { "__type": "SigParam", "__tag": 4030, "name": "footer", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "" }, { "__type": "SigParam", "__tag": 4030, "name": "comments", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "# " }, { "__type": "SigParam", "__tag": 4030, "name": "encoding", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "savetxt" }, "references": [ ".. [1] `Format Specification Mini-Language", " `_,", " Python Documentation." ], "qa": "numpy:savetxt", "arbitrary": [], "local_refs": [ "X", "comments", "delimiter", "encoding", "fmt", "fname", "footer", "header", "newline" ] }