pythonic-fp-numpy 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

pythonic_fp/numpy/__init__.py

@@ -18,19 +18,17 @@ FP NumPy Tools
 
 Package implementing functional programming tools for NumPy.
 
-- wrapping a non-writable NDArray to make it hashable
-
 Modules
 -------
 
-+-------------------------------------------+-------------------------------------------+
-| Module                                    | Description                               |
-+===========================================+===========================================+
-| **pythonic_fp_hashable_wrapped_ndarray**  | Variable storage capacity circular array. |
-+-------------------------------------------+-------------------------------------------+
++-------------------------------+--------------------------------------+
+| Module                        | Description                          |
++===============================+======================================+
+| **hashable_wrapped_ndarray**  | Make non-writable NDArrays hashable. |
++-------------------------------+--------------------------------------+
 
 """
 
 __author__ = 'Geoffrey R. Scheller'
-__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2023-2026 Geoffrey R. Scheller'
 __license__ = 'Apache License 2.0'

pythonic_fp/numpy/hashable_wrapped_ndarray.py

@@ -1,4 +1,4 @@
-# Copyright 2025 Geoffrey R. Scheller
+# Copyright 2025-2026 Geoffrey R. Scheller
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -32,7 +32,18 @@ __all__ = [
 
 
 class DTypes(Enum):
-    """Groups (Unions) of types closed to NumPy operations.
+    """Enumeration of closed NumPy datatypes.
+
+    .. admonition:: Groups (Unions) of NumPy datatypes closed to NumPy operations.
+
+        - number
+        - str\_
+        - bytes
+        - datetime64
+        - timedelta64
+        - bool\_
+        - void
+        - object\_
 
     While NumPy types are extensively covariant, the NumPy C internals
     are somewhat invariant. NumPy also suffers from what I call "Fortran
@@ -75,16 +86,16 @@ class HWrapNDArray(ABC):
             self._type = DTypes.str_
         elif issubclass(dtype, np.bytes_):
             self._type = DTypes.bytes
-        elif issubclass(dtype, np.void):
-            self._type = DTypes.void
-        elif issubclass(dtype, np.object_):
-            self._type = DTypes.object_
         elif issubclass(dtype, np.datetime64):
             self._type = DTypes.datetime64
         elif issubclass(dtype, np.timedelta64):
             self._type = DTypes.timedelta64
         elif issubclass(dtype, np.bool_):
             self._type = DTypes.bool_
+        elif issubclass(dtype, np.void):
+            self._type = DTypes.void
+        elif issubclass(dtype, np.object_):
+            self._type = DTypes.object_
         else:
             msg = f"HWrapNDArray: Unknow np.dtype '{dtype}'"
             raise TypeError(msg)
@@ -125,7 +136,7 @@ class HWrapNDArray(ABC):
         return f'hwrap<\n{np_array_str}\n>'
 
     def _repr(self) -> str:
-        stripped_repr = ' '.join(repr(self._ndarray).split())
+        stripped_repr = ''.join(repr(self._ndarray).split())
         return f'np.{stripped_repr}'
 
     def copy(self) -> npt.NDArray[np.number]:
@@ -163,44 +174,44 @@ class HWrapNDArrayBytes(HWrapNDArray):
         return f'HWrapNDArrayBytes({self._repr()})'
 
 
-class HWrapNDArrayVoid(HWrapNDArray):
-    """Wrap NDArrays of arbitrary byte sequences."""
+class HWrapNDArrayDateTime(HWrapNDArray):
+    """Wrap NDArrays of references to arbitrary Python objects."""
 
-    def __init__(self, ndarray: npt.NDArray[np.void]) -> None:
+    def __init__(self, ndarray: npt.NDArray[np.datetime64]) -> None:
         super().__init__(ndarray)
 
     def __repr__(self) -> str:
-        return f'HWrapNDArrayVoid({self._repr()})'
+        return f'HWrapNDArrayTimeDelta({self._repr()})'
 
 
-class HWrapNDArrayObject(HWrapNDArray):
+class HWrapNDArrayTimeDelta(HWrapNDArray):
     """Wrap NDArrays of references to arbitrary Python objects."""
 
-    def __init__(self, ndarray: npt.NDArray[np.object_]) -> None:
+    def __init__(self, ndarray: npt.NDArray[np.timedelta64]) -> None:
         super().__init__(ndarray)
 
     def __repr__(self) -> str:
-        return f'HWrapNDArrayObject({self._repr()})'
+        return f'HWrapNDArrayTimeDelta({self._repr()})'
 
 
-class HWrapNDArrayDateTime(HWrapNDArray):
-    """Wrap NDArrays of references to arbitrary Python objects."""
+class HWrapNDArrayVoid(HWrapNDArray):
+    """Wrap NDArrays of arbitrary byte sequences."""
 
-    def __init__(self, ndarray: npt.NDArray[np.datetime64]) -> None:
+    def __init__(self, ndarray: npt.NDArray[np.void]) -> None:
         super().__init__(ndarray)
 
     def __repr__(self) -> str:
-        return f'HWrapNDArrayTimeDelta({self._repr()})'
+        return f'HWrapNDArrayVoid({self._repr()})'
 
 
-class HWrapNDArrayTimeDelta(HWrapNDArray):
+class HWrapNDArrayObject(HWrapNDArray):
     """Wrap NDArrays of references to arbitrary Python objects."""
 
-    def __init__(self, ndarray: npt.NDArray[np.timedelta64]) -> None:
+    def __init__(self, ndarray: npt.NDArray[np.object_]) -> None:
         super().__init__(ndarray)
 
     def __repr__(self) -> str:
-        return f'HWrapNDArrayTimeDelta({self._repr()})'
+        return f'HWrapNDArrayObject({self._repr()})'
 
 
 class HWrapNDArrayBool(HWrapNDArray):
@@ -211,9 +222,9 @@ class HWrapNDArrayBool(HWrapNDArray):
 
     .. note::
 
-        - ***** uses component-wise Boolean **and**
-        - **+** uses component-wise Boolean **or**
-        - **@** does matrix multiplication using **and** then **or**
+        - ``*`` uses component-wise Boolean **and**
+        - ``+`` uses component-wise Boolean **or**
+        - ``@`` does matrix multiplication using **and** then **or**
 
     """
 

pythonic_fp/numpy/hashable_wrapped_ndarray.pyi

@@ -0,0 +1,48 @@
+import abc
+import numpy as np
+import numpy.typing as npt
+from abc import ABC
+from enum import Enum
+
+__all__ = ['DTypes', 'HWrapNDArray', 'HWrapNDArrayNumber', 'HWrapNDArrayString', 'HWrapNDArrayBytes', 'HWrapNDArrayVoid', 'HWrapNDArrayObject', 'HWrapNDArrayDateTime', 'HWrapNDArrayTimeDelta', 'HWrapNDArrayBool']
+
+class DTypes(Enum):
+    number = ...
+    str_ = ...
+    bytes = ...
+    void = ...
+    object_ = ...
+    datetime64 = ...
+    timedelta64 = ...
+    bool_ = ...
+
+class HWrapNDArray(ABC, metaclass=abc.ABCMeta):
+    def __init__(self, ndarray: npt.NDArray[np.generic]) -> None: ...
+    def __call__(self) -> npt.NDArray[np.number]: ...
+    def __hash__(self) -> int: ...
+    def __eq__(self, other: object) -> bool: ...
+    def copy(self) -> npt.NDArray[np.number]: ...
+
+class HWrapNDArrayNumber(HWrapNDArray):
+    def __init__(self, ndarray: npt.NDArray[np.number]) -> None: ...
+
+class HWrapNDArrayString(HWrapNDArray):
+    def __init__(self, ndarray: npt.NDArray[np.str_]) -> None: ...
+
+class HWrapNDArrayBytes(HWrapNDArray):
+    def __init__(self, ndarray: npt.NDArray[np.bytes_]) -> None: ...
+
+class HWrapNDArrayVoid(HWrapNDArray):
+    def __init__(self, ndarray: npt.NDArray[np.void]) -> None: ...
+
+class HWrapNDArrayObject(HWrapNDArray):
+    def __init__(self, ndarray: npt.NDArray[np.object_]) -> None: ...
+
+class HWrapNDArrayDateTime(HWrapNDArray):
+    def __init__(self, ndarray: npt.NDArray[np.datetime64]) -> None: ...
+
+class HWrapNDArrayTimeDelta(HWrapNDArray):
+    def __init__(self, ndarray: npt.NDArray[np.timedelta64]) -> None: ...
+
+class HWrapNDArrayBool(HWrapNDArray):
+    def __init__(self, ndarray: npt.NDArray[np.bool_]) -> None: ...

{pythonic_fp_numpy-0.1.0.dist-info → pythonic_fp_numpy-0.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-numpy
-Version: 0.1.0
+Version: 0.1.2
 Summary: FP NumPy Tools
 Keywords: numpy,ndarray,hashable,wrap
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
@@ -15,11 +15,12 @@ Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 License-File: LICENSE
 Requires-Dist: numpy>=2.3.4
+Requires-Dist: boring-math-abstract-algebra>=1.1.0 ; extra == "test"
 Requires-Dist: pytest>=8.4.1 ; extra == "test"
-Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-circulararray/blob/main/CHANGELOG.rst
-Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/circulararray/development/build/html/
+Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-numpy/blob/main/CHANGELOG.rst
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/numpy/development/build/html/
 Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/homepage/build/html/
-Project-URL: Source, https://github.com/grscheller/pythonic-fp-circulararray
+Project-URL: Source, https://github.com/grscheller/pythonic-fp-numpy
 Provides-Extra: test
 
 Pythonic FP - FP NumPy
@@ -29,17 +30,20 @@ PyPI project
 `pythonic-fp-numpy
 <https://pypi.org/project/pythonic-fp-numpy>`_.
 
-Python module implementing functional programming for NumPy.
+Python package implementing functional programming for NumPy.
 
 Part of the
 `pythonic-fp
 <https://grscheller.github.io/pythonic-fp>`_
 PyPI projects.
 
+Modules
+-------
+
 Module hashable_wrapped_ndarray
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-  - wrap an NDArray and make it hashable
+  - wrap readonly NDArrays to make them hashable
   - prioritize performance over safety
   - see PyPI project boring-math-abstract-algebra for a use case
 
@@ -53,6 +57,6 @@ Documentation for this project is hosted on
 Copyright and License
 ---------------------
 
-Copyright (c) 2025 Geoffrey R. Scheller. Licensed under the Apache
+Copyright (c) 2025-2026 Geoffrey R. Scheller. Licensed under the Apache
 License, Version 2.0. See the LICENSE file for details.
 

pythonic_fp_numpy-0.1.2.dist-info/RECORD

@@ -0,0 +1,9 @@
+pythonic_fp/numpy/__init__.py,sha256=lXFznwyXPi4HeoJDOi0Y-CeMBcMlYgx5x92TZxU001U,1209
+pythonic_fp/numpy/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp/numpy/hashable_wrapped_ndarray.py,sha256=IfZvEwjSHJxCjFdAP_4tO6UGts1WjiBa8clQuFsL9nE,7016
+pythonic_fp/numpy/hashable_wrapped_ndarray.pyi,sha256=J4jsl5q5Lz15-Amunh824R5JOxZk8hnSUlDuPXa5lcs,1666
+pythonic_fp/numpy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp_numpy-0.1.2.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
+pythonic_fp_numpy-0.1.2.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+pythonic_fp_numpy-0.1.2.dist-info/METADATA,sha256=OIHPnGrhVoPhFrPBi_DGHDSWDDgLoMJyPdrk4waMmno,1917
+pythonic_fp_numpy-0.1.2.dist-info/RECORD,,

pythonic_fp_numpy-0.1.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-pythonic_fp/numpy/__init__.py,sha256=m4lHMlHUem6qWnVan0rzdjlCTrXYG7HJuFreFpfjqrE,1349
-pythonic_fp/numpy/hashable_wrapped_ndarray.py,sha256=IUy3XjNfBsKMRUQu5X7HWRV_dv5wGfC65_6oFmyoxi8,6798
-pythonic_fp/numpy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp_numpy-0.1.0.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
-pythonic_fp_numpy-0.1.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-pythonic_fp_numpy-0.1.0.dist-info/METADATA,sha256=tC4RFYiDOpWXJJ9fy9QJ5rW_tBAHA7DRYiyTp4LKiYM,1841
-pythonic_fp_numpy-0.1.0.dist-info/RECORD,,