pythonic-fp-numpy 0.1.1__py3-none-any.whl → 1.0.0__py3-none-any.whl

pythonic_fp/numpy/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2024-2025 Geoffrey R. Scheller
+# Copyright 2024-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.
@@ -13,24 +13,17 @@
 # limitations under the License.
 
 """
-FP NumPy Tools
-==============
+NumPy Tools
+-----------
 
-Package implementing functional programming tools for NumPy.
+.. admonition:: Functional Tools for Numpy
 
-- wrapping a non-writable NDArray to make it hashable
+    Package implementing functional programming tools for NumPy.
 
-Modules
--------
-
-+-------------------------------------------+-------------------------------------------+
-| Module                                    | Description                               |
-+===========================================+===========================================+
-| **pythonic_fp_hashable_wrapped_ndarray**  | Variable storage capacity circular array. |
-+-------------------------------------------+-------------------------------------------+
+    - module **hashable_wrapped_ndarray:** Wrap a non-writable NDArray making result 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,13 +32,26 @@ __all__ = [
 
 
 class DTypes(Enum):
-    """Groups (Unions) of types closed to NumPy operations.
-
-    While NumPy types are extensively covariant, the NumPy C internals
-    are somewhat invariant. NumPy also suffers from what I call "Fortran
-    Disease", types get "auto-promoted" to compatible "wider types" when
-    necessary. That is fine when dealing with operators on mixed types,
-    but NumPy will auto-promote with operations on the same type.
+    """
+    .. admonition:: Enumeration of closed NumPy datatypes
+
+        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 Disease", types get "auto-promoted"
+        to compatible "wider types" when necessary. That is fine when
+        dealing with operators on mixed types, but NumPy will
+        auto-promote with operations on the same type.
 
     """
 
@@ -65,6 +78,12 @@ class HWrapNDArray(ABC):
     __slots__ = '_ndarray', '_type', '_shape', '_hash'
 
     def __init__(self, ndarray: npt.NDArray[np.generic]) -> None:
+        """
+        .. admonition:: init
+
+            Base class for a hashable wrapped ndarray.
+
+        """
         self._ndarray = np.array(ndarray, copy=True)
         self._ndarray.setflags(write=False)
 
@@ -75,16 +94,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)
@@ -92,133 +111,301 @@ class HWrapNDArray(ABC):
         self._shape = self._ndarray.shape
         self._hash = hash((self._ndarray.tobytes(), hash((self._shape, self._type))))
 
-    @abstractmethod
-    def __repr__(self) -> str: ...
-
     def __call__(self) -> npt.NDArray[np.number]:
-        """Return a reference to the stored NDArray.
+        """
+        .. admonition:: call
 
-        .. warning::
+            Return a reference to the stored NDArray.
 
-            For efficiency this method returns a reference to the
-            wrapped NDArray.
+            .. warning::
 
-            - Allows for faster slicing and faster operations.
-            - Use the copy method if you want a read-write copy.
-            - Never make the underlying NDArray writable!!!
+                For efficiency this method returns a reference to the
+                wrapped NDArray, not a copy.
 
-        """
+                - Allows for faster slicing and faster operations.
+                - Use the copy method if you want a read-write copy.
+                - Never make the underlying NDArray writable!!!
+
+            """
         return np.array(self._ndarray)
 
     def __hash__(self) -> int:
+        """
+        .. admonition:: hash
+
+            Return hash created during initialization. Hash only
+            remains valid if NDArray's flag remains off.
+
+        """
         return self._hash
 
     def __eq__(self, other: object) -> bool:
-        if not isinstance(other, HWrapNDArray):
+        """
+        .. admonition:: equality comparison
+
+            :param other: The ``object`` being compared to ``self``.
+            :returns: ``True`` if ``object`` is another ``HWrapNDArray``
+                      all whose corresponding components are equal to
+                      the ones in ``self``.
+
+        """
+        if not isinstance(other, type(self)):
             return False
         if self._shape != other._shape or self._type != other._type:
             return False
         return np.array_equal(self._ndarray, other._ndarray)
 
+    def _ndarray_repr(self) -> str:
+        ndarray = self._ndarray
+        repr_str = repr(ndarray)
+        repr_str = 'np.' + repr_str.replace('\n', '')
+        repr_str = repr_str.replace(' ', '') 
+        repr_str = repr_str.replace('=', "=np.")
+        return repr_str
+
+    @abstractmethod
+    def __repr__(self) -> str: ...
+
     def __str__(self) -> str:
-        np_array_str = '  ' + str(self._ndarray).replace('\n', '\n  ')
-        return f'hwrap<\n{np_array_str}\n>'
+        """
+        .. admonition:: user string
+
+            :returns: String meaningful to an end user.
 
-    def _repr(self) -> str:
-        stripped_repr = ' '.join(repr(self._ndarray).split())
-        return f'np.{stripped_repr}'
+        """
+        user_str = str(self._ndarray)
+        user_str = user_str.replace('\n ', '\n    ')
+        user_str = '<< ' + user_str + ' >>'
+        return user_str
 
     def copy(self) -> npt.NDArray[np.number]:
-        """Return a copy of the wrapped NDArray."""
+        """
+        .. admonition:: copy
+
+            Return a copy of the wrapped NDArray.
+
+        """
         return np.array(self._ndarray, copy=True)
 
 
 class HWrapNDArrayNumber(HWrapNDArray):
-    """Wrap NDArrays of arbitrary NumPy numeric types."""
+    """
+    .. admonition:: wrapped numeric ndarray
 
+        Class for a hashable wrapped numeric ndarray.
+
+    """
     def __init__(self, ndarray: npt.NDArray[np.number]) -> None:
+        """
+        .. admonition:: init
+
+            Wrap NDArray of arbitrary NumPy numeric types.
+
+        """
         super().__init__(ndarray)
 
     def __repr__(self) -> str:
-        return f'HWrapNDArrayNumber({self._repr()})'
+        """
+        .. admonition:: repr string
+
+            :returns: String to reproduce the wrapped numeric ndarray.
+
+        """
+        return 'HWrapNDArrayNumber(' + self._ndarray_repr() + ')'
 
 
 class HWrapNDArrayString(HWrapNDArray):
-    """Wrap NDArrays of Unicode strings."""
+    """
+    .. admonition:: wrapped string ndarray
+
+        Class for a hashable wrapped string ndarray.
 
+    """
     def __init__(self, ndarray: npt.NDArray[np.str_]) -> None:
+        """
+        .. admonition:: init
+
+            Wrap NDArray of Unicode strings.
+
+        """
         super().__init__(ndarray)
 
     def __repr__(self) -> str:
-        return f'HWrapNDArrayStr({self._repr()})'
+        """
+        .. admonition:: repr string
+
+            :returns: String to reproduce the wrapped string ndarray.
+
+        """
+        return 'HWrapNDArrayStr(' + self._ndarray_repr() + ')'
 
 
 class HWrapNDArrayBytes(HWrapNDArray):
-    """Wrap NDArrays of null-terminated byte sequences."""
+    """
+    .. admonition:: wrapped byte ndarray
+
+        Class for a hashable wrapped null-terminated
+        byte sequence ndarray.
 
+    """
     def __init__(self, ndarray: npt.NDArray[np.bytes_]) -> None:
+        """
+        .. admonition:: init
+
+            Wrap NDArray of null-terminated byte sequences.
+
+        """
         super().__init__(ndarray)
 
     def __repr__(self) -> str:
-        return f'HWrapNDArrayBytes({self._repr()})'
+        """
+        .. admonition:: repr string
+
+            :returns: String to reproduce the wrapped null-terminated
+                      byte sequence ndarray.
+
+        """
+        return 'HWrapNDArrayBytes(' + self._ndarray_repr() + ')'
 
 
 class HWrapNDArrayVoid(HWrapNDArray):
-    """Wrap NDArrays of arbitrary byte sequences."""
+    """
+    .. admonition:: wrapped void ndarray
 
+        Class for a hashable wrapped arbitrary byte
+        sequence ndarray.
+
+    """
     def __init__(self, ndarray: npt.NDArray[np.void]) -> None:
+        """
+        .. admonition:: init
+
+            Wrap NDArray of arbitrary byte sequences.
+
+        """
         super().__init__(ndarray)
 
     def __repr__(self) -> str:
-        return f'HWrapNDArrayVoid({self._repr()})'
+        """
+        .. admonition:: repr string
+
+            :returns: String to reproduce the wrapped arbitrary
+                      byte sequence ndarray.
+
+        """
+        return 'HWrapNDArrayVoid(' + self._ndarray_repr() + ')'
 
 
 class HWrapNDArrayObject(HWrapNDArray):
-    """Wrap NDArrays of references to arbitrary Python objects."""
+    """
+    .. admonition:: wrapped object reference ndarray
+
+        Class for a hashable wrapped object reference ndarray.
 
+    """
     def __init__(self, ndarray: npt.NDArray[np.object_]) -> None:
+        """
+        .. admonition:: init
+
+            Wrap NDArray of references to arbitrary Python objects.
+
+        """
         super().__init__(ndarray)
 
     def __repr__(self) -> str:
-        return f'HWrapNDArrayObject({self._repr()})'
+        """
+        .. admonition:: repr string
+
+            :returns: String to reproduce the wrapped object
+                      reference ndarray.
+
+        """
+        return 'HWrapNDArrayObject(' + self._ndarray_repr() + ')'
 
 
 class HWrapNDArrayDateTime(HWrapNDArray):
-    """Wrap NDArrays of references to arbitrary Python objects."""
+    """
+    .. admonition:: wrapped datetime ndarray
 
+        Class for a hashable wrapped datatime ndarray.
+
+    """
     def __init__(self, ndarray: npt.NDArray[np.datetime64]) -> None:
+        """
+        .. admonition:: init
+
+            Wrap NDArray of datetimes.
+
+        """
         super().__init__(ndarray)
 
     def __repr__(self) -> str:
-        return f'HWrapNDArrayTimeDelta({self._repr()})'
+        """
+        .. admonition:: repr string
+
+            :returns: String to reproduce the wrapped datetime ndarray.
+
+        """
+        return 'HWrapNDArrayTimeDelta(' + self._ndarray_repr() + ')'
 
 
 class HWrapNDArrayTimeDelta(HWrapNDArray):
-    """Wrap NDArrays of references to arbitrary Python objects."""
+    """
+    .. admonition:: wrapped timedelta ndarray
+
+        Class for a hashable wrapped timedelta ndarray.
 
+    """
     def __init__(self, ndarray: npt.NDArray[np.timedelta64]) -> None:
+        """
+        .. admonition:: init
+
+            Wrap NDArray of timedeltas.
+
+        """
         super().__init__(ndarray)
 
     def __repr__(self) -> str:
-        return f'HWrapNDArrayTimeDelta({self._repr()})'
+        """
+        .. admonition:: repr string
+
+            :returns: String to reproduce the wrapped timedelta ndarray.
+
+        """
+        return 'HWrapNDArrayTimeDelta(' + self._ndarray_repr() + ')'
 
 
 class HWrapNDArrayBool(HWrapNDArray):
-    """Wrap NDArrays of Booleans.
+    """
+    .. admonition:: wrapped Boolean ndarray
 
-    NumPy Booleans are actual Booleans, unlike Python bools which are
-    subtypes of int.
+        Class for a hashable wrapped Boolean ndarray.
 
-    .. note::
+        .. note::
 
-        - ***** uses component-wise Boolean **and**
-        - **+** uses component-wise Boolean **or**
-        - **@** does matrix multiplication using **and** then **or**
+            NumPy Booleans are actual Booleans, unlike Python bools
+            which are subtypes of int.
+
+            - ``*`` uses component-wise Boolean **and**
+            - ``+`` uses component-wise Boolean **or**
+            - ``@`` matrix multiplication using **and** then **or**
 
     """
 
     def __init__(self, ndarray: npt.NDArray[np.bool_]) -> None:
+        """
+        .. admonition:: init
+
+            Wrap NDArray of Booleans.
+
+        """
         super().__init__(ndarray)
 
     def __repr__(self) -> str:
-        return f'HWrapNDArrayBool({self._repr()})'
+        """
+        .. admonition:: repr string
+
+            :returns: String to reproduce the wrapped Boolean ndarray.
+
+        """
+        return 'HWrapNDArrayBool(' + self._ndarray_repr() + ')'

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.1.dist-info → pythonic_fp_numpy-1.0.0.dist-info}/METADATA

@@ -1,40 +1,40 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-numpy
-Version: 0.1.1
-Summary: FP NumPy Tools
+Version: 1.0.0
+Summary: NumPy Tools
 Keywords: numpy,ndarray,hashable,wrap
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
 Requires-Python: >=3.13
 Description-Content-Type: text/x-rst
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 3 - Alpha
 Classifier: Framework :: Pytest
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Typing :: Typed
 License-File: LICENSE
 Requires-Dist: numpy>=2.3.4
-Requires-Dist: boring-math-abstract-algebra ; extra == "test"
+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-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: Documentation, https://grscheller.github.io/pythonic-fp/projects/numpy.html
+Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/
 Project-URL: Source, https://github.com/grscheller/pythonic-fp-numpy
 Provides-Extra: test
 
-Pythonic FP - FP NumPy
+Pythonic FP - FP Numpy
 ======================
 
 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>`_
+<https://grscheller.github.io/pythonic-fp/>`_
 PyPI projects.
 
 Modules
@@ -43,20 +43,20 @@ 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
 
 Documentation
 -------------
 
-Documentation for this project is hosted on
+Documentation and other links for this project are hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/numpy>`_.
+<https://grscheller.github.io/pythonic-fp/projects/numpy.html>`_.
 
 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-1.0.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+pythonic_fp/numpy/__init__.py,sha256=dL-LF98cK5PId82_PBhTq9iTnfZthQkCq_jBTSKKBN0,964
+pythonic_fp/numpy/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp/numpy/hashable_wrapped_ndarray.py,sha256=Y8ZKHuD_Rw754fagc1cvTztgAwtt58uu58fY5If8HCI,10798
+pythonic_fp/numpy/hashable_wrapped_ndarray.pyi,sha256=J4jsl5q5Lz15-Amunh824R5JOxZk8hnSUlDuPXa5lcs,1666
+pythonic_fp/numpy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp_numpy-1.0.0.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
+pythonic_fp_numpy-1.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+pythonic_fp_numpy-1.0.0.dist-info/METADATA,sha256=r_FLuxuoFdJQR9qX3DZbNEBt6kO-lePS5RYgjLMM6DM,1917
+pythonic_fp_numpy-1.0.0.dist-info/RECORD,,

pythonic_fp_numpy-0.1.1.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.1.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
-pythonic_fp_numpy-0.1.1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-pythonic_fp_numpy-0.1.1.dist-info/METADATA,sha256=SFt1OjsWkILoPA_3pcm5YKPdAfl-SiyXskkpadpjZHI,1896
-pythonic_fp_numpy-0.1.1.dist-info/RECORD,,