gregs-rng 0.1.4__tar.gz

gregs_rng-0.1.4/.github/workflows/pypi.yml

@@ -0,0 +1,56 @@
+# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+name: Publish to PyPI
+
+on:
+  workflow_dispatch:
+  push:
+    tags:
+      - "v*" 
+
+permissions:
+  contents: read
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10.12"
+
+      - name: Build release distributions
+        run: |
+          python -m pip install build setuptools-scm
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      id-token: write
+
+    environment:
+      name: testpypi
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/

gregs_rng-0.1.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gregs_rng-0.1.4/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: gregs_rng
+Version: 0.1.4
+Summary: Contains implementations of Random Number Generators
+Author: Greg Dorshimer
+Project-URL: Homepage, https://github.com/gregdorshimer/gregs_rng
+Project-URL: Issues, https://github.com/gregdorshimer/gregs_rng/issues
+Keywords: random,rng,statistics,linear congruential generator
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# gregs_rng
+
+A package for generating random numbers using various methods. The current version only supports the Linear Congruential Method.
+
+Linear Congruential Generator:
+
+Thompson, W. E. (1958). A Modified Congruence Method of Generating Pseudo-Random Numbers. The Computer Journal, 1(2), 83–88.
+https://academic.oup.com/comjnl/article-abstract/1/2/83/425243
+Rotenberg, A. (1960). A New Pseudo-Random Number Generator. Journal of the ACM, 7(1), 75–77.
+https://dl.acm.org/doi/10.1145/321008.321019
+https://en.wikipedia.org/wiki/Linear_congruential_generator
+
+
+Choice of parameters for LCG:
+
+Donald E. Knuth (1981). The Art of Computer Programming, Volume 2: Seminumerical Algorithms (2nd ed.). Addison-Wesley.
+https://en.wikipedia.org/wiki/The_Art_of_Computer_Programming
+
+Press, W. H., Teukolsky, S. A., Vetterling, W. T., & Flannery, B. P. Numerical Recipes in C: The Art of Scientific Computing, 2nd ed., Cambridge University Press, 1992.
+https://en.wikipedia.org/wiki/Numerical_Recipes 
+
+
+Install:
+
+```bash
+pip install gregs_rng
+```
+
+Import and Use:
+
+```python
+from gregs_rng import lcg
+
+g = lcg(42)
+print(next(g))
+print(next(g))
+```

gregs_rng-0.1.4/README.md

@@ -0,0 +1,37 @@
+# gregs_rng
+
+A package for generating random numbers using various methods. The current version only supports the Linear Congruential Method.
+
+Linear Congruential Generator:
+
+Thompson, W. E. (1958). A Modified Congruence Method of Generating Pseudo-Random Numbers. The Computer Journal, 1(2), 83–88.
+https://academic.oup.com/comjnl/article-abstract/1/2/83/425243
+Rotenberg, A. (1960). A New Pseudo-Random Number Generator. Journal of the ACM, 7(1), 75–77.
+https://dl.acm.org/doi/10.1145/321008.321019
+https://en.wikipedia.org/wiki/Linear_congruential_generator
+
+
+Choice of parameters for LCG:
+
+Donald E. Knuth (1981). The Art of Computer Programming, Volume 2: Seminumerical Algorithms (2nd ed.). Addison-Wesley.
+https://en.wikipedia.org/wiki/The_Art_of_Computer_Programming
+
+Press, W. H., Teukolsky, S. A., Vetterling, W. T., & Flannery, B. P. Numerical Recipes in C: The Art of Scientific Computing, 2nd ed., Cambridge University Press, 1992.
+https://en.wikipedia.org/wiki/Numerical_Recipes 
+
+
+Install:
+
+```bash
+pip install gregs_rng
+```
+
+Import and Use:
+
+```python
+from gregs_rng import lcg
+
+g = lcg(42)
+print(next(g))
+print(next(g))
+```

gregs_rng-0.1.4/pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["setuptools>=64.0", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+
+[project]
+# Name used to install with pip:
+name = "gregs_rng"
+
+# Current version of this package pulled from git tag by setuptools-scm:
+dynamic = ["version"]
+
+# Description published on PyPI:
+description = "Contains implementations of Random Number Generators"
+
+readme = "README.md"
+
+requires-python = ">=3.10.12"
+
+authors = [
+    {name = "Greg Dorshimer"}
+]
+
+# Keywords for help finding the package:
+keywords = ["random", "rng", "statistics", "linear congruential generator"]
+
+# PyPI Classifiers describing the package:
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent"
+]
+
+[project.urls]
+Homepage = "https://github.com/gregdorshimer/gregs_rng"
+Issues = "https://github.com/gregdorshimer/gregs_rng/issues"
+
+
+[tool.setuptools.packages.find]
+# define /src/ as the root of importable packages
+where = ["src"]
+
+
+[tool.setuptools_scm]

gregs_rng-0.1.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

gregs_rng-0.1.4/src/gregs_rng/__init__.py

@@ -0,0 +1,11 @@
+from .rng import lcg
+"""
+the above allows importing directly using:
+
+from gregs_rng import lcg
+
+as opposed to:
+
+from gregs_rng.rng import lcg
+
+"""

gregs_rng-0.1.4/src/gregs_rng/rng.py

@@ -0,0 +1,29 @@
+from collections.abc import Generator
+
+# lcg is a Generator that yields `int`, receives `None` from .send(), and returns `None` when it finishes
+# `seed` is required
+# `lcg` returns uniform random variates [0,1]
+def lcg(seed: int, a: int = 1664525, c: int = 1013904223, m: int = 2**32) -> Generator[float, None, None]:
+    # enforce non-negative `seed`
+    if not isinstance(seed, int) or seed < 0:
+        raise ValueError('Bad inputs to `lcg`: `seed` must be non-negative.')
+
+    # enforce positive `a`, 
+    if not isinstance(a, int) or a < 1:
+        raise ValueError('Bad inputs to `lcg`: `a` must be positive.')
+
+    # enforce non-negative `c`, 
+    if not isinstance(c, int) or c < 0:
+        raise ValueError('Bad inputs to `lcg`: `c` must be non-negative.')
+
+    # enforce `m` greater than 1, 
+    if not isinstance(m, int) or m < 2:
+        raise ValueError('Bad inputs to `lcg`: `m` must be greater than 1.')
+
+    while True:
+        seed = (a * seed + c) % m
+        yield seed / m
+
+g = lcg(seed = 144386231)
+for i in range(50):
+    print(next(g))

gregs_rng-0.1.4/src/gregs_rng.egg-info/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.4
+Name: gregs_rng
+Version: 0.1.4
+Summary: Contains implementations of Random Number Generators
+Author: Greg Dorshimer
+Project-URL: Homepage, https://github.com/gregdorshimer/gregs_rng
+Project-URL: Issues, https://github.com/gregdorshimer/gregs_rng/issues
+Keywords: random,rng,statistics,linear congruential generator
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# gregs_rng
+
+A package for generating random numbers using various methods. The current version only supports the Linear Congruential Method.
+
+Linear Congruential Generator:
+
+Thompson, W. E. (1958). A Modified Congruence Method of Generating Pseudo-Random Numbers. The Computer Journal, 1(2), 83–88.
+https://academic.oup.com/comjnl/article-abstract/1/2/83/425243
+Rotenberg, A. (1960). A New Pseudo-Random Number Generator. Journal of the ACM, 7(1), 75–77.
+https://dl.acm.org/doi/10.1145/321008.321019
+https://en.wikipedia.org/wiki/Linear_congruential_generator
+
+
+Choice of parameters for LCG:
+
+Donald E. Knuth (1981). The Art of Computer Programming, Volume 2: Seminumerical Algorithms (2nd ed.). Addison-Wesley.
+https://en.wikipedia.org/wiki/The_Art_of_Computer_Programming
+
+Press, W. H., Teukolsky, S. A., Vetterling, W. T., & Flannery, B. P. Numerical Recipes in C: The Art of Scientific Computing, 2nd ed., Cambridge University Press, 1992.
+https://en.wikipedia.org/wiki/Numerical_Recipes 
+
+
+Install:
+
+```bash
+pip install gregs_rng
+```
+
+Import and Use:
+
+```python
+from gregs_rng import lcg
+
+g = lcg(42)
+print(next(g))
+print(next(g))
+```

gregs_rng-0.1.4/src/gregs_rng.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+.github/workflows/pypi.yml
+src/gregs_rng/__init__.py
+src/gregs_rng/rng.py
+src/gregs_rng.egg-info/PKG-INFO
+src/gregs_rng.egg-info/SOURCES.txt
+src/gregs_rng.egg-info/dependency_links.txt
+src/gregs_rng.egg-info/top_level.txt

gregs_rng-0.1.4/src/gregs_rng.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

gregs_rng-0.1.4/src/gregs_rng.egg-info/top_level.txt

@@ -0,0 +1 @@
+gregs_rng