pythagix 0.2.0__py3-none-any.whl → 0.2.2__py3-none-any.whl

pythagix/__init__.py

@@ -8,7 +8,10 @@ from .core import (
     is_prime,
     is_multiple,
     lcm,
+    mean,
+    median,
     middle,
+    mode,
     nth_prime,
     triangle_number,
 )

pythagix/core.py

@@ -1,6 +1,9 @@
 import math as m
 from functools import reduce
-from typing import List
+from typing import List, Union
+from collections import Counter
+
+Numeric = Union[int, float]
 
 __all__ = [
     "count_factors",
@@ -11,7 +14,10 @@ __all__ = [
     "is_prime",
     "is_multiple",
     "lcm",
+    "mean",
+    "median",
     "middle",
+    "mode",
     "nth_prime",
     "triangle_number",
 ]
@@ -25,7 +31,7 @@ def is_prime(number: int) -> bool:
         number (int): The number to check.
 
     Returns:
-        bool: True if number is prime, False otherwise.
+        bool: True if the number is prime, False otherwise.
     """
     if number <= 1:
         return False
@@ -123,7 +129,7 @@ def count_factors(number: int) -> List[int]:
         List[int]: A sorted list of factors.
 
     Raises:
-        ValueError: If number is not positive.
+        ValueError: If the number is not positive.
     """
     if number <= 0:
         raise ValueError("Number must be positive")
@@ -147,7 +153,7 @@ def triangle_number(index: int) -> int:
         int: The N-th triangular number.
 
     Raises:
-        ValueError: If index is negative.
+        ValueError: If the index is negative.
     """
     if index < 0:
         raise ValueError("Index must be >= 0")
@@ -168,23 +174,22 @@ def lcm(values: List[int]) -> int:
         ValueError: If the list is empty.
     """
     if not values:
-        raise ValueError("Input list must not empty")
+        raise ValueError("Input list must not be empty")
 
     return reduce(m.lcm, values)
 
 
 def digit_sum(number: int) -> int:
     """
-    Sum all digits that are in the given number
+    Sum all digits of the given number.
 
     Args:
         number (int): The number whose digits are to be summed.
 
     Returns:
-        int: The sum of the digits in the number
+        int: The sum of the digits in the number.
     """
-
-    return sum([int(digit) for digit in str(number)])
+    return sum(int(digit) for digit in str(number))
 
 
 def is_multiple(number: int, base: int) -> bool:
@@ -192,35 +197,110 @@ def is_multiple(number: int, base: int) -> bool:
     Check if a number is a multiple of another number.
 
     Args:
-        n (int): The number to test.
+        number (int): The number to test.
         base (int): The base to check against.
 
     Returns:
-        bool: True if n is a multiple of base, False otherwise.
+        bool: True if number is a multiple of base, False otherwise.
     """
-
     return number % base == 0
 
 
-def middle(a: int | float, b: int | float) -> float:
+def middle(a: Numeric, b: Numeric) -> float:
     """
     Return the midpoint between two numbers.
 
     Args:
-        a (float): The first number.
-        b (float): The second number.
+        a (int | float): The first number.
+        b (int | float): The second number.
 
     Returns:
         float: The average of the two numbers.
     """
-
     return (a + b) / 2
 
 
-def main() -> None:
-    """Tester Function."""
-    print(middle(246, 2))
+def mean(values: List[Numeric]) -> float:
+    """
+    Calculate the mean (average) of a list of numbers.
+
+    Args:
+        values (List[int | float]): A list of integers or floats.
+
+    Returns:
+        float: The mean of the list.
+
+    Raises:
+        ValueError: If the input list is empty.
+    """
+    if not values:
+        raise ValueError("Must contain at least one data point")
+
+    total = 0
+    for number in values:
+        total += number
+
+    return total / len(values)
+
+
+def median(values: List[Numeric]) -> float:
+    """
+    Calculate the median of a list of numbers.
+
+    Args:
+        values (List[int | float]): A list of integers or floats.
+
+    Returns:
+        float: The median of the list.
+
+    Raises:
+        ValueError: If the input list is empty.
+    """
+    if not values:
+        raise ValueError("Must contain at least one data point")
+
+    values = sorted(values)
+    length = len(values)
+    mid = length // 2
+
+    if length % 2 == 1:
+        return float(values[mid])
+    else:
+        return middle(values[mid - 1], values[mid])
+
+
+def mode(values: List[Numeric]) -> Union[Numeric, List[Numeric]]:
+    """
+    Compute the mode(s) of a list of numeric values.
+
+    The mode is the number that appears most frequently in the list.
+    If multiple numbers have the same highest frequency, all such numbers are returned as a list.
+    If only one number has the highest frequency, that single value is returned.
+
+    Args:
+        values (List[int | float]): A list of integers or floats.
+
+    Returns:
+        int | float | List[int | float]:
+            The mode of the list. Returns a single value if there's one mode,
+            or a list of values if multiple modes exist.
+
+    Raises:
+        ValueError: If the input list is empty.
+    """
+    if not values:
+        raise ValueError("Input list must not be empty")
+
+    frequency = Counter(values)
+    highest = max(frequency.values())
+    modes = [number for number, count in frequency.items() if count == highest]
+
+    return modes[0] if len(modes) == 1 else modes
 
 
 if __name__ == "__main__":
+
+    def main() -> None:
+        """Tester Function."""
+
     main()

pythagix-0.2.2.dist-info/METADATA

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: pythagix
+Version: 0.2.2
+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, dependency-free Python library for number theory operations.
+It provides a clean and efficient interface for common mathematical utilities such as prime checking, greatest common divisor, triangular numbers, and more.
+
+---
+
+
+Installation
+
+You can install Pythagix using pip:
+
+```bash
+pip install pythagix
+```
+
+
+Features
+
+count_factors(number: int) -> List[int]
+Returns a sorted list of all positive factors of the given number.
+
+digit_sum(number: int) -> int
+Returns the sum of all digits in the given number.
+
+filter_primes(values: List[int]) -> List[int]
+Filters and returns prime numbers from a list of integers.
+
+gcd(values: List[int]) -> int
+Computes the greatest common divisor (GCD) of a list of integers.
+
+is_perfect_square(number: int) -> bool
+Determines whether a number is a perfect square.
+
+is_prime(number: int) -> bool
+Checks whether a number is prime.
+
+is_multiple(number: int, base: int) -> bool
+Checks if one number is a multiple of another.
+
+lcm(values: List[int]) -> int
+Computes the least common multiple (LCM) of a list of integers.
+
+mean(values: List[int | float]) -> float
+Calculates the arithmetic mean (average) of a list of numbers.
+
+median(values: List[int | float]) -> float
+Computes the median value of a list.
+
+middle(a: int | float, b: int | float) -> float
+Returns the midpoint of two numeric values.
+
+mode(values: List[int | float]) -> int | float | List[int | float]
+Computes the mode(s) of a list. Returns a single value or a list of modes.
+
+nth_prime(position: int) -> int
+Retrieves the n-th prime number (1-based index).
+
+triangle_number(index: int) -> int
+Computes the n-th triangular number.
+
+
+Use Cases
+
+Pythagix is suitable for:
+
+Educational platforms and math-related applications
+
+Prototyping number-theoretic algorithms
+
+Teaching foundational concepts in discrete mathematics
+
+Lightweight command-line tools and academic scripting
+
+
+License
+
+This project is licensed under the MIT License.
+You are free to use, modify, and distribute the software as permitted under the license terms.
+
+Contributing
+
+Contributions are welcome.
+
+To report bugs, suggest enhancements, or submit code improvements, please open an issue or create a pull request via the GitHub repository.

pythagix-0.2.2.dist-info/RECORD

@@ -0,0 +1,7 @@
+pythagix/__init__.py,sha256=1DtygFgNUk9idxupKZ6gLQLGL9mY4Hkeumd91YdTPt4,267
+pythagix/core.py,sha256=kbA2n0SLI4QVZExU93u2M8QgiJGO86Ybbxke_m62AFo,7206
+pythagix-0.2.2.dist-info/licenses/LICENSE,sha256=mAiqjt0kIJZfw70XUmdIrsvPwnhKBMerHN3nDFg8H9c,1096
+pythagix-0.2.2.dist-info/METADATA,sha256=1DMFFOxWlitY1byrUfpzYYAqP3I4LogwUOr9UnKBkBw,2813
+pythagix-0.2.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+pythagix-0.2.2.dist-info/top_level.txt,sha256=U3rm-YGObQkL0gSuVWFPZTakILlqyAd7pUVvtJiMlsE,9
+pythagix-0.2.2.dist-info/RECORD,,

pythagix-0.2.0.dist-info/METADATA

@@ -1,112 +0,0 @@
-Metadata-Version: 2.4
-Name: pythagix
-Version: 0.2.0
-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
-
-count_factors(number: int) -> List[int]
-Return a sorted list of all positive factors of the given number.
-
-digit_sum(number: int) -> int
-Return the sum of all digit in the given number.
-
-filter_primes(numbers: List[int]) -> List[int]
-Return all prime numbers from a list of integers.
-
-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.
-
-is_prime(number: int) -> bool
-Determine whether a number is prime.
-
-lcm(values: List[int]) -> int
-Compute the least common multiple (LCM) of a list of integers.
-
-middle(a: int | float, b: int | float) -> float
-Return the midpoint of two numbers.
-
-nth_prime(position: int) -> int
-Retrieve the n-th prime number (1-based index).
-
-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.2.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-pythagix/__init__.py,sha256=LUVDAw14_IqsBFgs0qWQor9QNQ3VlDG9XSH-ONMT7xY,232
-pythagix/core.py,sha256=dyLRvIJbH5RABSTEK3ZuF0BrVjdbVRFrn6RTs0PmkgA,4963
-pythagix-0.2.0.dist-info/licenses/LICENSE,sha256=mAiqjt0kIJZfw70XUmdIrsvPwnhKBMerHN3nDFg8H9c,1096
-pythagix-0.2.0.dist-info/METADATA,sha256=3EqjE5mGCx53YX_4NNcKZL2UgpX9lR-pBAuNbO2mfGU,2875
-pythagix-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-pythagix-0.2.0.dist-info/top_level.txt,sha256=U3rm-YGObQkL0gSuVWFPZTakILlqyAd7pUVvtJiMlsE,9
-pythagix-0.2.0.dist-info/RECORD,,