Merge pull request #173 from static-frame/172/a2d-tuple

Support 1d arrays

Author: flexatone

README.rst

@@ -40,9 +40,9 @@ What is New in ArrayKit
 0.7.0
 ............
 
-Added ``array2d_to_array1d()``.
+Added ``array_to_tuple_array()``.
 
-Added ``array2d_tuple_iter()``.
+Added ``array_to_tuple_iter()``.
 
 
 0.6.3

doc/articles/array2d_to_1d.py renamed to doc/articles/array_to_tuple_array.py

@@ -3,7 +3,7 @@
 import timeit
 import typing as tp
 
-from arraykit import array2d_to_array1d
+from arraykit import array_to_tuple_array
 import arraykit as ak
 
 import matplotlib.pyplot as plt
@@ -21,20 +21,24 @@ def __init__(self, array: np.ndarray):
 
 #-------------------------------------------------------------------------------
 class AKArray2D1D(ArrayProcessor):
-    NAME = 'ak.array2d_to_array1d()'
+    NAME = 'ak.array_to_tuple_array()'
     SORT = 0
 
     def __call__(self):
-        _ = array2d_to_array1d(self.array)
+        _ = array_to_tuple_array(self.array)
 
 class PyArray2D1D(ArrayProcessor):
     NAME = 'Python construction'
     SORT = 1
 
     def __call__(self):
         post = np.empty(self.array.shape[0], dtype=object)
-        for i, row in enumerate(self.array):
-            post[i] = tuple(row)
+        if self.array.ndim == 1:
+            for i, e in enumerate(self.array):
+                post[i] = (e,)
+        else:
+            for i, row in enumerate(self.array):
+                post[i] = tuple(row)
         post.flags.writeable = False
 
 #-------------------------------------------------------------------------------
@@ -102,16 +106,16 @@ def plot_performance(frame):
     fig.set_size_inches(8, 4) # width, height
     fig.legend(post, names_display, loc='center right', fontsize=6)
     # horizontal, vertical
-    fig.text(.05, .96, f'array2d_to_array1d() Performance: {NUMBER} Iterations', fontsize=10)
+    fig.text(.05, .96, f'array_to_tuple_array() Performance: {NUMBER} Iterations', fontsize=10)
     fig.text(.05, .90, get_versions(), fontsize=6)
 
-    fp = '/tmp/array2d_to_array1d.png'
+    fp = '/tmp/array_to_tuple_array.png'
     plt.subplots_adjust(
             left=0.05,
             bottom=0.05,
             right=0.8,
             top=0.85,
-            wspace=0.9, # width
+            wspace=1.0, # width
             hspace=0.5,
             )
     # plt.rcParams.update({'font.size': 22})
@@ -130,14 +134,17 @@ class FixtureFactory:
 
     @staticmethod
     def get_array(size: int, width_ratio: int) -> np.ndarray:
-        return np.arange(size).reshape(size // width_ratio, width_ratio)
+        if width_ratio > 1:
+            return np.arange(size).reshape(size // width_ratio, width_ratio)
+        return np.arange(size) # return 1D array
 
     @classmethod
     def get_label_array(cls, size: int) -> tp.Tuple[str, np.ndarray]:
         array = cls.get_array(size)
         return cls.NAME, array
 
     DENSITY_TO_DISPLAY = {
+        'column-1': '1 Column',
         'column-2': '2 Column',
         'column-5': '5 Column',
         'column-10': '10 Column',
@@ -150,6 +157,15 @@ def get_label_array(cls, size: int) -> tp.Tuple[str, np.ndarray]:
     # }
 
 
+class FFC1(FixtureFactory):
+    NAME = 'column-1'
+
+    @staticmethod
+    def get_array(size: int) -> np.ndarray:
+        a = FixtureFactory.get_array(size, 1)
+        return a
+
+
 class FFC2(FixtureFactory):
     NAME = 'column-2'
 
@@ -193,6 +209,7 @@ def get_versions() -> str:
     )
 
 CLS_FF = (
+    FFC1,
     FFC2,
     FFC5,
     FFC10,

doc/articles/array2d_tuple_iter.py renamed to doc/articles/array_to_tuple_iter.py

@@ -3,7 +3,7 @@
 import timeit
 import typing as tp
 
-from arraykit import array2d_tuple_iter
+from arraykit import array_to_tuple_iter
 import arraykit as ak
 
 import matplotlib.pyplot as plt
@@ -21,18 +21,18 @@ def __init__(self, array: np.ndarray):
 
 #-------------------------------------------------------------------------------
 class AKArray2DTupleList(ArrayProcessor):
-    NAME = 'list(ak.array2d_tuple_iter(a2d))'
+    NAME = 'list(ak.array_to_tuple_iter(a2d))'
     SORT = 0
 
     def __call__(self):
-        _ = list(array2d_tuple_iter(self.array))
+        _ = list(array_to_tuple_iter(self.array))
 
 class AKArray2DTupleNext(ArrayProcessor):
-    NAME = 'next(ak.array2d_tuple_iter(a2d))'
+    NAME = 'next(ak.array_to_tuple_iter(a2d))'
     SORT = 1
 
     def __call__(self):
-        it = array2d_tuple_iter(self.array)
+        it = array_to_tuple_iter(self.array)
         while True:
             try:
                 _ = next(it)
@@ -45,19 +45,31 @@ class PyArray2DTupleMapList(ArrayProcessor):
 
     def __call__(self):
         array = self.array
-        _ = list(map(tuple, array))
+        if array.ndim == 2:
+            _ = list(map(tuple, array))
+        else:
+            _ = list(map(lambda e: (e,), array))
 
 class PyArray2DTupleIterNext(ArrayProcessor):
     NAME = 'tuple(next(iter(a2d)))'
     SORT = 3
 
     def __call__(self):
-        it = iter(self.array)
-        while True:
-            try:
-                _ = tuple(next(it))
-            except StopIteration:
-                break
+        array = self.array
+        it = iter(array)
+        if array.ndim == 2:
+            while True:
+                try:
+                    _ = tuple(next(it))
+                except StopIteration:
+                    break
+        else:
+            while True:
+                try:
+                    _ = (next(it),)
+                except StopIteration:
+                    break
+
 
 
 
@@ -128,10 +140,10 @@ def plot_performance(frame):
     fig.set_size_inches(8, 4) # width, height
     fig.legend(post, names_display, loc='center right', fontsize=6)
     # horizontal, vertical
-    fig.text(.05, .96, f'array2d_tuple_iter() Performance: {NUMBER} Iterations', fontsize=10)
+    fig.text(.05, .96, f'array_to_tuple_iter() Performance: {NUMBER} Iterations', fontsize=10)
     fig.text(.05, .90, get_versions(), fontsize=6)
 
-    fp = '/tmp/array2d_tuple_iter.png'
+    fp = '/tmp/array_to_tuple_iter.png'
     plt.subplots_adjust(
             left=0.05,
             bottom=0.05,
@@ -156,21 +168,33 @@ class FixtureFactory:
 
     @staticmethod
     def get_array(size: int, width_ratio: int) -> np.ndarray:
-        return np.arange(size).reshape(size // width_ratio, width_ratio)
+        if width_ratio > 1:
+            return np.arange(size).reshape(size // width_ratio, width_ratio)
+        return np.arange(size) # return 1D array
 
     @classmethod
     def get_label_array(cls, size: int) -> tp.Tuple[str, np.ndarray]:
         array = cls.get_array(size)
         return cls.NAME, array
 
     DENSITY_TO_DISPLAY = {
+        'column-1': '1 Column',
         'column-2': '2 Column',
         'column-5': '5 Column',
         'column-10': '10 Column',
         'column-20': '20 Column',
     }
 
 
+class FFC1(FixtureFactory):
+    NAME = 'column-1'
+
+    @staticmethod
+    def get_array(size: int) -> np.ndarray:
+        a = FixtureFactory.get_array(size, 1)
+        return a
+
+
 class FFC2(FixtureFactory):
     NAME = 'column-2'
 
@@ -217,6 +241,7 @@ def get_versions() -> str:
 
 
 CLS_FF = (
+    FFC1,
     FFC2,
     FFC5,
     FFC10,

src/__init__.py

@@ -28,6 +28,6 @@
 from ._arraykit import first_true_1d as first_true_1d
 from ._arraykit import first_true_2d as first_true_2d
 from ._arraykit import slice_to_ascending_slice as slice_to_ascending_slice
-from ._arraykit import array2d_to_array1d as array2d_to_array1d
-from ._arraykit import array2d_tuple_iter as array2d_tuple_iter
+from ._arraykit import array_to_tuple_array as array_to_tuple_array
+from ._arraykit import array_to_tuple_iter as array_to_tuple_iter
 from ._arraykit import nonzero_1d as nonzero_1d

src/__init__.pyi

@@ -161,5 +161,5 @@ def first_true_1d(__array: np.ndarray, *, forward: bool) -> int: ...
 def first_true_2d(__array: np.ndarray, *, forward: bool, axis: int) -> np.ndarray: ...
 def nonzero_1d(__array: np.ndarray, /) -> np.ndarray: ...
 def slice_to_ascending_slice(__slice: slice, __size: int) -> slice: ...
-def array2d_to_array1d(__array: np.ndarray) -> np.ndarray: ...
-def array2d_tuple_iter(__array: np.ndarray) -> tp.Iterator[tp.Tuple[tp.Any, ...]]: ...
+def array_to_tuple_array(__array: np.ndarray) -> np.ndarray: ...
+def array_to_tuple_iter(__array: np.ndarray) -> tp.Iterator[tp.Tuple[tp.Any, ...]]: ...