pythagix 0.1.4__py3-none-any.whl → 0.1.7__py3-none-any.whl

pythagix/__init__.py

@@ -1,6 +1,6 @@
 # pythagix/__init__.py
 from .core import (
-    prime_list,
+    filter_primes,
     is_prime,
     nth_prime,
     gcd,

pythagix/core.py

@@ -1,93 +1,101 @@
-def filter_prime(number_list: list[int]) -> list[int]:
+from math import isqrt
+from functools import reduce
+from typing import List
+import math
+
+__all__ = [
+    "is_prime",
+    "filter_primes",
+    "nth_prime",
+    "gcd",
+    "is_perfect_square",
+    "count_factors",
+    "triangle_number",
+]
+
+
+def is_prime(number: int) -> bool:
     """
-    Returns a list of all prime numbers from a given list.
+    Check whether a given integer is a prime number.
 
     Args:
-        number_list (list[int]): The list of integers to check.
+        number (int): The number to check.
 
     Returns:
-        list[int]: A list containing only the prime numbers from the input.
+        bool: True if number is prime, False otherwise.
     """
-    prime_number: list[int] = []
-    for x in number_list:
-        if x == 1:
-            continue
-        for y in range(2, int(x * 1 / 2 + 1)):
-            if x % y == 0:
-                break
-        else:
-            prime_number.append(x)
-    return prime_number
+    if number <= 1:
+        return False
+    if number == 2:
+        return True
+    if number % 2 == 0:
+        return False
+    for i in range(3, isqrt(number) + 1, 2):
+        if number % i == 0:
+            return False
+    return True
 
 
-def is_prime(number: int) -> bool:
+def filter_primes(values: List[int]) -> List[int]:
     """
-    Checks whether a number is a prime number.
+    Filter and return the prime numbers from a list.
 
     Args:
-        number (int): The number to check.
+        values (List[int]): A list of integers.
 
     Returns:
-        bool: True if the number is prime, False otherwise.
+        List[int]: A list containing only the prime numbers.
     """
-    for y in range(2, int(number * 1 / 2)):
-        if number % y == 0:
-            return False
-    else:
-        return True
+    return [num for num in values if is_prime(num)]
 
 
-def nth_prime(index: int) -> int:
+def nth_prime(position: int) -> int:
     """
-    Returns the n-th prime number (1-indexed).
+    Get the N-th prime number (1-based index).
 
     Args:
-        index (int): The position of the prime to find.
+        position (int): The index (1-based) of the prime number to find.
 
     Returns:
-        int: The n-th prime number.
+        int: The N-th prime number.
 
     Raises:
-        ValueError: If index is less than 1.
+        ValueError: If position < 1.
     """
-    if index < 1:
-        raise ValueError("Index must be >= 1")
+    if position < 1:
+        raise ValueError("Position must be >= 1")
 
-    count: int = 0
-    prime_number: int = 2
+    count = 0
+    candidate = 2
     while True:
-        if is_prime(prime_number):
+        if is_prime(candidate):
             count += 1
-            if count == index:
-                return prime_number
-        prime_number += 1
+            if count == position:
+                return candidate
+        candidate += 1
 
 
-def gcd(number_list: list[int]) -> int:
+def gcd(values: List[int]) -> int:
     """
-    Returns the greatest common divisor (GCD) of a list of integers.
+    Compute the greatest common divisor (GCD) of a list of integers.
 
     Args:
-        number_list (list[int]): The list of integers.
+        values (List[int]): A list of integers.
 
     Returns:
-        int: The greatest number that divides all elements in the list.
+        int: The GCD of the numbers.
+
+    Raises:
+        ValueError: If the list is empty.
     """
-    num: int = 2
-    highest: int = 0
-    while num <= min(number_list):
-        for number in number_list:
-            if number % num != 0:
-                break
-        else:
-            highest = num
-        num += 1
-    return highest
+    if not values:
+        raise ValueError("Input list must not be empty")
+    return reduce(math.gcd, values)
 
 
 def is_perfect_square(number: int) -> bool:
     """
-    Checks whether a number is a perfect square.
+    Check whether a number is a perfect square.
 
     Args:
         number (int): The number to check.
@@ -95,50 +103,58 @@ def is_perfect_square(number: int) -> bool:
     Returns:
         bool: True if the number is a perfect square, False otherwise.
     """
-    num: int = 0
-    while num <= number:
-        if num**2 == number:
-            return True
-        num += 1
-    return False
+    if number < 0:
+        return False
+    root = isqrt(number)
+    return root * root == number
 
 
-def count_factors(number: int) -> list[int]:
+def count_factors(number: int) -> List[int]:
     """
-    Returns a list of all factors (divisors) of a number.
+    Return all positive factors of a number.
 
     Args:
-        number (int): The number to find factors of.
+        number (int): The number whose factors are to be found.
 
     Returns:
-        list[int]: A list of all positive integers that divide the number evenly.
+        List[int]: A sorted list of factors.
+
+    Raises:
+        ValueError: If number is not positive.
     """
-    num: int = 1
-    factors: list[int] = []
-    while num <= number:
-        if number % num == 0:
-            factors.append(num)
-        num += 1
-    return factors
+    if number <= 0:
+        raise ValueError("Number must be positive")
+
+    factors = set()
+    for i in range(1, isqrt(number) + 1):
+        if number % i == 0:
+            factors.add(i)
+            factors.add(number // i)
+    return sorted(factors)
 
 
-def triangle_number(number: int) -> int:
+def triangle_number(index: int) -> int:
     """
-    Returns the n-th triangle number.
+    Calculate the N-th triangular number.
 
     Args:
-        number (int): The term (n) of the triangle number sequence.
+        index (int): The position (starting from 0) in the triangular number sequence.
 
     Returns:
-        int: The n-th triangle number, calculated as n(n+1)//2.
+        int: The N-th triangular number.
+
+    Raises:
+        ValueError: If index is negative.
     """
-    return number * (number + 1) // 2
+    if index < 0:
+        raise ValueError("Index must be >= 0")
+    return index * (index + 1) // 2
 
 
-if __name__ == "__main__":
+def main() -> None:
+    """Tester Function."""
+    ...
 
-    def main():
-        """Runs a quick test of any function."""
-        print(triangle_number(10))
 
+if __name__ == "__main__":
     main()

pythagix-0.1.7.dist-info/METADATA

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: pythagix
+Version: 0.1.7
+Summary: A mathy Python package with utilities like LCM, triangle numbers, etc.
+Author: UltraQuantumScriptor
+License: MIT
+Keywords: math,prime,LCM,triangle numbers,gcd,utilities
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+Dynamic: requires-python
+
+---
+
+# 📦 Pythagix
+
+**Pythagix** is a lightweight and dependency-free Python library designed for number theory operations.
+It provides a clean, efficient interface to common mathematical utilities such as prime number checks, greatest common divisor computation, triangular numbers, and more.
+
+---
+
+## 📥 Installation
+
+Install Pythagix using pip:
+
+```bash
+pip install pythagix
+```
+
+---
+
+## Features
+
+* `is_prime(number: int) -> bool`
+  Determine whether a number is a prime number.
+
+* `filter_primes(numbers: List[int]) -> List[int]`
+  Return all prime numbers from a list of integers.
+
+* `nth_prime(position: int) -> int`
+  Retrieve the *n*-th prime number (1-based indexing).
+
+* `gcd(values: List[int]) -> int`
+  Compute the greatest common divisor (GCD) of a list of integers.
+
+* `is_perfect_square(number: int) -> bool`
+  Check whether a number is a perfect square.
+
+* `count_factors(number: int) -> List[int]`
+  Return a sorted list of all positive factors of a number.
+
+* `triangle_number(index: int) -> int`
+  Compute the *n*-th triangular number.
+
+---
+
+## Example Usage
+
+```python
+from pythagix import is_prime, nth_prime, gcd, triangle_number
+
+print(is_prime(13))         # Output: True
+
+print(nth_prime(10))        # Output: 29
+
+print(gcd([12, 18, 24]))    # Output: 6
+
+print(triangle_number(7))   # Output: 28
+```
+
+---
+
+## Use Cases
+
+Pythagix is ideal for:
+
+* Educational platforms and math-related tools
+
+* Prototyping algorithms and number-theoretic computations
+
+* Teaching foundational concepts in discrete mathematics and number theory
+
+* Lightweight CLI utilities and academic scripting
+
+---
+
+## License
+
+Pythagix is released under the [MIT License](LICENSE), making it free to use, modify, and distribute.
+
+---
+
+## Contributing
+
+Contributions are welcome!
+If you'd like to add features, report bugs, or improve documentation, please open an issue or submit a pull request on the [GitHub repository](https://github.com/your-username/pythagix).
+
+---
+
+If you want me to tailor this even more (e.g. add badges, GitHub Actions, versioning, or PyPI metadata snippets), I can assist with that too.

pythagix-0.1.7.dist-info/RECORD

@@ -0,0 +1,7 @@
+pythagix/__init__.py,sha256=6tpiGil3VFdLrZ9fUZ41YY7qAkNyWOC74fiUNCuXzAE,175
+pythagix/core.py,sha256=-zmDFcEsfqL8G-cEY8CCfw1YA0_fDnRrLv4g-bxeews,3534
+pythagix-0.1.7.dist-info/licenses/LICENSE,sha256=Qv2ilebwoUtMJnRsZwRy729xS5JZQzLauJ0tQzkAkTA,1088
+pythagix-0.1.7.dist-info/METADATA,sha256=8vrKYFwTC1aKvY9_pmd9yLwK8E70qP7mFnfLe9wRz5Q,2679
+pythagix-0.1.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pythagix-0.1.7.dist-info/top_level.txt,sha256=U3rm-YGObQkL0gSuVWFPZTakILlqyAd7pUVvtJiMlsE,9
+pythagix-0.1.7.dist-info/RECORD,,

pythagix-0.1.4.dist-info/METADATA

@@ -1,56 +0,0 @@
-Metadata-Version: 2.4
-Name: pythagix
-Version: 0.1.4
-Summary: A mathy Python package with utilities like LCM, triangle numbers, etc.
-Author: UltraQuantumScriptor
-License: MIT
-Classifier: Programming Language :: Python :: 3
-Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.6
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Dynamic: license-file
-Dynamic: requires-python
-
-# 🧠 pythagix
-
-Math utilities for number nerds.  
-Check primes, compute triangle numbers, find GCDs — all in one lightweight package.  
-Because math shouldn't be a pain 🧮✨
-
----
-
-## 📦 Installation
-
-```bash
-pip install pythagix
-```
-
-⚙️ Features
-
-🔢 is_prime(number) — Check if a number is prime
-
-📜 prime_list([list]) — Return all primes in a list
-
-🔎 nth_prime(n) — Get the n-th prime number
-
-🤝 gcd([list]) — Greatest common divisor of a list
-
-📏 is_perfect_square(n) — Check if n is a perfect square
-
-🧱 count_factors(n) — Get all factors of a number
-
-🔺 triangle_number(n) — Get the n-th triangle number
-
-🧪 Examples
-```python
-from pythagix import is_prime, nth_prime, gcd, triangle_number
-
-print(is_prime(13))        # True
-print(nth_prime(10))       # 29
-print(gcd([12, 18, 24]))   # 6
-print(triangle_number(7))  # 28
-```
-
-📚 Why?
-pythagix was built to give math students, coders, and tinkerers a fast and fun way to explore number theory in Python. No heavy dependencies. Just pure mathy goodness.

pythagix-0.1.4.dist-info/RECORD

@@ -1,7 +0,0 @@
-pythagix/__init__.py,sha256=A9cw-DpCoP2SUMlHar8PK0OAUSiFLQwoApZzx7oMslg,172
-pythagix/core.py,sha256=b5qw5ejc3-MsiNu4b4G6E-ILxaj8DyUI2tQwX1XP0bs,3395
-pythagix-0.1.4.dist-info/licenses/LICENSE,sha256=Qv2ilebwoUtMJnRsZwRy729xS5JZQzLauJ0tQzkAkTA,1088
-pythagix-0.1.4.dist-info/METADATA,sha256=THDZACzNVrTeErOXrlU8Z2aDg6_jsfDfwXV9lLljqbo,1513
-pythagix-0.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pythagix-0.1.4.dist-info/top_level.txt,sha256=U3rm-YGObQkL0gSuVWFPZTakILlqyAd7pUVvtJiMlsE,9
-pythagix-0.1.4.dist-info/RECORD,,