wren-common 0.0.0.dev0__tar.gz

wren_common-0.0.0.dev0/.gitignore

@@ -0,0 +1,177 @@
+# Sqlite database
+*.db
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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
+.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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+# PyPI configuration file
+.pypirc
+
+*.zip
+*.out

wren_common-0.0.0.dev0/PKG-INFO

@@ -0,0 +1,5 @@
+Metadata-Version: 2.4
+Name: wren-common
+Version: 0.0.0.dev0
+Summary: Common code for the PDE library
+Requires-Dist: numpy~=2.3

wren_common-0.0.0.dev0/pyproject.toml

@@ -0,0 +1,16 @@
+[project]
+name = "wren-common"
+description = "Common code for the PDE library"
+dependencies = ["numpy~=2.3"]
+dynamic = ["version"]
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"] 
+build-backend = "hatchling.build"
+
+[tool.hatch.version]
+source = "vcs"
+fallback-version = "0.0.0-dev"
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]

wren_common-0.0.0.dev0/src/wren_common/tests.py

@@ -0,0 +1,138 @@
+import math
+
+import numpy as np
+
+from wren_common.types import NDArray
+
+rng = np.random.default_rng(0)
+
+
+type TestTensor = NDArray[np.float64]
+type TestTensorPair = tuple[TestTensor, TestTensor]
+
+
+def arange_tensor(*shape: int) -> TestTensor:
+    """Create a tensor of given shape using np.arange."""
+    return np.arange(1, math.prod(shape) + 1, dtype=np.float64).reshape(shape)
+
+
+TEST_TENSORS: list[TestTensor] = [
+    tensor.astype(np.float64)
+    for tensor in [
+        # ---- 2D ----
+        arange_tensor(3, 3),
+        rng.random((5, 3)),
+        np.array([x % 2 == 0 for x in range(16)]).reshape(4, 4),
+        # ---- 3D ----
+        arange_tensor(4, 5, 5),
+        rng.normal(size=(3, 4, 6)),
+        # ---- 4D ----
+        arange_tensor(6, 5, 4, 3),
+        10e50 * np.ones((3, 4, 3, 5)),
+        # ---- 5D ----
+        arange_tensor(4, 3, 4, 5, 3),
+        -10e-5 * arange_tensor(4, 3, 4, 5, 3),
+        # ---- 6D ----
+        arange_tensor(4, 3, 4, 3, 3, 6),
+    ]
+]
+
+
+# NOTE: each pair of tensors must have the same shape
+TEST_PAIR_TENSORS: list[TestTensorPair] = [
+    (a.astype(np.float64), b.astype(np.float64))
+    for a, b in [
+        # ---- 2D ----
+        (
+            arange_tensor(3, 4),
+            rng.integers(0, 10, size=(3, 4)),
+        ),
+        # ---- 3D ----
+        (arange_tensor(2, 3, 4), np.ones((2, 3, 4))),
+        # ---- 4D ----
+        (
+            arange_tensor(2, 3, 4, 5),
+            rng.normal(size=(2, 3, 4, 5)),
+        ),
+        # ---- 5D ----
+        (
+            np.zeros((2, 2, 3, 4, 3)),
+            arange_tensor(2, 2, 3, 4, 3),
+        ),
+        # ---- 6D ----
+        (
+            arange_tensor(2, 3, 2, 3, 2, 4),
+            rng.integers(0, 5, size=(2, 3, 2, 3, 2, 4)),
+        ),
+        # ---- 7D ----
+        (
+            arange_tensor(2, 2, 3, 2, 4, 3, 2),
+            np.ones((2, 2, 3, 2, 4, 3, 2)),
+        ),
+        # ---- 8D ----
+        (
+            arange_tensor(2, 3, 2, 4, 2, 3, 2, 3),
+            rng.random((2, 3, 2, 4, 2, 3, 2, 3)),
+        ),
+    ]
+]
+
+for a, b in TEST_PAIR_TENSORS:
+    assert a.shape == b.shape
+    assert a.dtype == b.dtype
+
+
+SMALL_TEST_SCALARS: tuple[float, ...] = (1, -1, math.pi)
+TEST_SCALARS: tuple[float, ...] = (1, 2, 0.5, -1, 0, math.pi, -math.e, 1e30, -1e30)
+
+
+def tensor_interior[DType: np.number](
+    tensor: NDArray[DType], order: int = 1
+) -> NDArray[DType]:
+    """
+    Return the interior of a given tensor as a 1D array.
+
+    Parameters
+    ----------
+    tensor : NDArray
+        The tensor of which the interior is to be taken.
+    order : int, optional
+        The number of elements to be removed from each direction in each dimension.
+
+    Returns
+    -------
+    NDArray
+        The one dimensional array containing all the elements of the interior in the
+        input tensor.
+
+    """
+    mask = np.zeros_like(tensor, dtype=bool)
+    interior_slices = tuple(slice(order, -order) for _ in range(tensor.ndim))
+    mask[interior_slices] = True
+    return tensor[mask]
+
+
+def tensor_boundary[DType: np.number](
+    tensor: NDArray[DType], order: int = 1
+) -> NDArray[DType]:
+    """
+    Return the boundary of a given tensor as a 1D array.
+
+    Parameters
+    ----------
+    tensor : NDArray
+        The tensor of which the boundary is to be taken.
+    order : int, optional
+        The number of elements to be kept from each direction in each dimension.
+
+    Returns
+    -------
+    NDArray
+        The one dimensional array containing all the elements of boundary in the
+        input tensor.
+
+    """
+    mask = np.ones_like(tensor, dtype=bool)
+    interior_slices = tuple(slice(order, -order) for _ in range(tensor.ndim))
+    mask[interior_slices] = False
+    return tensor[mask]

wren_common-0.0.0.dev0/src/wren_common/types.py

@@ -0,0 +1,10 @@
+from typing import SupportsIndex
+
+import numpy as np
+
+type Vector[T: np.floating] = np.ndarray[tuple[int], np.dtype[T]]
+type Matrix[T: np.floating] = np.ndarray[tuple[int, int], np.dtype[T]]
+type NDArray[T: np.number] = np.ndarray[tuple[int, ...], np.dtype[T]]
+
+
+type Index1D = SupportsIndex | slice[SupportsIndex | None]