{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "NumPy uses the IEEE Standard for Binary Floating-Point for Arithmetic (IEEE 754). This means that Not a Number is not equivalent to infinity." } ] } ], "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": "out", "annotation": "ndarray", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": ", with the non-finite values replaced. If " }, { "__type": "ParamRef", "__tag": 4071, "name": "copy" }, { "__type": "Text", "__tag": 4046, "value": " is False, this may be " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": " itself." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Replace NaN with zero and infinity with large finite numbers (default behaviour) or with the numbers defined by the user using the " }, { "__type": "ParamRef", "__tag": 4071, "name": "nan" }, { "__type": "Text", "__tag": 4046, "value": ", " }, { "__type": "ParamRef", "__tag": 4071, "name": "posinf" }, { "__type": "Text", "__tag": 4046, "value": " and/or " }, { "__type": "ParamRef", "__tag": 4071, "name": "neginf" }, { "__type": "Text", "__tag": 4046, "value": " keywords." } ] } ], "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": "scalar or array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Input data." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "copy", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Whether to create a copy of " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": " (True) or to replace values in-place (False). The in-place operation only occurs if casting to an array does not require a copy. Default is True." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "nan", "annotation": "int, float, or bool or array_like of int, float, or bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Values to be used to fill NaN values. If no values are passed then NaN values will be replaced with 0.0." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "posinf", "annotation": "int, float, or bool or array_like of int, float, or bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Values to be used to fill positive infinity values. If no values are passed then positive infinity values will be replaced with a very large number." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "neginf", "annotation": "int, float, or bool or array_like of int, float, or bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Values to be used to fill negative infinity values. If no values are passed then negative infinity values will be replaced with a very small (or negative) number." } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": " is inexact, NaN is replaced by zero or by the user defined value in " }, { "__type": "ParamRef", "__tag": 4071, "name": "nan" }, { "__type": "Text", "__tag": 4046, "value": " keyword, infinity is replaced by the largest finite floating point values representable by " }, { "__type": "InlineCode", "__tag": 4051, "value": "x.dtype" }, { "__type": "Text", "__tag": 4046, "value": " or by the user defined value in " }, { "__type": "ParamRef", "__tag": 4071, "name": "posinf" }, { "__type": "Text", "__tag": 4046, "value": " keyword and -infinity is replaced by the most negative finite floating point values representable by " }, { "__type": "InlineCode", "__tag": 4051, "value": "x.dtype" }, { "__type": "Text", "__tag": 4046, "value": " or by the user defined value in " }, { "__type": "ParamRef", "__tag": 4071, "name": "neginf" }, { "__type": "Text", "__tag": 4046, "value": " keyword." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "For complex dtypes, the above is applied to each of the real and imaginary components of " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": " separately." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If " }, { "__type": "ParamRef", "__tag": 4071, "name": "x" }, { "__type": "Text", "__tag": 4046, "value": " is not inexact, then no replacements are made." } ] } ], "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/_type_check_impl.py", "item_line": 373, "item_type": "_ArrayFunctionDispatcher", "aliases": [ "numpy.nan_to_num" ], "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.nan_to_num(np.inf)\nnp.nan_to_num(-np.inf)\nnp.nan_to_num(np.nan)\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "x = np.array([np.inf, -np.inf, np.nan, -128, 128])\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.nan_to_num(x)\nnp.nan_to_num(x, nan=-9999, posinf=33333333, neginf=33333333)\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "nan = np.array([11, 12, -9999, 13, 14])\nposinf = np.array([33333333, 11, 12, 13, 14])\nneginf = np.array([11, 33333333, 12, 13, 14])\n", "execution_status": "success" }, { "__type": "Code", "__tag": 4050, "value": "np.nan_to_num(x, nan=nan, posinf=posinf, neginf=neginf)\ny = np.array([complex(np.inf, np.nan), np.nan, complex(np.nan, np.inf)])\nnp.nan_to_num(y)\n", "execution_status": "failure" }, { "__type": "Code", "__tag": 4050, "value": "np.nan_to_num(y, nan=111111, posinf=222222)\nnan = np.array([11, 12, 13])\nposinf = np.array([21, 22, 23])\nneginf = np.array([31, 32, 33])\nnp.nan_to_num(y, nan=nan, posinf=posinf, neginf=neginf)\n", "execution_status": "success" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "isfinite", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "isfinite" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Shows which elements are finite (not NaN, not infinity)" } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "isinf", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "isinf" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Shows which elements are positive or negative infinity." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "isnan", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "isnan" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Shows which elements are Not a Number (NaN)." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "isneginf", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "isneginf" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Shows which elements are negative infinity." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "isposinf", "reference": { "__type": "RefInfo", "__tag": 4000, "module": "current-module", "version": "current-version", "kind": "to-resolve", "path": "isposinf" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Shows which elements are positive infinity." } ] } ], "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": "copy", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "nan", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "0.0" }, { "__type": "SigParam", "__tag": 4030, "name": "posinf", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" }, { "__type": "SigParam", "__tag": 4030, "name": "neginf", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "None" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "nan_to_num" }, "references": null, "qa": "numpy:nan_to_num", "arbitrary": [], "local_refs": [ "copy", "nan", "neginf", "out", "posinf", "x" ] }