Minimum Distance Operator

[Eric-Vin]

Description

Adds an operator to compute the minimum distance between two objects, accounting for shape, size, etc... To vote on the name of this operator, please use this poll.

Issue Link

N/A

Checklist

• I have tested the changes locally via pytest and/or other means
• I have added or updated relevant documentation
• I have autoformatted the code with black and isort
• I have added test cases (if applicable)

Additional Notes

Please do not merge until poll results are finalized and I have updated the code to reflect them.

[codecov]

Codecov Report

❌ Patch coverage is 95.83333% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 89.88%. Comparing base (8257147) to head (6e53653).
⚠️ Report is 2 commits behind head on main.

Files with missing lines	Patch %	Lines
src/scenic/core/object_types.py	85.71%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #482   +/-   ##
=======================================
  Coverage   89.87%   89.88%           
=======================================
  Files          48       48           
  Lines       13346    13374   +28     
=======================================
+ Hits        11995    12021   +26     
- Misses       1351     1353    +2     

Files with missing lines	Coverage Δ
src/scenic/core/regions.py	88.23% <100.00%> (+0.08%)	⬆️
src/scenic/syntax/ast.py	97.22% <100.00%> (+0.02%)	⬆️
src/scenic/syntax/compiler.py	98.27% <100.00%> (+<0.01%)	⬆️
src/scenic/syntax/veneer.py	89.78% <100.00%> (-0.05%)	⬇️
src/scenic/core/object_types.py	93.08% <85.71%> (-0.07%)	⬇️

... and 3 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[dfremont]

Suggested change

	The minimum distance to the given Object from ego (or the Object provided with the optional from Object). Unlike :ref:`distance from`, this operator takes into account the Objects' shapes, sizes, etc...
	The minimum distance to the given Object from ego (or the Object provided with the optional :scenic:`from {Object}`). Unlike :ref:`distance from`, which computes the distance between the :prop:`position` of the objects, this operator takes into account the objects' :prop:`shape` and dimensions.

[dfremont]

Suggested change

	raise RuntimeError(
	raise TypeError(

[dfremont]

Looks good (just one comment), but please add a .. note to the Operator Reference section for distance from explaining that when passed objects it just computes the distance between their positions (i.e. their centers), and that if you want to find the separation between two objects taking into account their shape and size you should use minimum distance from.

Also the minimum distance from entry needs a .. version-added directive. You could put version 3.2 for now I guess, or maybe something like "unreleased".