Diffing_Engine: Hash and Diff to leverage new GeometryHash

[alelom]

NOTE: Depends on

BHoM/BHoM#1594

Issues addressed by this PR

Closes #3255
Closes #3269

The following was also implemented in this PR in order to be able to test properly the implementation of #3255.
Closes #3264

This PR makes the base Hash() use the GeometryHash() method by default (and consequently, the Diffing can also leverage it via the DiffWithHash() method). This can give a significant speed boost for an average of 33% less computation time, and a potential 99% for heavy geometry inputs. The average 33% speed improvement was measured via the DiffingTests_Prototypes DiffProfiling project and the results are as below:

---

Profiling results, running the DiffingProfiling project

The profiling considered an average use case with a mixture of geometrical and non-geometrical objects.

• Before (all on develop):
  
• When on this PR (BHoM_Engine #3268):
  

This profiling was repeated 20 times and gives an average value of about 33% less time.

---

In order to make this possible, the BH.Engine.Geometry.Query.HashArray() method now makes use of the BaseComparisonConfig options, bringing it on par to the base BH.Engine.Base.Query.Hash() method in terms of identification potential for Geometry objects. This is a requirement for any method that return an object signature (Hash). See #3269 for more information.

Test files

Same tests used in #3257, but calling BH.Engine.Base.Hash() instead of BH.Engine.Geometry.GeometryHash().

Please also run all tests in BHoM/DiffingTests_Prototypes#18.
They should all pass. Please note that the default value of the new GeometryHash option is set to true in the ComparisonConfig (see BHoM/BHoM#1594). The fact that all tests pass in the DiffingTests_Prototypes means that the new GeometryHash integration is fully compatible with the Hash() and Diffing() workflows and gives the same results, while also giving a performance boost.

Changelog

• The base BH.Engine.Base.Query.Hash() method now leverages the BH.Engine.Geometry.Query.GeometryHash() method by default. This can give a significant speed boost, for an average of 33% less computation time, and a potential 99% for heavy geometry inputs.
• The BH.Engine.Geometry.Query.HashArray() method now makes use of the BaseComparisonConfig options, bringing it on par to the base BH.Engine.Base.Query.Hash() method in terms of identification potential for Geometry objects.

[pawelbaran]

@BHoMBot check compliance

[bhombot-ci]

@pawelbaran to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check branch-compliance
• check dataset-compliance
• check copyright-compliance

[pawelbaran]

Great stuff @alelom, although not trivial to keep track of 🤯 I did my best to review it properly and took the following steps:

• read the code changes - see comments, pardon my ignorance if any of them does not make sense, a few points are based more on intuition rather than in-depth debugging
• ran GH test scripts I have built for this concept on previous occasions - all passed

[pawelbaran]

Test failures are gone after switching to the right branch in the diffing test repo, apologies and thanks for help @alelom!

[pawelbaran]

Happy to approve following code review, testing and offline discussions with @alelom. Good stuff, thanks!

[alelom]

@BHoMBot check required

[bhombot-ci]

@alelom to confirm, the following actions are now queued:

• check code-compliance
• check documentation-compliance
• check project-compliance
• check core
• check null-handling
• check serialisation
• check versioning
• check installer

[FraserGreenroyd]

@BHoMBot check copyright-compliance
@BHoMBot check dataset-compliance

[bhombot-ci]

@FraserGreenroyd to confirm, the following actions are now queued:

• check copyright-compliance
• check dataset-compliance

[FraserGreenroyd]

@BHoMBot this is a DevOps instruction. I am requesting neutral checks on: unit-tests

[bhombot-ci]

@FraserGreenroyd I have provided neutral checks to the checks requested. These checks will need to be run properly to obtain full results.

[bhombot-ci]

@alelom just to let you know, I have provided a check-ready-to-merge result to this Pull Request as it was detected to be linked to other Pull Requests in a series. The comment which triggered this check came from @FraserGreenroyd on BHoM