numba-mpi 1.0.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

numba_mpi/__init__.py

@@ -13,6 +13,7 @@ from .api.isend import isend
 from .api.operator import Operator
 from .api.rank import rank
 from .api.recv import recv
+from .api.reduce import reduce
 from .api.requests import test, testall, testany, wait, waitall, waitany
 from .api.scatter_gather import allgather, gather, scatter
 from .api.send import send

numba_mpi/api/reduce.py

@@ -0,0 +1,112 @@
+"""file contains MPI_Reduce() implementations"""
+
+import ctypes
+from numbers import Number
+
+import numpy as np
+from numba.core import types
+from numba.extending import overload
+
+from numba_mpi.common import _MPI_Comm_World_ptr, _MpiComm, _MpiDatatype, _MpiOp, libmpi
+from numba_mpi.utils import _mpi_addr, _mpi_dtype
+
+_MPI_Reduce = libmpi.MPI_Reduce
+_MPI_Reduce.restype = ctypes.c_int
+_MPI_Reduce.argtypes = [
+    ctypes.c_void_p,
+    ctypes.c_void_p,
+    ctypes.c_int,
+    _MpiDatatype,
+    _MpiOp,
+    ctypes.c_int,
+    _MpiComm,
+]
+
+
+def reduce(sendobj, recvobj, operator, root):  # pylint: disable=unused-argument
+    """wrapper for MPI_Reduce
+    Note that complex datatypes and user-defined functions are not properly supported.
+    Returns integer status code (0 == MPI_SUCCESS)
+    """
+    if isinstance(sendobj, Number):
+        # reduce a single number
+        sendobj = np.array([sendobj])
+        status = _MPI_Reduce(
+            sendobj.ctypes.data,
+            recvobj.ctypes.data,
+            sendobj.size,
+            _mpi_dtype(sendobj),
+            _mpi_addr(operator),
+            root,
+            _mpi_addr(_MPI_Comm_World_ptr),
+        )
+
+    elif isinstance(sendobj, np.ndarray):
+        # reduce an array
+        sendobj = np.ascontiguousarray(sendobj)
+        status = _MPI_Reduce(
+            sendobj.ctypes.data,
+            recvobj.ctypes.data,
+            sendobj.size,
+            _mpi_dtype(sendobj),
+            _mpi_addr(operator),
+            root,
+            _mpi_addr(_MPI_Comm_World_ptr),
+        )
+
+    else:
+        raise TypeError(f"Unsupported type {sendobj.__class__.__name__}")
+
+    return status
+
+
+@overload(reduce)
+def ol_reduce(sendobj, recvobj, operator, root):  # pylint: disable=unused-argument
+    """wrapper for MPI_Reduce
+    Note that complex datatypes and user-defined functions are not properly supported.
+    Returns integer status code (0 == MPI_SUCCESS)
+    """
+    if isinstance(sendobj, types.Number):
+        # reduce a single number
+
+        def impl(sendobj, recvobj, operator, root):
+            sendobj = np.array([sendobj])
+
+            status = _MPI_Reduce(
+                sendobj.ctypes.data,
+                recvobj.ctypes.data,
+                sendobj.size,
+                _mpi_dtype(sendobj),
+                _mpi_addr(operator),
+                root,
+                _mpi_addr(_MPI_Comm_World_ptr),
+            )
+
+            # The following no-op prevents numba from too aggressive optimizations
+            # This looks like a bug in numba (tested for version 0.55)
+            sendobj[0]  # pylint: disable=pointless-statement
+
+            return status
+
+    elif isinstance(sendobj, types.Array):
+        # reduce an array
+
+        def impl(sendobj, recvobj, operator, root):
+            sendobj = np.ascontiguousarray(sendobj)
+
+            status = _MPI_Reduce(
+                sendobj.ctypes.data,
+                recvobj.ctypes.data,
+                sendobj.size,
+                _mpi_dtype(sendobj),
+                _mpi_addr(operator),
+                root,
+                _mpi_addr(_MPI_Comm_World_ptr),
+            )
+
+            return status
+
+    else:
+        raise TypeError(f"Unsupported type {sendobj.__class__.__name__}")
+
+    return impl

{numba_mpi-1.0.0.dist-info → numba_mpi-1.1.1.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: numba-mpi
-Version: 1.0.0
-Summary: Numba @njittable MPI wrappers tested on Linux, macOS and Windows
+Version: 1.1.1
+Summary: Numba @jittable MPI wrappers tested on Linux, macOS and Windows
 Home-page: https://github.com/numba-mpi/numba-mpi
 Author: https://github.com/numba-mpi/numba-mpi/graphs/contributors
 License: GPL v3
@@ -19,7 +19,7 @@ Provides-Extra: tests
 Requires-Dist: pytest <8.0.0 ; extra == 'tests'
 Requires-Dist: py-pde ; extra == 'tests'
 
-# <img src="https://raw.githubusercontent.com/numba-mpi/numba-mpi/main/.github/numba_mpi_logo.svg" style="height:50pt" alt="numba-mpi logo"> numba-mpi
+# <img src="https://raw.githubusercontent.com/numba-mpi/numba-mpi/main/.github/numba_mpi_logo.png" width=128 height=142 alt="numba-mpi logo"> numba-mpi
 
 [![Python 3](https://img.shields.io/static/v1?label=Python&logo=Python&color=3776AB&message=3)](https://www.python.org/)
 [![LLVM](https://img.shields.io/static/v1?label=LLVM&logo=LLVM&color=gold&message=Numba)](https://numba.pydata.org)
@@ -35,9 +35,9 @@ Requires-Dist: py-pde ; extra == 'tests'
 [![DOI](https://zenodo.org/badge/316911228.svg)](https://zenodo.org/badge/latestdoi/316911228)
 
 ### Overview
-numba-mpi provides Python wrappers to the C MPI API callable from within [Numba JIT-compiled code](https://numba.readthedocs.io/en/stable/user/jit.html) (@njit mode).
+numba-mpi provides Python wrappers to the C MPI API callable from within [Numba JIT-compiled code](https://numba.readthedocs.io/en/stable/user/jit.html) (@jit mode). For an outline of the project, rationale, architecture, and features, refer to: [numba-mpi arXiv e-print](https://doi.org/10.48550/arXiv.2407.13712) (please cite if numba-mpi is used in your research).
 
-Support is provided for a subset of MPI routines covering: `size`/`rank`, `send`/`recv`, `allreduce`, `bcast`, `scatter`/`gather` & `allgather`, `barrier`, `wtime`
+Support is provided for a subset of MPI routines covering: `size`/`rank`, `send`/`recv`, `allreduce`, `reduce`, `bcast`, `scatter`/`gather` & `allgather`, `barrier`, `wtime`
 and basic asynchronous communication with `isend`/`irecv` (only for contiguous arrays); for request handling including `wait`/`waitall`/`waitany` and `test`/`testall`/`testany`.
 
 The API uses NumPy and supports both numeric and character datatypes (e.g., `broadcast`). 
@@ -66,7 +66,7 @@ Features that are not implemented yet include (help welcome!):
 ```python
 import numba, numba_mpi, numpy
 
-@numba.njit()
+@numba.jit()
 def hello():
     src = numpy.array([1., 2., 3., 4., 5.])
     dst_tst = numpy.empty_like(src)

{numba_mpi-1.0.0.dist-info → numba_mpi-1.1.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-numba_mpi/__init__.py,sha256=_DsPxgrR80KiJTLqzZRNMVsK_TUJt7EfNFy_MWvBOWk,754
+numba_mpi/__init__.py,sha256=EsiszqT6I7-Vrbgdk36_mGp5kHpAS5AYCkhjRya-5rg,785
 numba_mpi/common.py,sha256=2JJoUrd3Qa6GIFk6Zlt2NudS7ZurPxpVwBLRGSkCg5E,2266
 numba_mpi/utils.py,sha256=gfGFuzmGgs4FnBqzPI91ftAq4UHgXb_HFkvxrVWkcIo,1866
 numba_mpi/api/__init__.py,sha256=Zj5df4lWeGpxAXV8jKGFnmtLBQ50HwNU8dPf-os06X8,51
@@ -11,13 +11,14 @@ numba_mpi/api/isend.py,sha256=2mpP4FhMk0GrikjDluKwRnpVywdLj9RD4HVVEMSj9A8,1080
 numba_mpi/api/operator.py,sha256=3VTPZAdOP05bxdqt3lA0hRDICM-iaBMa4m-krEdO91s,342
 numba_mpi/api/rank.py,sha256=1xZvHUclsK20aMtK07JzXYxW5F4Er8HZgOmcf495sjo,597
 numba_mpi/api/recv.py,sha256=YsYK-q7PNfi3zt0ftVddM363VsnJ4XFfmgMq8aeCr-o,1260
+numba_mpi/api/reduce.py,sha256=ug8WctzXRuxD3IrvrXN4sAfWdjJ1vvMhwykTgF8nn1s,3233
 numba_mpi/api/requests.py,sha256=5EhgFyeQCGP8YclSPwxP95c2AhBo19CLlShK0TxCR2U,9114
 numba_mpi/api/scatter_gather.py,sha256=goZn4BxMKakWQHjfXIOdjzK3DJ-lTeaiQQwgnyQeZ_s,2410
 numba_mpi/api/send.py,sha256=jn1hPw0YHBHOaeJop_ZbjaBChaqgfw3nM1xGhW9sabI,909
 numba_mpi/api/size.py,sha256=-RX-FtcIH4qDxCoGOhZjjgEWXpytt79vsH0YX9dtZuY,597
 numba_mpi/api/wtime.py,sha256=qrTqlefW7K7hqnAQKkGYm8kgdiRGuSAGiHmPcTrhLzE,279
-numba_mpi-1.0.0.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-numba_mpi-1.0.0.dist-info/METADATA,sha256=X9KbPWSmXB953BPIUua1e9ZVeXP2XeDM9Ppp0ailOKI,9687
-numba_mpi-1.0.0.dist-info/WHEEL,sha256=y4mX-SOX4fYIkonsAGA5N0Oy-8_gI4FXw5HNI1xqvWg,91
-numba_mpi-1.0.0.dist-info/top_level.txt,sha256=yb_ktLmrfuhOZS0rjS81FFNC-gK_4c19WbLG2ViP73g,10
-numba_mpi-1.0.0.dist-info/RECORD,,
+numba_mpi-1.1.1.dist-info/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+numba_mpi-1.1.1.dist-info/METADATA,sha256=a9ZEpxFg6RO9FMIz7vUdn52cQYcK6hiuLMVf-2sYIA0,9897
+numba_mpi-1.1.1.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
+numba_mpi-1.1.1.dist-info/top_level.txt,sha256=yb_ktLmrfuhOZS0rjS81FFNC-gK_4c19WbLG2ViP73g,10
+numba_mpi-1.1.1.dist-info/RECORD,,

{numba_mpi-1.0.0.dist-info → numba_mpi-1.1.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (70.2.0)
+Generator: setuptools (75.5.0)
 Root-Is-Purelib: true
 Tag: py3-none-any