[ENH] Adds support for distances that are asymmetric but supports unequal length

.all-contributorsrc

@@ -2674,6 +2674,15 @@
       "contributions": [
         "doc"
       ]
+    },
+    {
+      "login": "tanishy7777",
+      "name": "Tanish Yelgoe",
+      "avatar_url": "https://avatars.githubusercontent.com/u/143334319?v=4",
+      "profile": "https://www.tanishyelgoe.tech/",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "commitType": "docs"

aeon/distances/tests/test_distances.py

@@ -28,7 +28,7 @@
 
 
 def _validate_distance_result(
-    x, y, name, distance, expected_result=10, check_xy_permuted=True
+    x, y, name, distance, symmetric, expected_result=10, check_xy_permuted=True
 ):
     """
     Validate the distance result by comparing it with the expected result.
@@ -57,12 +57,13 @@ def _validate_distance_result(
     assert isinstance(dist_result_to_self, float)
 
     # If unequal length swap where x and y are to ensure it works both ways around
-    if original_x.shape[-1] != original_y.shape[-1] and check_xy_permuted:
+    if symmetric and original_x.shape[-1] != original_y.shape[-1] and check_xy_permuted:
         _validate_distance_result(
             original_y,
             original_x,
             name,
             distance,
+            symmetric,
             expected_result,
             check_xy_permuted=False,
         )
@@ -82,6 +83,7 @@ def test_distances(dist):
         make_example_1d_numpy(10, random_state=2),
         dist["name"],
         dist["distance"],
+        dist["symmetric"],
         _expected_distance_results[dist["name"]][0],
     )
 
@@ -91,6 +93,7 @@ def test_distances(dist):
         make_example_2d_numpy_series(10, 1, random_state=2),
         dist["name"],
         dist["distance"],
+        dist["symmetric"],
         _expected_distance_results[dist["name"]][0],
     )
 
@@ -100,6 +103,7 @@ def test_distances(dist):
         make_example_2d_numpy_series(10, 1, random_state=2),
         dist["name"],
         dist["distance"],
+        dist["symmetric"],
         _expected_distance_results[dist["name"]][1],
     )
 
@@ -111,6 +115,7 @@ def test_distances(dist):
             make_example_1d_numpy(10, random_state=2),
             dist["name"],
             dist["distance"],
+            dist["symmetric"],
             _expected_distance_results[dist["name"]][2],
         )
 
@@ -120,6 +125,7 @@ def test_distances(dist):
             make_example_2d_numpy_series(10, 1, random_state=2),
             dist["name"],
             dist["distance"],
+            dist["symmetric"],
             _expected_distance_results[dist["name"]][2],
         )
 
@@ -129,6 +135,7 @@ def test_distances(dist):
             make_example_2d_numpy_series(10, 10, random_state=2),
             dist["name"],
             dist["distance"],
+            dist["symmetric"],
             _expected_distance_results[dist["name"]][3],
         )
 
@@ -140,6 +147,7 @@ def test_distances(dist):
             np.array([15.0]),
             dist["name"],
             dist["distance"],
+            dist["symmetric"],
             _expected_distance_results[dist["name"]][4],
         )
 
@@ -149,6 +157,7 @@ def test_distances(dist):
             np.array([[15.0]]),
             dist["name"],
             dist["distance"],
+            dist["symmetric"],
             _expected_distance_results[dist["name"]][4],
         )