Renamed dim method to dimensions [skip ci]

ankane · ankane · commit 7088b11380ca · 2024-06-20T16:26:23.000-07:00
diff --git a/pgvector/utils/halfvec.py b/pgvector/utils/halfvec.py
@@ -16,7 +16,7 @@ def __init__(self, value):
     def __repr__(self):
         return f'HalfVector({self.to_list()})'
 
-    def dim(self):
+    def dimensions(self):
         return len(self._value)
 
     def to_list(self):
@@ -29,7 +29,7 @@ def to_text(self):
         return '[' + ','.join([str(float(v)) for v in self._value]) + ']'
 
     def to_binary(self):
-        return pack('>HH', self.dim(), 0) + self._value.tobytes()
+        return pack('>HH', self.dimensions(), 0) + self._value.tobytes()
 
     @classmethod
     def from_text(cls, value):
@@ -48,8 +48,8 @@ def _to_db(cls, value, dim=None):
         if not isinstance(value, cls):
             value = cls(value)
 
-        if dim is not None and value.dim() != dim:
-            raise ValueError('expected %d dimensions, not %d' % (dim, value.dim()))
+        if dim is not None and value.dimensions() != dim:
+            raise ValueError('expected %d dimensions, not %d' % (dim, value.dimensions()))
 
         return value.to_text()
 
diff --git a/pgvector/utils/sparsevec.py b/pgvector/utils/sparsevec.py
@@ -18,7 +18,7 @@ def __init__(self, value, dimensions=None):
             self._from_dense(value)
 
     def __repr__(self):
-        return f'SparseVector({self.to_dict()}, {self.dim()})'
+        return f'SparseVector({self.to_dict()}, {self.dimensions()})'
 
     def _from_dict(self, d, dim):
         if dim is None:
@@ -52,7 +52,7 @@ def _from_dense(self, value):
         self._indices = [i for i, v in enumerate(value) if v != 0]
         self._values = [float(value[i]) for i in self._indices]
 
-    def dim(self):
+    def dimensions(self):
         return self._dim
 
     def to_dict(self):
@@ -117,8 +117,8 @@ def _to_db(cls, value, dim=None):
         if not isinstance(value, cls):
             value = cls(value)
 
-        if dim is not None and value.dim() != dim:
-            raise ValueError('expected %d dimensions, not %d' % (dim, value.dim()))
+        if dim is not None and value.dimensions() != dim:
+            raise ValueError('expected %d dimensions, not %d' % (dim, value.dimensions()))
 
         return value.to_text()
 
diff --git a/pgvector/utils/vector.py b/pgvector/utils/vector.py
@@ -16,7 +16,7 @@ def __init__(self, value):
     def __repr__(self):
         return f'Vector({self.to_list()})'
 
-    def dim(self):
+    def dimensions(self):
         return len(self._value)
 
     def to_list(self):
@@ -29,7 +29,7 @@ def to_text(self):
         return '[' + ','.join([str(float(v)) for v in self._value]) + ']'
 
     def to_binary(self):
-        return pack('>HH', self.dim(), 0) + self._value.tobytes()
+        return pack('>HH', self.dimensions(), 0) + self._value.tobytes()
 
     @classmethod
     def from_text(cls, value):
@@ -48,8 +48,8 @@ def _to_db(cls, value, dim=None):
         if not isinstance(value, cls):
             value = cls(value)
 
-        if dim is not None and value.dim() != dim:
-            raise ValueError('expected %d dimensions, not %d' % (dim, value.dim()))
+        if dim is not None and value.dimensions() != dim:
+            raise ValueError('expected %d dimensions, not %d' % (dim, value.dimensions()))
 
         return value.to_text()
 
diff --git a/tests/test_half_vector.py b/tests/test_half_vector.py
@@ -38,5 +38,5 @@ def test_repr(self):
         assert repr(HalfVector([1, 2, 3])) == 'HalfVector([1.0, 2.0, 3.0])'
         assert str(HalfVector([1, 2, 3])) == 'HalfVector([1.0, 2.0, 3.0])'
 
-    def test_dim(self):
-        assert HalfVector([1, 2, 3]).dim() == 3
+    def test_dimensions(self):
+        assert HalfVector([1, 2, 3]).dimensions() == 3
diff --git a/tests/test_sparse_vector.py b/tests/test_sparse_vector.py
@@ -37,8 +37,8 @@ def test_repr(self):
         assert repr(SparseVector([1, 0, 2, 0, 3, 0])) == 'SparseVector({0: 1.0, 2: 2.0, 4: 3.0}, 6)'
         assert str(SparseVector([1, 0, 2, 0, 3, 0])) == 'SparseVector({0: 1.0, 2: 2.0, 4: 3.0}, 6)'
 
-    def test_dim(self):
-        assert SparseVector([1, 0, 2, 0, 3, 0]).dim() == 6
+    def test_dimensions(self):
+        assert SparseVector([1, 0, 2, 0, 3, 0]).dimensions() == 6
 
     def test_to_dict(self):
         assert SparseVector([1, 0, 2, 0, 3, 0]).to_dict() == {0: 1, 2: 2, 4: 3}
diff --git a/tests/test_vector.py b/tests/test_vector.py
@@ -38,5 +38,5 @@ def test_repr(self):
         assert repr(Vector([1, 2, 3])) == 'Vector([1.0, 2.0, 3.0])'
         assert str(Vector([1, 2, 3])) == 'Vector([1.0, 2.0, 3.0])'
 
-    def test_dim(self):
-        assert Vector([1, 2, 3]).dim() == 3
+    def test_dimensions(self):
+        assert Vector([1, 2, 3]).dimensions() == 3
