yut23-utils 0.1.0__tar.gz

yut23_utils-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,39 @@
+name: test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+concurrency:
+  group: test-${{ github.head_ref }}
+  cancel-in-progress: true
+
+env:
+  PYTHONUNBUFFERED: "1"
+  FORCE_COLOR: "1"
+
+jobs:
+  run:
+    name: Python ${{ matrix.python-version }} on ${{ startsWith(matrix.os, 'macos-') && 'macOS' || startsWith(matrix.os, 'windows-') && 'Windows' || 'Linux' }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+        python-version: ['3.9', '3.10', '3.11', '3.12']
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install Hatch
+        run: pip install --upgrade hatch
+
+      - name: Run tests
+        run: hatch run cov

yut23_utils-0.1.0/.gitignore

@@ -0,0 +1,160 @@
+# 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
+
+# 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/#use-with-ide
+.pdm.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
+
+# 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/

yut23_utils-0.1.0/LICENSE.txt

@@ -0,0 +1,11 @@
+Copyright (c) 2023-present Eric T. Johnson. 
+
+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.

yut23_utils-0.1.0/PKG-INFO

@@ -0,0 +1,42 @@
+Metadata-Version: 2.1
+Name: yut23-utils
+Version: 0.1.0
+Summary: Common code I find myself reaching for from multiple different repositories.
+Project-URL: Documentation, https://github.com/yut23/yut23-utils#readme
+Project-URL: Issues, https://github.com/yut23/yut23-utils/issues
+Project-URL: Source, https://github.com/yut23/yut23-utils
+Author-email: yut23 <yut23@gvljohnsons.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE.txt
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# yut23_utils
+
+[![PyPI - Version](https://img.shields.io/pypi/v/yut23-utils.svg)](https://pypi.org/project/yut23-utils)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/yut23-utils.svg)](https://pypi.org/project/yut23-utils)
+
+-----
+
+**Table of Contents**
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+```console
+pip install yut23-utils
+```
+
+## License
+
+`yut23-utils` is distributed under the terms of the [BSD-3-Clause](https://spdx.org/licenses/BSD-3-Clause.html) license.

yut23_utils-0.1.0/README.md

@@ -0,0 +1,21 @@
+# yut23_utils
+
+[![PyPI - Version](https://img.shields.io/pypi/v/yut23-utils.svg)](https://pypi.org/project/yut23-utils)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/yut23-utils.svg)](https://pypi.org/project/yut23-utils)
+
+-----
+
+**Table of Contents**
+
+- [Installation](#installation)
+- [License](#license)
+
+## Installation
+
+```console
+pip install yut23-utils
+```
+
+## License
+
+`yut23-utils` is distributed under the terms of the [BSD-3-Clause](https://spdx.org/licenses/BSD-3-Clause.html) license.

yut23_utils-0.1.0/pyproject.toml

@@ -0,0 +1,103 @@
+[build-system]
+requires = ["hatchling", "hatch-regex-commit"]
+build-backend = "hatchling.build"
+
+[project]
+name = "yut23-utils"
+dynamic = ["version"]
+description = 'Common code I find myself reaching for from multiple different repositories.'
+readme = "README.md"
+requires-python = ">=3.9"
+license = "BSD-3-Clause"
+keywords = []
+authors = [
+  { name = "yut23", email = "yut23@gvljohnsons.com" },
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Programming Language :: Python",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+]
+dependencies = []
+
+[project.urls]
+Documentation = "https://github.com/yut23/yut23-utils#readme"
+Issues = "https://github.com/yut23/yut23-utils/issues"
+Source = "https://github.com/yut23/yut23-utils"
+
+[tool.hatch.version]
+source = "regex_commit"
+path = "src/yut23_utils/__about__.py"
+tag_sign = false
+
+[tool.hatch.envs.default]
+dependencies = [
+  "coverage[toml]>=6.5",
+  "pytest",
+  "hypothesis",
+]
+[tool.hatch.envs.default.scripts]
+test = "pytest {args:tests}"
+test-cov = "coverage run -m pytest {args:tests}"
+cov-report = [
+  "- coverage combine",
+  "coverage report",
+]
+cov = [
+  "test-cov",
+  "cov-report",
+]
+
+[[tool.hatch.envs.all.matrix]]
+python = ["3.9", "3.10", "3.11", "3.12"]
+
+[tool.hatch.envs.types]
+dependencies = [
+  "mypy>=1.0.0",
+]
+[tool.hatch.envs.types.scripts]
+check = "mypy --install-types --non-interactive {args:src/yut23_utils tests}"
+
+[tool.isort]
+known_first_party = ["yut23_utils"]
+
+[tool.black]
+target-version = ["py39"]
+line-length = 88
+skip-string-normalization = false
+
+[tool.ruff]
+target-version = "py39"
+line-length = 88
+extend = "ruff_defaults.toml"
+
+[tool.hatch.envs.hatch-static-analysis]
+config-path = "ruff_defaults.toml"
+
+[tool.ruff.lint.extend-per-file-ignores]
+# we expect unused imports in __init__.py, as it shouldn't have anything else
+"__init__.py" = ["F401"]
+
+[tool.coverage.run]
+source_pkgs = ["yut23_utils", "tests"]
+branch = true
+parallel = true
+omit = [
+  "src/yut23_utils/__about__.py",
+]
+
+[tool.coverage.paths]
+yut23_utils = ["src/yut23_utils", "*/yut23-utils/src/yut23_utils"]
+tests = ["tests", "*/yut23-utils/tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+  "no cov",
+  "if __name__ == .__main__.:",
+  "if TYPE_CHECKING:",
+]

yut23_utils-0.1.0/ruff_defaults.toml

@@ -0,0 +1,534 @@
+line-length = 120
+
+[format]
+docstring-code-format = true
+docstring-code-line-length = 80
+
+[lint]
+select = [
+  "A001",
+  "A002",
+  "A003",
+  "ARG001",
+  "ARG002",
+  "ARG003",
+  "ARG004",
+  "ARG005",
+  "ASYNC100",
+  "ASYNC101",
+  "ASYNC102",
+  "B002",
+  "B003",
+  "B004",
+  "B005",
+  "B006",
+  "B007",
+  "B008",
+  "B009",
+  "B010",
+  "B011",
+  "B012",
+  "B013",
+  "B014",
+  "B015",
+  "B016",
+  "B017",
+  "B018",
+  "B019",
+  "B020",
+  "B021",
+  "B022",
+  "B023",
+  "B024",
+  "B025",
+  "B026",
+  "B028",
+  "B029",
+  "B030",
+  "B031",
+  "B032",
+  "B033",
+  "B034",
+  "B904",
+  "B905",
+  "BLE001",
+  "C400",
+  "C401",
+  "C402",
+  "C403",
+  "C404",
+  "C405",
+  "C406",
+  "C408",
+  "C409",
+  "C410",
+  "C411",
+  "C413",
+  "C414",
+  "C415",
+  "C416",
+  "C417",
+  "C418",
+  "C419",
+  "COM818",
+  "DTZ001",
+  "DTZ002",
+  "DTZ003",
+  "DTZ004",
+  "DTZ005",
+  "DTZ006",
+  "DTZ007",
+  "DTZ011",
+  "DTZ012",
+  "E101",
+  "E401",
+  "E402",
+  "E501",
+  "E701",
+  "E702",
+  "E703",
+  "E711",
+  "E712",
+  "E713",
+  "E714",
+  "E721",
+  "E722",
+  "E731",
+  "E741",
+  "E742",
+  "E743",
+  "E902",
+  "E999",
+  "EM101",
+  "EM102",
+  "EM103",
+  "EXE001",
+  "EXE002",
+  "EXE003",
+  "EXE004",
+  "EXE005",
+  "F401",
+  "F402",
+  "F403",
+  "F404",
+  "F405",
+  "F406",
+  "F407",
+  "F501",
+  "F502",
+  "F503",
+  "F504",
+  "F505",
+  "F506",
+  "F507",
+  "F508",
+  "F509",
+  "F521",
+  "F522",
+  "F523",
+  "F524",
+  "F525",
+  "F541",
+  "F601",
+  "F602",
+  "F621",
+  "F622",
+  "F631",
+  "F632",
+  "F633",
+  "F634",
+  "F701",
+  "F702",
+  "F704",
+  "F706",
+  "F707",
+  "F722",
+  "F811",
+  "F821",
+  "F822",
+  "F823",
+  "F841",
+  "F842",
+  "F901",
+  "FA100",
+  "FA102",
+  "FBT001",
+  "FBT002",
+  "FLY002",
+  "G001",
+  "G002",
+  "G003",
+  "G004",
+  "G010",
+  "G101",
+  "G201",
+  "G202",
+  "I001",
+  "I002",
+  "ICN001",
+  "ICN002",
+  "ICN003",
+  "INP001",
+  "INT001",
+  "INT002",
+  "INT003",
+  "ISC003",
+  "N801",
+  "N802",
+  "N803",
+  "N804",
+  "N805",
+  "N806",
+  "N807",
+  "N811",
+  "N812",
+  "N813",
+  "N814",
+  "N815",
+  "N816",
+  "N817",
+  "N818",
+  "N999",
+  "PERF101",
+  "PERF102",
+  "PERF401",
+  "PERF402",
+  "PGH001",
+  "PGH002",
+  "PGH005",
+  "PIE790",
+  "PIE794",
+  "PIE796",
+  "PIE800",
+  "PIE804",
+  "PIE807",
+  "PIE808",
+  "PIE810",
+  "PLC0105",
+  "PLC0131",
+  "PLC0132",
+  "PLC0205",
+  "PLC0208",
+  "PLC0414",
+  "PLC3002",
+  "PLE0100",
+  "PLE0101",
+  "PLE0116",
+  "PLE0117",
+  "PLE0118",
+  "PLE0241",
+  "PLE0302",
+  "PLE0307",
+  "PLE0604",
+  "PLE0605",
+  "PLE1142",
+  "PLE1205",
+  "PLE1206",
+  "PLE1300",
+  "PLE1307",
+  "PLE1310",
+  "PLE1507",
+  "PLE1700",
+  "PLE2502",
+  "PLE2510",
+  "PLE2512",
+  "PLE2513",
+  "PLE2514",
+  "PLE2515",
+  "PLR0124",
+  "PLR0133",
+  "PLR0206",
+  "PLR0402",
+  "PLR1701",
+  "PLR1711",
+  "PLR1714",
+  "PLR1722",
+  "PLR2004",
+  "PLR5501",
+  "PLW0120",
+  "PLW0127",
+  "PLW0129",
+  "PLW0131",
+  "PLW0406",
+  "PLW0602",
+  "PLW0603",
+  "PLW0711",
+  "PLW1508",
+  "PLW1509",
+  "PLW1510",
+  "PLW2901",
+  "PLW3301",
+  "PT001",
+  "PT002",
+  "PT003",
+  "PT006",
+  "PT007",
+  "PT008",
+  "PT009",
+  "PT010",
+  "PT011",
+  "PT012",
+  "PT013",
+  "PT014",
+  "PT015",
+  "PT016",
+  "PT017",
+  "PT018",
+  "PT019",
+  "PT020",
+  "PT021",
+  "PT022",
+  "PT023",
+  "PT024",
+  "PT025",
+  "PT026",
+  "PT027",
+  "PYI001",
+  "PYI002",
+  "PYI003",
+  "PYI004",
+  "PYI005",
+  "PYI006",
+  "PYI007",
+  "PYI008",
+  "PYI009",
+  "PYI010",
+  "PYI011",
+  "PYI012",
+  "PYI013",
+  "PYI014",
+  "PYI015",
+  "PYI016",
+  "PYI017",
+  "PYI018",
+  "PYI019",
+  "PYI020",
+  "PYI021",
+  "PYI024",
+  "PYI025",
+  "PYI026",
+  "PYI029",
+  "PYI030",
+  "PYI032",
+  "PYI033",
+  "PYI034",
+  "PYI035",
+  "PYI036",
+  "PYI041",
+  "PYI042",
+  "PYI043",
+  "PYI044",
+  "PYI045",
+  "PYI046",
+  "PYI047",
+  "PYI048",
+  "PYI049",
+  "PYI050",
+  "PYI051",
+  "PYI052",
+  "PYI053",
+  "PYI054",
+  "PYI055",
+  "PYI056",
+  "RET503",
+  "RET504",
+  "RET505",
+  "RET506",
+  "RET507",
+  "RET508",
+  "RSE102",
+  "RUF001",
+  "RUF002",
+  "RUF003",
+  "RUF005",
+  "RUF006",
+  "RUF007",
+  "RUF008",
+  "RUF009",
+  "RUF010",
+  "RUF011",
+  "RUF012",
+  "RUF013",
+  "RUF015",
+  "RUF016",
+  "RUF100",
+  "RUF200",
+  "S101",
+  "S102",
+  "S103",
+  "S104",
+  "S105",
+  "S106",
+  "S107",
+  "S108",
+  "S110",
+  "S112",
+  "S113",
+  "S301",
+  "S302",
+  "S303",
+  "S304",
+  "S305",
+  "S306",
+  "S307",
+  "S308",
+  "S310",
+  "S311",
+  "S312",
+  "S313",
+  "S314",
+  "S315",
+  "S316",
+  "S317",
+  "S318",
+  "S319",
+  "S320",
+  "S321",
+  "S323",
+  "S324",
+  "S501",
+  "S506",
+  "S508",
+  "S509",
+  "S601",
+  "S602",
+  "S604",
+  "S605",
+  "S606",
+  "S607",
+  "S608",
+  "S609",
+  "S612",
+  "S701",
+  "SIM101",
+  "SIM102",
+  "SIM103",
+  "SIM105",
+  "SIM107",
+  "SIM108",
+  "SIM109",
+  "SIM110",
+  "SIM112",
+  "SIM114",
+  "SIM115",
+  "SIM116",
+  "SIM117",
+  "SIM118",
+  "SIM201",
+  "SIM202",
+  "SIM208",
+  "SIM210",
+  "SIM211",
+  "SIM212",
+  "SIM220",
+  "SIM221",
+  "SIM222",
+  "SIM223",
+  "SIM300",
+  "SIM910",
+  "SLF001",
+  "SLOT000",
+  "SLOT001",
+  "SLOT002",
+  "T100",
+  "T201",
+  "T203",
+  "TCH001",
+  "TCH002",
+  "TCH003",
+  "TCH004",
+  "TCH005",
+  "TD004",
+  "TD005",
+  "TD006",
+  "TD007",
+  "TID251",
+  "TID252",
+  "TID253",
+  "TRY002",
+  "TRY003",
+  "TRY004",
+  "TRY200",
+  "TRY201",
+  "TRY300",
+  "TRY301",
+  "TRY302",
+  "TRY400",
+  "TRY401",
+  "UP001",
+  "UP003",
+  "UP004",
+  "UP005",
+  "UP006",
+  "UP007",
+  "UP008",
+  "UP009",
+  "UP010",
+  "UP011",
+  "UP012",
+  "UP013",
+  "UP014",
+  "UP015",
+  "UP017",
+  "UP018",
+  "UP019",
+  "UP020",
+  "UP021",
+  "UP022",
+  "UP023",
+  "UP024",
+  "UP025",
+  "UP026",
+  "UP027",
+  "UP028",
+  "UP029",
+  "UP030",
+  "UP031",
+  "UP032",
+  "UP033",
+  "UP034",
+  "UP035",
+  "UP036",
+  "UP037",
+  "UP038",
+  "UP039",
+  "UP040",
+  "W291",
+  "W292",
+  "W293",
+  "W505",
+  "W605",
+  "YTT101",
+  "YTT102",
+  "YTT103",
+  "YTT201",
+  "YTT202",
+  "YTT203",
+  "YTT204",
+  "YTT301",
+  "YTT302",
+  "YTT303",
+]
+
+[lint.per-file-ignores]
+"**/scripts/*" = [
+  "INP001",
+  "T201",
+]
+"**/tests/**/*" = [
+  "PLC1901",
+  "PLR2004",
+  "PLR6301",
+  "S",
+  "TID252",
+]
+
+[lint.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+[lint.isort]
+known-first-party = ["yut23_utils"]
+
+[lint.flake8-pytest-style]
+fixture-parentheses = false
+mark-parentheses = false

yut23_utils-0.1.0/src/yut23_utils/__about__.py

@@ -0,0 +1,4 @@
+# SPDX-FileCopyrightText: 2023-present Eric T. Johnson
+#
+# SPDX-License-Identifier: BSD-3-Clause
+__version__ = "0.1.0"

yut23_utils-0.1.0/src/yut23_utils/__init__.py

@@ -0,0 +1,5 @@
+# SPDX-FileCopyrightText: 2023-present Eric T. Johnson
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+from yut23_utils.fp import FloatInspector, compare_ulp, ulp_diff

yut23_utils-0.1.0/src/yut23_utils/fp.py

@@ -0,0 +1,107 @@
+# SPDX-FileCopyrightText: 2023-present Eric T. Johnson
+#
+# SPDX-License-Identifier: BSD-3-Clause
+"""Tools for working with floating-point numbers."""
+
+import math
+import struct
+from dataclasses import dataclass, field
+from functools import cached_property
+from typing import cast
+
+
+def float_to_int(x: float, /) -> int:
+    return cast(int, struct.unpack("<Q", struct.pack("<d", x))[0])
+
+
+def int_to_float(q: int, /) -> float:
+    return cast(float, struct.unpack("<d", struct.pack("<Q", q))[0])
+
+
+def ulp_diff(a: float, b: float) -> int:
+    """Return the (signed) number of representable FP64 values in the range [a, b)."""
+    if not math.isfinite(a) or not math.isfinite(b):
+        raise ValueError("only finite values can be compared")
+    if a == b:
+        return 0
+    if a > b:
+        # pylint: disable-next=arguments-out-of-order
+        return -ulp_diff(b, a)
+    if math.copysign(1.0, a) != math.copysign(1.0, b):
+        # different signs: split the interval at zero
+        return ulp_diff(a, -0.0) + ulp_diff(0.0, b)
+    return abs(float_to_int(a) - float_to_int(b))
+
+
+def compare_ulp(a: float, b: float, /, ulps: int) -> bool:
+    """Check if two numbers match to within a specified number of FP64 ULPs."""
+    if ulps < 0:
+        raise ValueError("ulps must be non-negative")
+    return abs(ulp_diff(a, b)) <= ulps
+
+
+@dataclass(frozen=True)
+class FloatInspector:
+    float_val: float
+    int_val: int = field(init=False)
+
+    SIGN_MASK = 0x8000000000000000
+    EXP_MASK = 0x7FF0000000000000
+    MANT_MASK = 0x000FFFFFFFFFFFFF
+
+    def __post_init__(self):
+        object.__setattr__(self, "int_val", float_to_int(self.float_val))
+
+    @cached_property
+    def raw_sign(self) -> int:
+        return (self.int_val & self.SIGN_MASK) >> 63
+
+    @cached_property
+    def raw_exponent(self) -> int:
+        return (self.int_val & self.EXP_MASK) >> 52
+
+    @cached_property
+    def raw_mantissa(self) -> int:
+        return self.int_val & self.MANT_MASK
+
+    def __str__(self) -> str:
+        return (
+            f"FloatData({float(self)} = "
+            f"{self.raw_sign} * 2^{self.exponent} * {self.mantissa}; "
+            f"s={self.raw_sign}, e={self.raw_exponent:011b}, m={self.raw_mantissa:052b})"
+        )
+
+    def __repr__(self) -> str:
+        f = float(self)
+        return f"FloatData({f}; {f.hex()})"
+
+    def __float__(self) -> float:
+        return self.float_val
+
+    @cached_property
+    def exponent(self) -> int:
+        return self.raw_exponent - 1023
+
+    @cached_property
+    def mantissa(self) -> float:
+        frac = self.raw_mantissa / (1 << 52)
+        if self.raw_exponent == 0:
+            # zero and subnormals
+            frac *= 2
+        else:
+            frac += 1
+        if self.raw_sign == 1:
+            frac *= -1
+        return frac
+
+    def is_negative(self) -> bool:
+        return bool(self.raw_sign)
+
+    def is_inf(self) -> bool:
+        return self.raw_exponent == 0x7FF and self.raw_mantissa == 0
+
+    def is_nan(self) -> bool:
+        return self.raw_exponent == 0x7FF and self.raw_mantissa != 0
+
+    def is_subnormal(self) -> bool:
+        return self.raw_exponent == 0 and self.raw_mantissa != 0

yut23_utils-0.1.0/tests/__init__.py

@@ -0,0 +1,3 @@
+# SPDX-FileCopyrightText: 2023-present Eric T. Johnson
+#
+# SPDX-License-Identifier: BSD-3-Clause

yut23_utils-0.1.0/tests/test_fp.py

@@ -0,0 +1,117 @@
+# SPDX-FileCopyrightText: 2023-present Eric T. Johnson
+#
+# SPDX-License-Identifier: BSD-3-Clause
+
+import math
+import sys
+
+import pytest
+from hypothesis import assume, example, given, note
+from hypothesis import strategies as st
+
+from yut23_utils.fp import (
+    FloatInspector,
+    compare_ulp,
+    float_to_int,
+    int_to_float,
+    ulp_diff,
+)
+
+
+@given(st.floats())
+def test_float_to_int(x_flt: float) -> None:
+    x_int = float_to_int(x_flt)
+    assert isinstance(x_int, int)
+    assert 0 <= x_int < 1 << 64
+    x_flt_2 = int_to_float(x_int)
+    if math.isnan(x_flt):
+        assert math.isnan(x_flt_2)
+    else:
+        assert x_flt_2 == x_flt
+
+
+@given(st.integers(min_value=0, max_value=(1 << 64) - 1))
+def test_int_to_float(x_int: int) -> None:
+    x_flt = int_to_float(x_int)
+    assert float_to_int(x_flt) == x_int
+
+
+@st.composite
+def float_pairs(draw: st.DrawFn, max_ulps: int) -> tuple[float, float, int]:
+    a = draw(st.floats(allow_nan=False, allow_infinity=False))
+    ulps = draw(st.integers(min_value=-max_ulps, max_value=max_ulps))
+
+    b = a
+    direction = math.copysign(math.inf, ulps)
+    for _ in range(abs(ulps)):
+        b = math.nextafter(b, direction)
+        assume(not math.isinf(b))
+
+    note(f"a = {FloatInspector(a)}\nb = {FloatInspector(b)}")
+    return a, b, ulps
+
+
+@given(float_pairs(max_ulps=100))
+@example((0.0, -5e-324, -1))
+@example((5e-324, 0.0, -1))
+@example((5e-324, -0.0, -1))
+@example((-5e-324, 5e-324, 2))
+def test_ulp_diff(args: tuple[float, float, int]) -> None:
+    a, b, ulps = args
+    assert ulp_diff(a, b) == ulps
+
+
+@pytest.mark.parametrize(
+    "a,b",
+    [
+        (math.inf, 3.14),
+        (math.inf, math.inf),
+        (-math.inf, math.inf),
+        (math.nan, -2.718),
+        (math.nan, math.nan),
+    ],
+)
+def test_ulp_diff_errors(a: float, b: float) -> None:
+    with pytest.raises(ValueError):
+        ulp_diff(a, b)
+    with pytest.raises(ValueError):
+        ulp_diff(b, a)
+
+
+@given(float_pairs(max_ulps=100))
+@example((-5e-324, 5e-324, 2))
+def test_compare_ulp(args: tuple[float, float, int]) -> None:
+    a, b, ulps = args
+    assert compare_ulp(a, b, abs(ulps))
+    if abs(ulps) > 0:
+        assert not compare_ulp(a, b, abs(ulps) - 1)
+    assert compare_ulp(a, b, abs(ulps) + 1)
+
+
+def test_compare_ulp_errors() -> None:
+    with pytest.raises(ValueError):
+        compare_ulp(1.0, 1.0, -1)
+
+
+@given(st.floats())
+def test_FloatInspector(x: float) -> None:
+    fi = FloatInspector(x)
+    note(f"fi={fi} (subnormal: {fi.is_subnormal()})")
+    if not math.isnan(x):
+        assert float(fi) == x
+    # convert to an int to check raw NaN representation
+    assert float_to_int(float(fi)) == float_to_int(x)
+
+    # try manually reconstructing the value from the mantissa and exponent
+    if math.isfinite(x):
+        reconstructed = math.ldexp(fi.mantissa, fi.exponent)
+        assert reconstructed == x
+
+    # check interrogator methods
+    # need to use copysign rather than `x < 0.0` to handle -0.0 properly
+    is_negative = math.copysign(1.0, x) == -1.0
+    assert fi.is_negative() == is_negative
+    assert fi.is_inf() == math.isinf(x)
+    assert fi.is_nan() == math.isnan(x)
+    is_subnormal = 0 < abs(x) < sys.float_info.min
+    assert fi.is_subnormal() == is_subnormal