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

pythonic_fp/numpy/__init__.py

@@ -0,0 +1,36 @@
+# Copyright 2024-2025 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.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+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. |
++-------------------------------------------+-------------------------------------------+
+
+"""
+
+__author__ = 'Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
+__license__ = 'Apache License 2.0'

pythonic_fp/numpy/hashable_wrapped_ndarray.py

@@ -0,0 +1,224 @@
+# Copyright 2025 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.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from abc import ABC, abstractmethod
+from enum import auto, Enum
+import numpy as np
+import numpy.typing as npt
+
+__all__ = [
+    'DTypes',
+    'HWrapNDArray',
+    'HWrapNDArrayNumber',
+    'HWrapNDArrayString',
+    'HWrapNDArrayBytes',
+    'HWrapNDArrayVoid',
+    'HWrapNDArrayObject',
+    'HWrapNDArrayDateTime',
+    'HWrapNDArrayTimeDelta',
+    'HWrapNDArrayBool',
+]
+
+
+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.
+
+    """
+
+    number = auto()
+    str_ = auto()
+    bytes = auto()
+    void = auto()
+    object_ = auto()
+    datetime64 = auto()
+    timedelta64 = auto()
+    bool_ = auto()
+
+
+class HWrapNDArray(ABC):
+    """
+    Make NumPy NDArrays hashable.
+
+    Just making an NDArray (np.array) readonly is not enough. This class
+    stores a read-only copy of the NDArray given to the constructor and
+    is hashable.
+
+    """
+
+    __slots__ = '_ndarray', '_type', '_shape', '_hash'
+
+    def __init__(self, ndarray: npt.NDArray[np.generic]) -> None:
+        self._ndarray = np.array(ndarray, copy=True)
+        self._ndarray.setflags(write=False)
+
+        dtype = self._ndarray.dtype.type
+        if issubclass(dtype, np.number):
+            self._type = DTypes.number
+        elif isinstance(dtype, np.str_):
+            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_
+        else:
+            msg = f"HWrapNDArray: Unknow np.dtype '{dtype}'"
+            raise TypeError(msg)
+
+        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.
+
+        .. warning::
+
+            For efficiency this method returns a reference to the
+            wrapped NDArray.
+
+            - 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:
+        return self._hash
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, HWrapNDArray):
+            return False
+        if self._shape != other._shape or self._type != other._type:
+            return False
+        return np.array_equal(self._ndarray, other._ndarray)
+
+    def __str__(self) -> str:
+        np_array_str = '  ' + str(self._ndarray).replace('\n', '\n  ')
+        return f'hwrap<\n{np_array_str}\n>'
+
+    def _repr(self) -> str:
+        stripped_repr = ' '.join(repr(self._ndarray).split())
+        return f'np.{stripped_repr}'
+
+    def copy(self) -> npt.NDArray[np.number]:
+        """Return a copy of the wrapped NDArray."""
+        return np.array(self._ndarray, copy=True)
+
+
+class HWrapNDArrayNumber(HWrapNDArray):
+    """Wrap NDArrays of arbitrary NumPy numeric types."""
+
+    def __init__(self, ndarray: npt.NDArray[np.number]) -> None:
+        super().__init__(ndarray)
+
+    def __repr__(self) -> str:
+        return f'HWrapNDArrayNumber({self._repr()})'
+
+
+class HWrapNDArrayString(HWrapNDArray):
+    """Wrap NDArrays of Unicode strings."""
+
+    def __init__(self, ndarray: npt.NDArray[np.str_]) -> None:
+        super().__init__(ndarray)
+
+    def __repr__(self) -> str:
+        return f'HWrapNDArrayStr({self._repr()})'
+
+
+class HWrapNDArrayBytes(HWrapNDArray):
+    """Wrap NDArrays of null-terminated byte sequences."""
+
+    def __init__(self, ndarray: npt.NDArray[np.bytes_]) -> None:
+        super().__init__(ndarray)
+
+    def __repr__(self) -> str:
+        return f'HWrapNDArrayBytes({self._repr()})'
+
+
+class HWrapNDArrayVoid(HWrapNDArray):
+    """Wrap NDArrays of arbitrary byte sequences."""
+
+    def __init__(self, ndarray: npt.NDArray[np.void]) -> None:
+        super().__init__(ndarray)
+
+    def __repr__(self) -> str:
+        return f'HWrapNDArrayVoid({self._repr()})'
+
+
+class HWrapNDArrayObject(HWrapNDArray):
+    """Wrap NDArrays of references to arbitrary Python objects."""
+
+    def __init__(self, ndarray: npt.NDArray[np.object_]) -> None:
+        super().__init__(ndarray)
+
+    def __repr__(self) -> str:
+        return f'HWrapNDArrayObject({self._repr()})'
+
+
+class HWrapNDArrayDateTime(HWrapNDArray):
+    """Wrap NDArrays of references to arbitrary Python objects."""
+
+    def __init__(self, ndarray: npt.NDArray[np.datetime64]) -> None:
+        super().__init__(ndarray)
+
+    def __repr__(self) -> str:
+        return f'HWrapNDArrayTimeDelta({self._repr()})'
+
+
+class HWrapNDArrayTimeDelta(HWrapNDArray):
+    """Wrap NDArrays of references to arbitrary Python objects."""
+
+    def __init__(self, ndarray: npt.NDArray[np.timedelta64]) -> None:
+        super().__init__(ndarray)
+
+    def __repr__(self) -> str:
+        return f'HWrapNDArrayTimeDelta({self._repr()})'
+
+
+class HWrapNDArrayBool(HWrapNDArray):
+    """Wrap NDArrays of Booleans.
+
+    NumPy Booleans are actual Booleans, unlike Python bools which are
+    subtypes of int.
+
+    .. note::
+
+        - ***** uses component-wise Boolean **and**
+        - **+** uses component-wise Boolean **or**
+        - **@** does matrix multiplication using **and** then **or**
+
+    """
+
+    def __init__(self, ndarray: npt.NDArray[np.bool_]) -> None:
+        super().__init__(ndarray)
+
+    def __repr__(self) -> str:
+        return f'HWrapNDArrayBool({self._repr()})'

pythonic_fp_numpy-0.1.0.dist-info/METADATA

@@ -0,0 +1,58 @@
+Metadata-Version: 2.4
+Name: pythonic-fp-numpy
+Version: 0.1.0
+Summary: FP 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: 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: Typing :: Typed
+License-File: LICENSE
+Requires-Dist: numpy>=2.3.4
+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: Homepage, https://grscheller.github.io/pythonic-fp/homepage/build/html/
+Project-URL: Source, https://github.com/grscheller/pythonic-fp-circulararray
+Provides-Extra: test
+
+Pythonic FP - FP NumPy
+======================
+
+PyPI project
+`pythonic-fp-numpy
+<https://pypi.org/project/pythonic-fp-numpy>`_.
+
+Python module implementing functional programming for NumPy.
+
+Part of the
+`pythonic-fp
+<https://grscheller.github.io/pythonic-fp>`_
+PyPI projects.
+
+Module hashable_wrapped_ndarray
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+  - wrap an NDArray and make it hashable
+  - prioritize performance over safety
+  - see PyPI project boring-math-abstract-algebra for a use case
+
+Documentation
+-------------
+
+Documentation for this project is hosted on
+`GitHub Pages
+<https://grscheller.github.io/pythonic-fp/numpy>`_.
+
+Copyright and License
+---------------------
+
+Copyright (c) 2025 Geoffrey R. Scheller. Licensed under the Apache
+License, Version 2.0. See the LICENSE file for details.
+

pythonic_fp_numpy-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+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,,

pythonic_fp_numpy-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: flit 3.12.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pythonic_fp_numpy-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS