The analyzer has detected a suspicious code fragment where floating-point numbers are compared using operator '==' or '!='. Such code may contain a bug.
Let's discuss an example of correct code first (which will, however, trigger the warning anyway):
double a = 0.5;
if (a == 0.5) //ok
++x;
This comparison is correct. Before executing it, the 'a' variable is explicitly initialized to value '0.5', and it is this value the comparison is done over. The expression will evaluate to 'true'.
So, strict comparisons are permitted in certain cases - but not all the time. Here's an example of incorrect code:
double b = Math.Sin(Math.PI / 6.0);
if (b == 0.5) //err
++x;
The 'b == 0.5' condition proves false because the 'Math.Sin(Math.PI / 6.0)' expression evaluates to 0.49999999999999994. This number is very close but still not equal to '0.5'.
One way to fix this is to compare the difference of the two values against some reference value (i.e. amount of error, which in this case is expressed by variable 'epsilon'):
double b = Math.Sin(Math.PI / 6.0);
if (Math.Abs(b - 0.5) < epsilon) //ok
++x;
You should estimate the error amount appropriately, depending on what values are being compared.
The analyzer points out those code fragments where floating-point numbers are compared using operator '!=' or '==', but it's the programmer alone who can figure out whether or not such comparison is incorrect.
References:
According to Common Weakness Enumeration, potential errors found by using this diagnostic are classified as CWE-682. |
You can look at examples of errors detected by the V3024 diagnostic. |