rarg-numba-patterns 0.0.1__tar.gz

rarg_numba_patterns-0.0.1/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly

rarg_numba_patterns-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: Continuous Integration
+
+on:
+  push: { branches: [main], tags: ["*"] }
+  pull_request:
+  schedule: [{ cron: '30 2 * * 1,4' }]  # Every Monday and Thursday @ 2h30am UTC
+
+jobs:
+  test:
+    uses: ratt-ru/rarg-gh-workflows/.github/workflows/python-ci.yml@main
+    with:
+      os-matrix: '["ubuntu-24.04"]'  # Add other OS (macos-15) if necessary
+      install-command: 'pip install --group test .'
+
+  deploy:
+    needs: ["test"]
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/rarg-numba-patterns
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/setup-python@v6
+        with: { python-version: '3.13' }
+      - uses: actions/checkout@v6
+      - run: pip install -U pip build && python -m build --sdist --wheel
+      - name: Publish distribution 📦 to PyPI
+        if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@release/v1

rarg_numba_patterns-0.0.1/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+*.lcov
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

rarg_numba_patterns-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,26 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+# Run `pre-commit autoupdate` after scaffolding to pin current hook revs.
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.3
+    hooks:
+    -   id: ruff
+        # Handle imports, see
+        # https://github.com/astral-sh/ruff/issues/8232
+        # https://github.com/astral-sh/ruff/issues/10882
+        args: [ --fix, --extend-select, I ]
+    -   id: ruff-format
+        name: ruff format
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.17.0
+    hooks:
+    -   id: mypy
+        name: mypy

rarg_numba_patterns-0.0.1/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Rhodes University Centre for Radio Astronomy Techniques & Technologies (RATT)
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

rarg_numba_patterns-0.0.1/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.4
+Name: rarg-numba-patterns
+Version: 0.0.1
+Summary: General-purpose numba intrinsics and literals patterns
+Project-URL: Homepage, https://github.com/ratt-ru/rarg-numba-patterns
+Project-URL: Repository, https://github.com/ratt-ru/rarg-numba-patterns
+Author-email: Simon Perkins <simon.perkins@gmail.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Requires-Python: <3.15,>=3.10
+Requires-Dist: numba>=0.60.0
+Requires-Dist: numpy>=2.0.0
+Description-Content-Type: text/markdown
+
+# rarg-numba-patterns
+
+General-purpose numba intrinsics and literals patterns

rarg_numba_patterns-0.0.1/README.md

@@ -0,0 +1,3 @@
+# rarg-numba-patterns
+
+General-purpose numba intrinsics and literals patterns

rarg_numba_patterns-0.0.1/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "rarg-numba-patterns"
+version = "0.0.1"
+description = "General-purpose numba intrinsics and literals patterns"
+readme = "README.md"
+requires-python = ">=3.10, <3.15"
+license = "BSD-3-Clause"
+authors = [{ name = "Simon Perkins", email = "simon.perkins@gmail.com" }]
+dependencies = [
+    "numpy>=2.0.0",
+    "numba>=0.60.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/ratt-ru/rarg-numba-patterns"
+Repository = "https://github.com/ratt-ru/rarg-numba-patterns"
+
+[dependency-groups]
+test = ["pytest"]
+dev = ["pre-commit", "mypy", "ruff", "tbump"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/rarg_numba_patterns"]
+
+[tool.ruff]
+line-length = 88
+indent-width = 2
+
+[tool.ruff.lint]
+extend-select = ["I"]  # import sorting
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
+[tool.tbump.version]
+current = "0.0.1"
+# https://semver.org/#spec-item-9
+regex = '''(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)-?(?P<ptype>(alpha|beta|rc)\.(?P<prerelease>\d+))?'''
+
+[tool.tbump.git]
+message_template = "Bump to {new_version}"
+tag_template = "{new_version}"
+
+[[tool.tbump.file]]
+src = "pyproject.toml"
+search = 'version = "{current_version}"'
+
+[[tool.tbump.file]]
+src = "src/rarg_numba_patterns/__init__.py"
+search = '__version__ = "{current_version}"'

rarg_numba_patterns-0.0.1/src/rarg_numba_patterns/__init__.py

@@ -0,0 +1,47 @@
+"""General-purpose numba intrinsics and literals patterns"""
+
+from rarg_numba_patterns.intrinsics import (
+  accumulate_data,
+  atomic_rmw_intrinsic,
+  field_ptr,
+  item_ptr,
+  load_data,
+  overload_atomic_rmw,
+  overload_field_ptr,
+  overload_item_ptr,
+)
+from rarg_numba_patterns.literals import (
+  BooleanDatumLiteral,
+  Datum,
+  DatumLiteral,
+  FloatDatumLiteral,
+  IntegerDatumLiteral,
+  is_datum_literal,
+  LiteralStructRef,
+  Schema,
+  SchemaLiteral,
+  StringDatumLiteral,
+)
+
+__all__ = [
+  "accumulate_data",
+  "atomic_rmw_intrinsic",
+  "BooleanDatumLiteral",
+  "Datum",
+  "DatumLiteral",
+  "field_ptr",
+  "FloatDatumLiteral",
+  "IntegerDatumLiteral",
+  "is_datum_literal",
+  "item_ptr",
+  "LiteralStructRef",
+  "load_data",
+  "overload_atomic_rmw",
+  "overload_field_ptr",
+  "overload_item_ptr",
+  "Schema",
+  "SchemaLiteral",
+  "StringDatumLiteral",
+]
+
+__version__ = "0.0.1"

rarg_numba_patterns-0.0.1/src/rarg_numba_patterns/concurrency/mutex.py

@@ -0,0 +1,199 @@
+"""This module contains code for some simple atomic spinlocks
+
+See the discussion here
+https://numba.discourse.group/t/phi-node-error-when-creating-a-while-loop-for-an-atomic-spinlock/3046
+"""
+
+import ctypes
+import os
+
+import numba
+import numpy as np
+from llvmlite import ir
+from numba.core import cgutils, types
+from numba.core.errors import RequireLiteralValue, TypingError
+from numba.extending import intrinsic
+
+if os.name == "posix":
+  YIELD_FUNCTION = "sched_yield"
+elif os.name == "nt":
+  YIELD_FUNCTION = "SwitchToThread"
+else:
+  raise NotImplementedError(f"atomic locks on OS {os.name}")
+
+if not hasattr(ctypes.CDLL(None), YIELD_FUNCTION):
+  raise ImportError(
+    f"{YIELD_FUNCTION} not found in the default OS system libraries. "
+    f"atomic locks are not supported on this platform"
+  )
+
+
+def _emit_lock_op(context, builder, operation, ptr, lock_type):
+  """Emit IR for a lock or unlock operation on an already-resolved pointer."""
+
+  llvm_lock_type = context.get_value_type(lock_type.dtype)
+
+  ll_index_type = context.get_value_type(types.int64)
+
+  if operation.literal_value == "unlock":
+    builder.store_atomic(
+      ir.Constant(llvm_lock_type, 0),
+      ptr,
+      ordering="release",
+      align=context.get_abi_alignment(llvm_lock_type),
+    )
+    return ir.Constant(ir.IntType(1), 1)
+
+  # Spin until the lock is acquired
+  loop_cond = builder.append_basic_block(name="lock.while.cond")
+  loop_body = builder.append_basic_block(name="lock.while.body")
+  loop_end = builder.append_basic_block(name="lock.while.end")
+
+  # Get the OS yield function
+  try:
+    sched_yield = builder.module.globals[YIELD_FUNCTION]
+  except KeyError:
+    sched_yield_fnty = ir.FunctionType(ir.IntType(32), [])
+    sched_yield = ir.Function(builder.module, sched_yield_fnty, name=YIELD_FUNCTION)
+
+  start_block = builder.block
+  builder.branch(loop_cond)
+
+  with builder.goto_block(loop_cond):
+    count_phi = builder.phi(ll_index_type, name="lock.while.index")
+    xchng_result = builder.cmpxchg(
+      ptr,
+      ir.Constant(llvm_lock_type, 0),
+      ir.Constant(llvm_lock_type, 1),
+      ordering="acquire",
+      failordering="acquire",
+    )
+    success = builder.extract_value(xchng_result, 1)
+    pred = builder.icmp_signed("==", success, success.type(1))
+    builder.cbranch(pred, loop_end, loop_body)
+
+  with builder.goto_block(loop_body):
+    next_count = builder.add(count_phi, count_phi.type(1))
+    builder.call(sched_yield, [])
+    branch_block = builder.block
+    builder.branch(loop_cond)
+
+  count_phi.add_incoming(count_phi.type(0), start_block)
+  count_phi.add_incoming(next_count, branch_block)
+
+  builder.position_at_end(loop_end)
+  return ir.Constant(ir.IntType(1), 1)
+
+
+@intrinsic(prefer_literal=True)
+def atomic_lock(typingctx, lock_type):
+  """Allocates an integer suitable for use as an atomic lock
+  on the stack and returns a pointer to that integer"""
+
+  if not isinstance(lock_type, (types.NumberClass, types.DType)):
+    raise TypingError(f"{lock_type} is not a NumberClass or DType")
+
+  def codegen(context, builder, signature, args):
+    llvm_lock_type = context.get_value_type(lock_type.dtype)
+    ptr = cgutils.alloca_once(builder, llvm_lock_type)
+    builder.store(ir.Constant(llvm_lock_type, 0), ptr)
+    return ptr
+
+  return types.CPointer(lock_type.dtype)(lock_type), codegen
+
+
+@intrinsic(prefer_literal=True)
+def lock_int_op(typingctx, lock: types.CPointer, operation: types.StringLiteral):
+  """Performs an atomic lock/lock on integer located by a pointer"""
+  if not isinstance(operation, types.StringLiteral) or operation.literal_value not in {
+    "lock",
+    "unlock",
+  }:
+    raise RequireLiteralValue(
+      f"'operation' {operation} must be a StringLiteral "
+      f"set to either lock or unlock"
+    )
+
+  if not (isinstance(lock, types.CPointer) and isinstance(lock.dtype, types.Integer)):
+    raise TypingError(f"lock {lock} must be an CPointer to an integer")
+
+  sig = types.bool(lock, operation)
+
+  def codegen(context, builder, signature, args):
+    lock, _ = args
+    lock_type, _ = signature.args
+    return _emit_lock_op(context, builder, operation, lock, lock_type)
+
+  return sig, codegen
+
+
+@intrinsic(prefer_literal=True)
+def lock_array_op(
+  typingctx, lock: types.Array, idx: types.UniTuple, operation: types.StringLiteral
+):
+  """Performs an atomic lock/unlock operation at the given index in an integer array"""
+  if not isinstance(operation, types.StringLiteral) or operation.literal_value not in {
+    "lock",
+    "unlock",
+  }:
+    raise RequireLiteralValue(
+      f"'operation' {operation} must be a StringLiteral "
+      f"set to either lock or unlock"
+    )
+
+  if not isinstance(lock, types.Array) or not isinstance(lock.dtype, types.Integer):
+    raise TypingError(f"lock {lock} must be an Array of integers")
+
+  if (
+    not isinstance(idx, types.UniTuple)
+    or not isinstance(idx.dtype, types.Integer)
+    or len(idx) != lock.ndim
+  ):
+    raise TypingError(f"idx {idx} must be a Tuple of length {lock.ndim} integers")
+
+  sig = types.bool(lock, idx, operation)
+
+  def codegen(context, builder, signature, args):
+    lock, idx, _ = args
+    lock_type, idx_type, _ = signature.args
+    lock_array = context.make_array(lock_type)(context, builder, lock)
+    native_idx = [builder.extract_value(idx, i) for i in range(len(idx_type))]
+    out_ptr = builder.gep(lock_array.data, native_idx)
+    return _emit_lock_op(context, builder, operation, out_ptr, lock_type)
+
+  return sig, codegen
+
+
+if __name__ == "__main__":
+  """Test script"""
+
+  @numba.njit(nogil=True)
+  def lock_index():
+    ll = numba.typed.List()
+    ll.append(atomic_lock(np.dtype(np.uint8)))
+    ll.append(atomic_lock(np.dtype(np.uint8)))
+    ll.append(atomic_lock(np.dtype(np.uint8)))
+    lock_int_op(ll[0], "lock")
+    lock_int_op(ll[0], "unlock")
+
+    return ll
+
+  print(len(lock_index()))
+
+  if True:
+
+    @numba.njit(nogil=True)
+    def lock_index(a, i):
+      return lock_array_op(a, i, "lock")
+
+    @numba.njit(nogil=True)
+    def unlock_index(a, i):
+      return lock_array_op(a, i, "unlock")
+
+    locks = np.full(10, 0, np.int32)
+
+    print(lock_index(locks, (0,)))
+    print(lock_index(locks, (1,)))
+    print(unlock_index(locks, (0,)))
+    print(lock_index(locks, (0,)))
+    print(unlock_index(locks, (1,)))