{ "__type": "IngestedDoc", "__tag": 4010, "_content": { "Notes": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "When one of " }, { "__type": "ParamRef", "__tag": 4071, "name": "actual" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "desired" }, { "__type": "Text", "__tag": 4046, "value": " is a scalar and the other is array_like, the function checks that each element of the array_like is equal to the scalar. Note that empty arrays are therefore considered equal to scalars. This behaviour can be disabled by setting " }, { "__type": "InlineCode", "__tag": 4051, "value": "strict==True" }, { "__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": [ { "__type": "Parameters", "__tag": 4026, "children": [ { "__type": "DocParam", "__tag": 4016, "name": "", "annotation": "AssertionError", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If actual and desired objects are not equal." } ] } ] } ] } ], "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": "Raises an AssertionError if two array_like objects are not equal." } ] } ], "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": "actual", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The actual object to check." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "desired", "annotation": "array_like", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The desired, expected object." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "err_msg", "annotation": "str, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The error message to be printed in case of failure." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "verbose", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, the conflicting values are appended to the error message." } ] } ] }, { "__type": "DocParam", "__tag": 4016, "name": "strict", "annotation": "bool, optional", "desc": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "If True, raise an AssertionError when either the shape or the data type of the array_like objects does not match. The special handling for scalars mentioned in the Notes section is disabled." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "versionadded", "base_type": "neutral", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "versionadded 1.24.0" } ] } ] } ] } ] } ], "title": [], "level": 0, "target": null }, "Extended Summary": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Given two array_like objects, check that the shape is equal and all elements of these objects are equal (but see the Notes for the special handling of a scalar). An exception is raised at shape mismatch or conflicting values. In contrast to the standard usage in numpy, NaNs are compared like numbers, no assertion is raised if both objects have NaNs in the same positions." } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "The usual caution for verifying equality with floating point numbers is advised." } ] }, { "__type": "Admonition", "__tag": 4056, "kind": "note", "base_type": "note", "children": [ { "__type": "AdmonitionTitle", "__tag": 4055, "children": [ { "__type": "Text", "__tag": 4046, "value": "note When either `actual` or `desired` is already an instance of" } ] }, { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "CrossRef", "__tag": 4002, "value": "numpy.ndarray", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy:ndarray" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " and " }, { "__type": "ParamRef", "__tag": 4071, "name": "desired" }, { "__type": "Text", "__tag": 4046, "value": " is not a " }, { "__type": "InlineCode", "__tag": 4051, "value": "dict" }, { "__type": "Text", "__tag": 4046, "value": ", the behavior of " }, { "__type": "InlineCode", "__tag": 4051, "value": "assert_equal(actual, desired)" }, { "__type": "Text", "__tag": 4046, "value": " is identical to the behavior of this function. Otherwise, this function performs " }, { "__type": "InlineRole", "__tag": 4003, "value": "np.asanyarray", "domain": null, "role": null, "inventory": null }, { "__type": "Text", "__tag": 4046, "value": " on the inputs before comparison, whereas " }, { "__type": "CrossRef", "__tag": 4002, "value": "assert_equal", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.testing._private.utils:assert_equal" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " defines special comparison rules for common Python types. For example, only " }, { "__type": "CrossRef", "__tag": 4002, "value": "assert_equal", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.testing._private.utils:assert_equal" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " can be used to compare nested Python lists. In new code, consider using only " }, { "__type": "CrossRef", "__tag": 4002, "value": "assert_equal", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.testing._private.utils:assert_equal" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": ", explicitly converting either " }, { "__type": "ParamRef", "__tag": 4071, "name": "actual" }, { "__type": "Text", "__tag": 4046, "value": " or " }, { "__type": "ParamRef", "__tag": 4071, "name": "desired" }, { "__type": "Text", "__tag": 4046, "value": " to arrays if the behavior of " }, { "__type": "CrossRef", "__tag": 4002, "value": "assert_array_equal", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.testing._private.utils:assert_array_equal" }, "kind": "module" }, { "__type": "Text", "__tag": 4046, "value": " is desired." } ] } ] } ], "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/testing/_private/utils.py", "item_line": 994, "item_type": "function", "aliases": [ "numpy.testing.assert_array_equal" ], "example_section_data": { "__type": "Section", "__tag": 4015, "children": [ { "__type": "Text", "__tag": 4046, "value": "The first assert does not raise an exception:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.testing.assert_array_equal([1.0,2.33333,np.nan],\n [np.exp(0),2.33333, np.nan])\n", "execution_status": "none" }, { "__type": "Text", "__tag": 4046, "value": "\nAssert fails with numerical imprecision with floats:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.testing.assert_array_equal([1.0,np.pi,np.nan],\n [1, np.sqrt(np.pi)**2, np.nan])\n", "execution_status": "none" }, { "__type": "Text", "__tag": 4046, "value": "\nUse `assert_allclose` or one of the nulp (number of floating point values)\nfunctions for these cases instead:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.testing.assert_allclose([1.0,np.pi,np.nan],\n [1, np.sqrt(np.pi)**2, np.nan],\n rtol=1e-10, atol=0)\n", "execution_status": "none" }, { "__type": "Text", "__tag": 4046, "value": "\nAs mentioned in the Notes section, `assert_array_equal` has special\nhandling for scalars. Here the test checks that each value in `x` is 3:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "x = np.full((2, 5), fill_value=3)\nnp.testing.assert_array_equal(x, 3)\n", "execution_status": "none" }, { "__type": "Text", "__tag": 4046, "value": "\nUse `strict` to raise an AssertionError when comparing a scalar with an\narray:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "np.testing.assert_array_equal(x, 3, strict=True)\n", "execution_status": "none" }, { "__type": "Text", "__tag": 4046, "value": "\nThe `strict` parameter also ensures that the array data types match:\n\n" }, { "__type": "Code", "__tag": 4050, "value": "x = np.array([2, 2, 2])\ny = np.array([2., 2., 2.], dtype=np.float32)\nnp.testing.assert_array_equal(x, y, strict=True)\n", "execution_status": "none" } ], "title": [], "level": 0, "target": null }, "see_also": [ { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "assert_allclose", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.testing._private.utils:assert_allclose" }, "kind": "module" }, "descriptions": [ { "__type": "Paragraph", "__tag": 4045, "children": [ { "__type": "Text", "__tag": 4046, "value": "Compare two array_like objects for equality with desired relative and/or absolute precision." } ] } ], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "assert_array_almost_equal_nulp", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.testing._private.utils:assert_array_almost_equal_nulp" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "assert_array_max_ulp", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.testing._private.utils:assert_array_max_ulp" }, "kind": "module" }, "descriptions": [], "type": null }, { "__type": "SeeAlsoItem", "__tag": 4028, "name": { "__type": "CrossRef", "__tag": 4002, "value": "assert_equal", "reference": { "__type": "LocalRef", "__tag": 4022, "kind": "module", "path": "numpy.testing._private.utils:assert_equal" }, "kind": "module" }, "descriptions": [], "type": null } ], "signature": { "__type": "SignatureNode", "__tag": 4029, "kind": "function", "parameters": [ { "__type": "SigParam", "__tag": 4030, "name": "actual", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "desired", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": { "__type": "Empty", "__tag": 4031 } }, { "__type": "SigParam", "__tag": 4030, "name": "err_msg", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "" }, { "__type": "SigParam", "__tag": 4030, "name": "verbose", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "POSITIONAL_OR_KEYWORD", "default": "True" }, { "__type": "SigParam", "__tag": 4030, "name": "strict", "annotation": { "__type": "Empty", "__tag": 4031 }, "kind": "KEYWORD_ONLY", "default": "False" } ], "return_annotation": { "__type": "Empty", "__tag": 4031 }, "target_name": "assert_array_equal" }, "references": null, "qa": "numpy.testing._private.utils:assert_array_equal", "arbitrary": [], "local_refs": [ "actual", "desired", "err_msg", "strict", "verbose" ] }