Update docstrings and formatting
@@ -42,6 +42,7 @@ cdef class Vectors:
shape (tuple): Size of the table, as (# entries, # columns)
data (numpy.ndarray): The vector data.
+ keys (iterable): A sequence of keys, aligned with the data.
RETURNS (Vectors): The newly created object.
"""
if data is None:
@@ -102,7 +103,7 @@ cdef class Vectors:
"""Set a vector for the given key.
key (int): The key to set the vector for.
- vector (numpy.ndarray): The vector to set.
+ vector (ndarray): The vector to set.
"""
i = self.key2row[key]
self.data[i] = vector
@@ -110,9 +111,9 @@ cdef class Vectors:
self._unset.remove(i)
def __iter__(self):
- """Yield vectors from the table.
+ """Iterate over the keys in the table.
- YIELDS (ndarray): A vector.
+ YIELDS (int): A key in the table.
"""
yield from self.key2row
@@ -132,14 +133,14 @@ cdef class Vectors:
return key in self.key2row
def resize(self, shape, inplace=False):
- '''Resize the underlying vectors array. If inplace=True, the memory
+ """Resize the underlying vectors array. If inplace=True, the memory
is reallocated. This may cause other references to the data to become
invalid, so only use inplace=True if you're sure that's what you want.
If the number of vectors is reduced, keys mapped to rows that have been
deleted are removed. These removed items are returned as a list of
- (key, row) tuples.
- '''
+ `(key, row)` tuples.
+ """
if inplace:
self.data.resize(shape, refcheck=False)
else:
@@ -155,14 +156,20 @@ cdef class Vectors:
return removed_items
def keys(self):
- '''Iterate over the keys in the table.'''
- yield from self.key2row.keys()
+ """A sequence of the keys in the table.
+
+ RETURNS (iterable): The keys.
+ """
+ return self.key2row.keys()
def values(self):
- '''Iterate over vectors that have been assigned to at least one key.
+ """Iterate over vectors that have been assigned to at least one key.
Note that some vectors may be unassigned, so the number of vectors
- returned may be less than the length of the vectors table.'''
+ returned may be less than the length of the vectors table.
+
+ YIELDS (ndarray): A vector in the table.
+ """
for row, vector in enumerate(range(self.data.shape[0])):
if row not in self._unset:
yield vector
