✨ Add Equals() to IQuantity interfaces

[angularsen]

Ref #1193

In v5, the default equality implementation changed to strict equality and the existing methods to compare across units with a tolerance, but this was not available in IQuantity interfaces.

Changes

• Add Equals(IQuantity? other, IQuantity tolerance) to IQuantity
• Add Equals(TSelf? other, TSelf tolerance) to IQuantity<TSelf, TUnitType, TValueType> for strongly typed comparisons
• Obsolete Equals(TQuantity other, double tolerance, ComparisonType comparisonType) method in quantity types

[codecov]

Codecov Report

Patch coverage has no change and project coverage change: -2 ⚠️

Comparison is base (5ecf8e9) 85% compared to head (4cdc1ba) 84%.

❗ Current head 4cdc1ba differs from pull request most recent head c7c0dfa. Consider uploading reports for the commit c7c0dfa to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##           master   #1215    +/-   ##
=======================================
- Coverage      85%     84%    -2%     
=======================================
  Files         328     328            
  Lines       33513   34227   +714     
=======================================
+ Hits        28800   28805     +5     
- Misses       4713    5422   +709     

Impacted Files	Coverage Δ
UnitsNet/Comparison.cs	66% <0%> (ø)
...nitsNet/GeneratedCode/Quantities/Acceleration.g.cs	85% <0%> (-2%)	⬇️
...et/GeneratedCode/Quantities/AmountOfSubstance.g.cs	85% <0%> (-2%)	⬇️
...tsNet/GeneratedCode/Quantities/AmplitudeRatio.g.cs	77% <0%> (-3%)	⬇️
UnitsNet/GeneratedCode/Quantities/Angle.g.cs	85% <0%> (-2%)	⬇️
...tsNet/GeneratedCode/Quantities/ApparentEnergy.g.cs	76% <0%> (-3%)	⬇️
...itsNet/GeneratedCode/Quantities/ApparentPower.g.cs	79% <0%> (-3%)	⬇️
UnitsNet/GeneratedCode/Quantities/Area.g.cs	87% <0%> (-2%)	⬇️
UnitsNet/GeneratedCode/Quantities/AreaDensity.g.cs	77% <0%> (-3%)	⬇️
.../GeneratedCode/Quantities/AreaMomentOfInertia.g.cs	79% <0%> (-3%)	⬇️
... and 110 more

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[angularsen]

@tmilnthorp Would like your eyes on this whenever you have time.

[tmilnthorp]

@tmilnthorp Would like your eyes on this whenever you have time.

I have the same comment as before

[angularsen]

@tmilnthorp Would like your eyes on this whenever you have time.

I have the same comment as before

I must have missed it, what comment?

[tmilnthorp]

@angularsen:

Perhaps instead of using the Comparison parameter, we could have a single method:

bool Equals(TQuantity other, TQuantity tolerance);

Or if you want asymmetric bounds:

bool IsBetween(TQuantity other, TQuantity min, TQuantity max);

This gives a lot of flexibility to use the same method for handling both situations (as unit test frameworks do):

• Use as-is for absolute tolerance
• Multiply the expected result by a scaling factor for relative tolerance

This also lets us remove the Comparison enum entirely for the future.

[dmytro-gokun]

@angularsen What did you decide to do about this PR? Is it going to be merged at some moment or?

[angularsen]

This slipped off my radar honestly.

@tmilnthorp Hm, yes, I like this contract better. Providing the error margin as a quantity.

IsBetween could be an extension method, but it is just a minor convenience to an if-statement.

So, I propose:

• Add bool Equals(TQuantity other, TQuantity tolerance) to IQuantity and implementations
• Mark existing Equals(IQuantity, double, ComparisonType) methods as obsolete
• Optional: Add extension method IsBetween.

@dmytro-gokun How does this work for you?

[tmilnthorp]

@angularsen sounds good to me. Users can also use min < value < max.

[dmytro-gokun]

@angularsen I just need this method (Equals/IsBetween/whatever) be on a some sort of a generic interface, so that it is possible to call in generic code. The rest is not important for my scenario

[angularsen]

Release UnitsNet/5.16.0 · angularsen/UnitsNet