Prepared validation for SparseVector order [skip ci]

Author: ankane

pgvector/sparsevec.py

@@ -147,6 +147,11 @@ def _validate(self) -> None:
         if any(i < 0 or i >= self._dim for i in self._indices):
             raise ValueError('sparsevec index out of bounds')
 
+    def _validate_sorted(self) -> None:
+        for i in range(len(self._indices) - 1):
+            if self._indices[i] >= self._indices[i + 1]:
+                raise ValueError('sparsevec indices must be in ascending order')
+
     @classmethod
     def from_text(cls, value: str, /) -> SparseVector:
         elements, dim = value.split('/', 2)
@@ -182,6 +187,7 @@ def _from_parts(cls, dim: int, indices: list[int], values: list[float], /) -> Sp
         vec._values = values
         # TODO uncomment in 0.6.0
         # vec._validate()
+        # vec._validate_sorted()
         return vec
 
     @classmethod

tests/test_sparse_vector.py

@@ -169,6 +169,16 @@ def test_from_text(self) -> None:
             assert np.array_equal(vec.to_numpy(), [1.5, 0, 2, 0, 3, 0])
         assert vec.to_text() == '{1:1.5,3:2.0,5:3.0}/6'
 
+    # TODO uncomment in 0.6.0
+    # def test_from_text_unsorted(self) -> None:
+    #     with pytest.raises(ValueError, match='sparsevec indices must be in ascending order'):
+    #         SparseVector.from_text('{2:1,1:1}/3')
+
+    # TODO uncomment in 0.6.0
+    # def test_from_text_duplicate(self) -> None:
+    #     with pytest.raises(ValueError, match='sparsevec indices must be in ascending order'):
+    #         SparseVector.from_text('{2:1,2:1}/3')
+
     def test_from_binary(self) -> None:
         data = pack('>iii3i3f', 6, 3, 0, 0, 2, 4, 1.5, 2, 3)
         vec = SparseVector.from_binary(data)