quadint 0.0.8__cp313-cp313-win32.whl

quadint-0.0.8.dist-info/METADATA

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: quadint
+Version: 0.0.8
+Summary: A quadint class, for using quadratic integers.
+Author-email: Ryan Heard <ryanwheard@gmail.com>
+License: MIT
+Project-URL: Repository, https://github.com/rheard/quadint
+Keywords: complex,math,eisenstein
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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 :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license
+Dynamic: license-file
+
+# quadint
+
+Fast, integer-backed algebraic number types for **exact** arithmetic in imaginary quadratic integer rings.
+
+- **`complexint`**: a Gaussian integer type that mirrors Python’s `complex`, but stores **`int`** components (no floating-point drift).
+- **`QuadInt` / `QuadraticRing`**: a general quadratic-integer implementation for elements of the form  
+  $(a + b\sqrt{D}) / \mathrm{den}$ with $den ∈ {1,2}$.
+- **`eisensteinint`**: Eisenstein integers in the ω-basis (`a + bω`, where `ω = (-1 + √-3)/2`).
+
+Designed for discrete math, number theory tooling, and high-throughput exact computations (this project is built to compile cleanly with **mypyc**).
+
+---
+
+## Installation
+
+```bash
+python -m pip install quadint
+```
+
+---
+
+## Quickstart (recommended): `complexint`
+
+```python
+from quadint import complexint
+
+a = complexint(1, 2)
+b = complexint(3, 6)
+
+c = a * b
+print(c)          # "(-9+12j)"  (exact, integer-backed)
+print(c.real)     # -9
+print(c.imag)     # 12
+print(type(c.real))  # <class 'int'>
+
+print(abs(a))     # 1^2 + 2^2 = 5  (norm)
+```
+
+`complexint` is ideal when you want something that *feels like* `complex`, but with infinite-precision integer components.
+
+---
+
+## Quadratic integers: `make_quadint`
+
+Create a ring instance for a chosen discriminant parameter `D`, then construct values in that ring:
+
+```python
+from quadint import make_quadint
+
+Q2 = make_quadint(-2)  # Z[√-2]
+
+x = Q2(1, 2)           # (1 + 2*sqrt(-2))
+y = Q2(3, 6)
+
+print(x * y)           # "(-21+12*sqrt(-2))"
+print(abs(x))          # norm: 1^2 - (-2)*2^2 = 9
+```
+
+Common operations include `+`, `-`, `*`, `**` (non-negative powers), `conjugate()`, and `abs()` (the norm).
+
+---
+
+## Eisenstein integers: `eisensteinint`
+
+```python
+from quadint import eisensteinint
+
+z = eisensteinint(2, 3)   # 2 + 3ω
+w = eisensteinint(1, -1)  # 1 - ω
+
+print(z)
+print(z * w)              # exact product in Z[ω]
+print(abs(z))             # norm (integer)
+```
+
+Use `real` and `omega` to access the ω-basis components.
+
+---
+
+## Division & interoperability notes
+
+* This package is primarily intended for **exact, discrete** arithmetic (`+`, `-`, `*`, `**`, conjugation, norms).
+* Some division helpers exist (e.g. `divmod`, `//`, `%`) for **imaginary** quadratic rings, using a nearest-lattice approach; it may be `NotImplemented` for `D ≥ 0`, and behavior depends on the ring being Euclidean enough for your use case.
+* **Floats and Python `complex` are accepted in some operations but are converted via `int(...)`, which truncates toward zero. If you care about rationals, avoid mixing in `float`.
+
+Example of truncation behavior:
+
+```python
+from quadint import complexint
+
+a = complexint(3, 6)
+
+print(a / 3)     # "(1+2j)"
+print(a / 3.5)   # "(1+2j)"  (3.5 -> 3 by int(...) conversion)
+
+print(a + 1)     # "(4+6j)"
+print(a + 1.5)   # "(4+6j)"  (1.5 -> 1)
+```
+
+---
+
+## Minimal API overview
+
+### Constructors
+
+* `complexint(a: int = 0, b: int = 0)`
+* `eisensteinint(a: int = 0, b: int = 0)` where `a + bω`
+* `make_quadint(D: int) -> QuadraticRing`
+
+### Ring instance (`QuadraticRing`)
+
+* `Q(a: int = 0, b: int = 0) -> QuadInt` (constructs using the ring’s internal basis)
+* `Q.from_ab(a: int, b: int) -> QuadInt` (construct with user coords, respecting `den`)
+* `Q.from_obj(x) -> QuadInt` (embed `int`/`float`, and `complex` only when `D == -1`)
+
+### Value type (`QuadInt`)
+
+* `x.conjugate()`
+* `abs(x)` (norm)
+* `divmod(x, y)`, `x // y`, `x % y` (where supported)
+* Iteration/indexing over the stored coefficients: `list(x)`, `x[0]`, `x[1]`

quadint-0.0.8.dist-info/RECORD

@@ -0,0 +1,14 @@
+9c46a97409a639359bbf__mypyc.cp313-win32.pyd,sha256=6Gf-zhe0rn6kQW91hYvm8A9YMAHjY_rlU8uncwGwAI0,95232
+quadint/__init__.cp313-win32.pyd,sha256=7Bhti46HqHCLmrrksB5wXNPCJ_QGzR7TxtGt6tEHSOU,9216
+quadint/complex.cp313-win32.pyd,sha256=x0MMlEIuli3NcjKFmaBqeqBG67y74die6yxzgPKRv5I,9216
+quadint/eisenstein.cp313-win32.pyd,sha256=4hHg_0MvQecM45_5yK22h2jwkurv5ssH9SCGl-NcGAo,9216
+quadint/quad.cp313-win32.pyd,sha256=k4m1FeeG5DH2kJUulEXHb6UPRl14a5Mxbel8LUV1Xa8,9216
+quadint-0.0.8.dist-info/licenses/LICENSE,sha256=6kbiFSfobTZ7beWiKnHpN902HgBx-Jzgcme0SvKqhKY,1091
+quadint-stubs/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+quadint-stubs/complex.pyi,sha256=WtDMsc_dlLgIK1LxdiRjrSMvhPu6ZXxWPiGB8E92PCA,284
+quadint-stubs/eisenstein.pyi,sha256=jyCDCy4aFpYpIV6f1WZhdvaUpIPK-7IcxY1ZePzuwbc,266
+quadint-stubs/quad.pyi,sha256=zIqLhbEAcYrFJV2mln_-lNo3XrJv0tczLOKf1cYbXUM,1901
+quadint-0.0.8.dist-info/METADATA,sha256=fASNoNW7TIznKTCER6kk-VHnwqhLJKz-3W1mkscRDtk,4542
+quadint-0.0.8.dist-info/WHEEL,sha256=0ABLuJ37exXk5N_efmYNs2NU9NK1K2Qlod_6bYkofEA,97
+quadint-0.0.8.dist-info/top_level.txt,sha256=3uozn88TjoQFTKJWsN_qpidOqiCMI-Vk5jp1XkGRW78,50
+quadint-0.0.8.dist-info/RECORD,,

quadint-0.0.8.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: false
+Tag: cp313-cp313-win32
+

quadint-0.0.8.dist-info/licenses/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2018 The Python Packaging Authority
+
+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.

quadint-0.0.8.dist-info/top_level.txt

@@ -0,0 +1,3 @@
+9c46a97409a639359bbf__mypyc
+quadint
+quadint-stubs

quadint-stubs/complex.pyi

@@ -0,0 +1,8 @@
+from quadint.quad import OP_TYPES as OP_TYPES, QuadInt as QuadInt, QuadraticRing as QuadraticRing
+
+class complexint(QuadInt):
+    def __init__(self, a: int = 0, b: int = 0) -> None: ...
+    @property
+    def real(self) -> int: ...
+    @property
+    def imag(self) -> int: ...

quadint-stubs/eisenstein.pyi

@@ -0,0 +1,8 @@
+from quadint.quad import QuadInt as QuadInt, QuadraticRing as QuadraticRing
+
+class eisensteinint(QuadInt):
+    def __init__(self, a: int = 0, b: int = 0) -> None: ...
+    @property
+    def real(self) -> int: ...
+    @property
+    def omega(self) -> int: ...

quadint-stubs/quad.pyi

@@ -0,0 +1,46 @@
+from _typeshed import Incomplete
+from typing import Iterator
+
+OTHER_OP_TYPES = complex | int | float
+OP_TYPES: Incomplete
+
+class QuadraticRing:
+    D: int
+    den: int
+    def __init__(self, D: int) -> None: ...
+    def __call__(self, a: int = 0, b: int = 0) -> QuadInt: ...
+    def from_obj(self, n: OP_TYPES) -> QuadInt: ...
+    def from_ab(self, a: int, b: int) -> QuadInt: ...
+
+class QuadInt:
+    ring: QuadraticRing
+    a: int
+    b: int
+    def __init__(self, ring: QuadraticRing, a: int = 0, b: int = 0) -> None: ...
+    def assert_same_ring(self, other: QuadInt): ...
+    def conjugate(self) -> QuadInt: ...
+    def __add__(self, other: OP_TYPES) -> QuadInt: ...
+    def __radd__(self, other: OTHER_OP_TYPES) -> QuadInt: ...
+    def __sub__(self, other: OP_TYPES) -> QuadInt: ...
+    def __rsub__(self, other: OTHER_OP_TYPES) -> QuadInt: ...
+    def __neg__(self) -> QuadInt: ...
+    def __pos__(self) -> QuadInt: ...
+    def __mul__(self, other: OP_TYPES) -> QuadInt: ...
+    def __rmul__(self, other: OTHER_OP_TYPES) -> QuadInt: ...
+    def __pow__(self, exp: float) -> QuadInt: ...
+    def __divmod__(self, other: OP_TYPES) -> tuple['QuadInt', 'QuadInt']: ...
+    def __truediv__(self, other: OP_TYPES) -> QuadInt: ...
+    def __rtruediv__(self, other: OTHER_OP_TYPES) -> QuadInt: ...
+    def __floordiv__(self, other: OP_TYPES) -> QuadInt: ...
+    def __rfloordiv__(self, other: OTHER_OP_TYPES) -> QuadInt: ...
+    def __mod__(self, other: QuadInt) -> QuadInt: ...
+    def __abs__(self) -> int: ...
+    def __bool__(self) -> bool: ...
+    def __iter__(self) -> Iterator[int]: ...
+    def __len__(self) -> int: ...
+    def __getitem__(self, idx: int) -> int: ...
+    def __eq__(self, other: object) -> bool: ...
+    def __ne__(self, other: object) -> bool: ...
+    def __hash__(self) -> int: ...
+
+def make_quadint(D: int) -> QuadraticRing: ...