Understanding the "equality_check" parameter in perfplot

[ghost]

A question regarding the "equality_check" criteria. Could someone please explain to me its significance? I don't quite understand what it's exactly used for. In many instances, without having it set to "None", I would get this error: "AssertionError: Equality check failure". Thus I generally tend to keep it as "equality_check=None".

I'm not quite sure what it's doing behind the scenes, so could someone please give it some context and explain it in brief? #

[nschloe]

perfplot is often used to compare pieces of code "that do the same". To make sure they really do, you typically return something from each of the kernels, and those results are then checked for equality.

In some cases, you're not interested in the result, so you just set the equality_check to None. (Or don't return anything from any function.)