# Democritus Math
[](https://pypi.python.org/pypi/d8s-math)
[](https://github.com/democritus-project/d8s-math/actions)
[](https://github.com/democritus-project/d8s-math/actions)
[](https://codecov.io/gh/democritus-project/d8s-math)
[](https://semver.org/spec/v2.0.0.html)
[](https://github.com/psf/black)
[](https://choosealicense.com/licenses/lgpl-3.0/)
Democritus functions<sup>[1]</sup> for working with math.
[1] Democritus functions are <i>simple, effective, modular, well-tested, and well-documented</i> Python functions.
We use `d8s` (pronounced "dee-eights") as an abbreviation for `democritus` (you can read more about this [here](https://github.com/democritus-project/roadmap#what-is-d8s)).
## Installation
```
pip install d8s-math
```
## Usage
You import the library like:
```python
from d8s_math import *
```
Once imported, you can use any of the functions listed below.
## Functions
- ```python
def fibonacci_sequence(n: int) -> List[int]:
"""Return the first n digits of the fibonacci sequence."""
```
- ```python
def fibonacci(n: int) -> int:
"""Return the value of the Fibonacci sequence at index n."""
```
- ```python
def number_closest(a, b, target):
"""Return a or b, whichever is closest to the target."""
```
- ```python
def number_furthest(a, b, target):
"""Return a or b, whichever is furthest to the target."""
```
- ```python
def cartesian_product(a: Any, *args: Any, repeat: int = 1):
"""."""
```
- ```python
def sympy_symbol(symbol_name: str):
"""."""
```
- ```python
def equation_solve(equation: str, symbols: List[str]):
"""."""
```
- ```python
def expression_explore(expression: str, symbol: str, start: int, end: int, step: int):
"""."""
```
- ```python
def one_cold_encode(items: list, *, reverse: bool = False) -> List[list]:
"""."""
```
- ```python
def one_hot_encode(items: list, *, reverse: bool = False) -> List[list]:
"""."""
```
- ```python
def is_integer_tuple(possible_integer_tuple: Any) -> bool:
"""."""
```
- ```python
def string_to_number(string: str) -> Union[int, float]:
"""Convert a number as a string into either an integer or float."""
```
- ```python
def first_arg_as_decimal(func):
"""Convert the first argument to a number (either integer or float)."""
```
- ```python
def arguments_as_decimals(func):
"""Convert all arguments to numbers (either integers or floats)."""
```
- ```python
def decimal_to_gray_code(num: Union[str, int, float]) -> integerTupleType:
"""Convert the given number to a gray code. This function was inspired by the code here: https://en.wikipedia.org/wiki/Gray_code#Converting_to_and_from_Gray_code."""
```
- ```python
def gray_code_to_decimal(num: integerTupleType) -> int:
"""Convert the given number to a gray code. This function was inspired by the code here: https://en.wikipedia.org/wiki/Gray_code#Converting_to_and_from_Gray_code."""
```
- ```python
def decimal_to_hex(decimal_number):
"""."""
```
- ```python
def hex_to_decimal(hex):
"""."""
```
- ```python
def roman_numeral_to_decimal(roman_numeral: str) -> int:
"""."""
```
- ```python
def decimal_to_roman_numeral(decimal_number) -> str:
"""."""
```
- ```python
def integer_tuple_to_decimal(integer_tuple: integerTupleType) -> int:
"""Return the decimal form of the given number (represented as an integer tuple)."""
```
- ```python
def integer_to_decimal(num: Union[str, int, float], base: int) -> int:
"""Convert the number of the given base to a decimal number."""
```
- ```python
def decimal_to_base(decimal_number: Union[str, int, float], base: int):
"""Convert the decimal_number to the given base."""
```
- ```python
def outer_division():
"""."""
```
- ```python
def outer_product(a: int, b: int, a_start: int = 1, b_start: int = 1):
"""Return a two-dimensional array with the results of range(a_start, a+1) multiplied by range(b_start, b+1)."""
```
- ```python
def multiplication_table(a: int, b: int, a_start: int = 1, b_start: int = 1):
"""."""
```
- ```python
def number_evenly_divides(a, b):
"""Return True if a evenly divides b. Otherwise, return False."""
```
- ```python
def number_evenly_divided_by(a, b):
"""Return True if a is evenly divided by b. Otherwise, return False."""
```
- ```python
def fraction_examples(n=10, *, fractions_as_strings: bool = True):
"""Create n fractions."""
```
- ```python
def iterable_differences(iterable):
"""Find all of the possible differences of all possible orders of the given iterable."""
```
- ```python
def combinations(iterable, length=None):
"""Return all possible combinations of the given length which can be created from the given iterable. If no length is given, we will find all combinations of all lengths for the given iterable."""
```
- ```python
def combinations_with_replacement(iterable, length=None):
"""Return all possible combinations of the given length which can be created from the given iterable. If no length is given, we will find all combinations of all lengths for the given iterable."""
```
- ```python
def prod(iterable):
"""Get the product of the iterable."""
```
- ```python
def permutations(iterable, length=None):
"""Return all possible permutations of the given iterable. If no length is given, we will find all permutations of all lengths for the given iterable"""
```
- ```python
def fraction_simplify(fraction_string):
"""Simplify the fraction represented as a string."""
```
- ```python
def remainder(dividend, divisor):
"""."""
```
- ```python
def floor(number):
"""."""
```
- ```python
def ceiling(number):
"""."""
```
- ```python
def factorial(number):
"""."""
```
- ```python
def fraction_complex_to_mixed_fraction(fraction_string):
"""Simplify the fraction represented as a string."""
```
- ```python
def fraction_mixed_to_complex_fraction(fraction_string):
"""Simplify the fraction represented as a string."""
```
- ```python
def dot_product(item_a, item_b):
"""Find the dot product for the two items. See https://en.wikipedia.org/wiki/Dot_product for more details."""
```
- ```python
def percent(ratio):
"""Return the ratio as a percentage."""
```
- ```python
def gcd(number1, number2):
"""Return the greatest common divisor."""
```
- ```python
def ratio(number1, number2):
"""Return the ratio of the two numbers in the form 1:2. For example, if given 5 and 10, this function would return "1:2". If given 2 and 20, this function would return "1:10"."""
```
- ```python
def transpose(matrix):
"""Transpose the given matrix. See https://en.wikipedia.org/wiki/Transpose."""
```
- ```python
def number_line(value, min_, max_, interval: int = 1):
"""."""
```
- ```python
def number_zero_pad(num: StrOrNumberType, length: StrOrNumberType) -> str:
"""."""
```
- ```python
def is_number(item):
"""Return whether or not the item is a number."""
```
- ```python
def number_is_even(number: StrOrNumberType):
"""."""
```
- ```python
def number_is_odd(number: StrOrNumberType):
"""."""
```
- ```python
def number_is_approx(number, approximate_value, *, relative_tolerance=1e-6):
"""."""
```
- ```python
def enumerate_range(range_string, range_split_string: str = '-'):
"""Enumerate the range specified by the string. For example, `1-3` returns `[1, 2, 3]`."""
```
- ```python
def hex_endiness_swap(hex_string):
"""Credit to: https://stackoverflow.com/questions/27506474/how-to-byte-swap-a-32-bit-integer-in-python."""
```
- ```python
def number_to_words(number):
"""Convert a number to its English representation (e.g. 100 => "One Hundred")."""
```
- ```python
def number_to_scientific_notation(number):
"""Convert the given number to scientific notation."""
```
- ```python
def number_to_engineering_notation(number):
"""Convert the given number to engineering notation."""
```
## Development
👋 If you want to get involved in this project, we have some short, helpful guides below:
- [contribute to this project 🥇][contributing]
- [test it 🧪][local-dev]
- [lint it 🧹][local-dev]
- [explore it 🔭][local-dev]
If you have any questions or there is anything we did not cover, please raise an issue and we'll be happy to help.
## Credits
This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and Floyd Hightower's [Python project template](https://github.com/fhightower-templates/python-project-template).
[contributing]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#contributing-a-pr-
[local-dev]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#local-development-
Raw data
{
"_id": null,
"home_page": "https://github.com/democritus-project/d8s-math",
"name": "d8s-math",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "democritus,utility,python,math,math-utility,math,maths",
"author": "Floyd Hightower",
"author_email": "floyd.hightower27@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3c/ba/1d675b372f82665f2c04c79b4a7cb668603c84bf531e82f7305187eca80e/d8s_math-0.7.0.tar.gz",
"platform": "",
"description": "# Democritus Math\n\n[](https://pypi.python.org/pypi/d8s-math)\n[](https://github.com/democritus-project/d8s-math/actions)\n[](https://github.com/democritus-project/d8s-math/actions)\n[](https://codecov.io/gh/democritus-project/d8s-math)\n[](https://semver.org/spec/v2.0.0.html)\n[](https://github.com/psf/black)\n[](https://choosealicense.com/licenses/lgpl-3.0/)\n\nDemocritus functions<sup>[1]</sup> for working with math.\n\n[1] Democritus functions are <i>simple, effective, modular, well-tested, and well-documented</i> Python functions.\n\nWe use `d8s` (pronounced \"dee-eights\") as an abbreviation for `democritus` (you can read more about this [here](https://github.com/democritus-project/roadmap#what-is-d8s)).\n\n## Installation\n\n```\npip install d8s-math\n```\n\n## Usage\n\nYou import the library like:\n\n```python\nfrom d8s_math import *\n```\n\nOnce imported, you can use any of the functions listed below.\n\n## Functions\n\n - ```python\n def fibonacci_sequence(n: int) -> List[int]:\n \"\"\"Return the first n digits of the fibonacci sequence.\"\"\"\n ```\n - ```python\n def fibonacci(n: int) -> int:\n \"\"\"Return the value of the Fibonacci sequence at index n.\"\"\"\n ```\n - ```python\n def number_closest(a, b, target):\n \"\"\"Return a or b, whichever is closest to the target.\"\"\"\n ```\n - ```python\n def number_furthest(a, b, target):\n \"\"\"Return a or b, whichever is furthest to the target.\"\"\"\n ```\n - ```python\n def cartesian_product(a: Any, *args: Any, repeat: int = 1):\n \"\"\".\"\"\"\n ```\n - ```python\n def sympy_symbol(symbol_name: str):\n \"\"\".\"\"\"\n ```\n - ```python\n def equation_solve(equation: str, symbols: List[str]):\n \"\"\".\"\"\"\n ```\n - ```python\n def expression_explore(expression: str, symbol: str, start: int, end: int, step: int):\n \"\"\".\"\"\"\n ```\n - ```python\n def one_cold_encode(items: list, *, reverse: bool = False) -> List[list]:\n \"\"\".\"\"\"\n ```\n - ```python\n def one_hot_encode(items: list, *, reverse: bool = False) -> List[list]:\n \"\"\".\"\"\"\n ```\n - ```python\n def is_integer_tuple(possible_integer_tuple: Any) -> bool:\n \"\"\".\"\"\"\n ```\n - ```python\n def string_to_number(string: str) -> Union[int, float]:\n \"\"\"Convert a number as a string into either an integer or float.\"\"\"\n ```\n - ```python\n def first_arg_as_decimal(func):\n \"\"\"Convert the first argument to a number (either integer or float).\"\"\"\n ```\n - ```python\n def arguments_as_decimals(func):\n \"\"\"Convert all arguments to numbers (either integers or floats).\"\"\"\n ```\n - ```python\n def decimal_to_gray_code(num: Union[str, int, float]) -> integerTupleType:\n \"\"\"Convert the given number to a gray code. This function was inspired by the code here: https://en.wikipedia.org/wiki/Gray_code#Converting_to_and_from_Gray_code.\"\"\"\n ```\n - ```python\n def gray_code_to_decimal(num: integerTupleType) -> int:\n \"\"\"Convert the given number to a gray code. This function was inspired by the code here: https://en.wikipedia.org/wiki/Gray_code#Converting_to_and_from_Gray_code.\"\"\"\n ```\n - ```python\n def decimal_to_hex(decimal_number):\n \"\"\".\"\"\"\n ```\n - ```python\n def hex_to_decimal(hex):\n \"\"\".\"\"\"\n ```\n - ```python\n def roman_numeral_to_decimal(roman_numeral: str) -> int:\n \"\"\".\"\"\"\n ```\n - ```python\n def decimal_to_roman_numeral(decimal_number) -> str:\n \"\"\".\"\"\"\n ```\n - ```python\n def integer_tuple_to_decimal(integer_tuple: integerTupleType) -> int:\n \"\"\"Return the decimal form of the given number (represented as an integer tuple).\"\"\"\n ```\n - ```python\n def integer_to_decimal(num: Union[str, int, float], base: int) -> int:\n \"\"\"Convert the number of the given base to a decimal number.\"\"\"\n ```\n - ```python\n def decimal_to_base(decimal_number: Union[str, int, float], base: int):\n \"\"\"Convert the decimal_number to the given base.\"\"\"\n ```\n - ```python\n def outer_division():\n \"\"\".\"\"\"\n ```\n - ```python\n def outer_product(a: int, b: int, a_start: int = 1, b_start: int = 1):\n \"\"\"Return a two-dimensional array with the results of range(a_start, a+1) multiplied by range(b_start, b+1).\"\"\"\n ```\n - ```python\n def multiplication_table(a: int, b: int, a_start: int = 1, b_start: int = 1):\n \"\"\".\"\"\"\n ```\n - ```python\n def number_evenly_divides(a, b):\n \"\"\"Return True if a evenly divides b. Otherwise, return False.\"\"\"\n ```\n - ```python\n def number_evenly_divided_by(a, b):\n \"\"\"Return True if a is evenly divided by b. Otherwise, return False.\"\"\"\n ```\n - ```python\n def fraction_examples(n=10, *, fractions_as_strings: bool = True):\n \"\"\"Create n fractions.\"\"\"\n ```\n - ```python\n def iterable_differences(iterable):\n \"\"\"Find all of the possible differences of all possible orders of the given iterable.\"\"\"\n ```\n - ```python\n def combinations(iterable, length=None):\n \"\"\"Return all possible combinations of the given length which can be created from the given iterable. If no length is given, we will find all combinations of all lengths for the given iterable.\"\"\"\n ```\n - ```python\n def combinations_with_replacement(iterable, length=None):\n \"\"\"Return all possible combinations of the given length which can be created from the given iterable. If no length is given, we will find all combinations of all lengths for the given iterable.\"\"\"\n ```\n - ```python\n def prod(iterable):\n \"\"\"Get the product of the iterable.\"\"\"\n ```\n - ```python\n def permutations(iterable, length=None):\n \"\"\"Return all possible permutations of the given iterable. If no length is given, we will find all permutations of all lengths for the given iterable\"\"\"\n ```\n - ```python\n def fraction_simplify(fraction_string):\n \"\"\"Simplify the fraction represented as a string.\"\"\"\n ```\n - ```python\n def remainder(dividend, divisor):\n \"\"\".\"\"\"\n ```\n - ```python\n def floor(number):\n \"\"\".\"\"\"\n ```\n - ```python\n def ceiling(number):\n \"\"\".\"\"\"\n ```\n - ```python\n def factorial(number):\n \"\"\".\"\"\"\n ```\n - ```python\n def fraction_complex_to_mixed_fraction(fraction_string):\n \"\"\"Simplify the fraction represented as a string.\"\"\"\n ```\n - ```python\n def fraction_mixed_to_complex_fraction(fraction_string):\n \"\"\"Simplify the fraction represented as a string.\"\"\"\n ```\n - ```python\n def dot_product(item_a, item_b):\n \"\"\"Find the dot product for the two items. See https://en.wikipedia.org/wiki/Dot_product for more details.\"\"\"\n ```\n - ```python\n def percent(ratio):\n \"\"\"Return the ratio as a percentage.\"\"\"\n ```\n - ```python\n def gcd(number1, number2):\n \"\"\"Return the greatest common divisor.\"\"\"\n ```\n - ```python\n def ratio(number1, number2):\n \"\"\"Return the ratio of the two numbers in the form 1:2. For example, if given 5 and 10, this function would return \"1:2\". If given 2 and 20, this function would return \"1:10\".\"\"\"\n ```\n - ```python\n def transpose(matrix):\n \"\"\"Transpose the given matrix. See https://en.wikipedia.org/wiki/Transpose.\"\"\"\n ```\n - ```python\n def number_line(value, min_, max_, interval: int = 1):\n \"\"\".\"\"\"\n ```\n - ```python\n def number_zero_pad(num: StrOrNumberType, length: StrOrNumberType) -> str:\n \"\"\".\"\"\"\n ```\n - ```python\n def is_number(item):\n \"\"\"Return whether or not the item is a number.\"\"\"\n ```\n - ```python\n def number_is_even(number: StrOrNumberType):\n \"\"\".\"\"\"\n ```\n - ```python\n def number_is_odd(number: StrOrNumberType):\n \"\"\".\"\"\"\n ```\n - ```python\n def number_is_approx(number, approximate_value, *, relative_tolerance=1e-6):\n \"\"\".\"\"\"\n ```\n - ```python\n def enumerate_range(range_string, range_split_string: str = '-'):\n \"\"\"Enumerate the range specified by the string. For example, `1-3` returns `[1, 2, 3]`.\"\"\"\n ```\n - ```python\n def hex_endiness_swap(hex_string):\n \"\"\"Credit to: https://stackoverflow.com/questions/27506474/how-to-byte-swap-a-32-bit-integer-in-python.\"\"\"\n ```\n - ```python\n def number_to_words(number):\n \"\"\"Convert a number to its English representation (e.g. 100 => \"One Hundred\").\"\"\"\n ```\n - ```python\n def number_to_scientific_notation(number):\n \"\"\"Convert the given number to scientific notation.\"\"\"\n ```\n - ```python\n def number_to_engineering_notation(number):\n \"\"\"Convert the given number to engineering notation.\"\"\"\n ```\n\n## Development\n\n\ud83d\udc4b If you want to get involved in this project, we have some short, helpful guides below:\n\n- [contribute to this project \ud83e\udd47][contributing]\n- [test it \ud83e\uddea][local-dev]\n- [lint it \ud83e\uddf9][local-dev]\n- [explore it \ud83d\udd2d][local-dev]\n\nIf you have any questions or there is anything we did not cover, please raise an issue and we'll be happy to help.\n\n## Credits\n\nThis package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and Floyd Hightower's [Python project template](https://github.com/fhightower-templates/python-project-template).\n\n[contributing]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#contributing-a-pr-\n[local-dev]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#local-development-\n\n\n",
"bugtrack_url": null,
"license": "GNU Lesser General Public License v3",
"summary": "Democritus functions for working with math.",
"version": "0.7.0",
"project_urls": {
"Homepage": "https://github.com/democritus-project/d8s-math"
},
"split_keywords": [
"democritus",
"utility",
"python",
"math",
"math-utility",
"math",
"maths"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cd8f8339663a443ab74d894c761fdb12edbf47f3096d50a6478a35247800529b",
"md5": "3aac56037c581c211604d3d0f21a3ab6",
"sha256": "a474237b72aee6669f343eb0cac056ba79673214e5976b923acdfd5898620719"
},
"downloads": -1,
"filename": "d8s_math-0.7.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3aac56037c581c211604d3d0f21a3ab6",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 30204,
"upload_time": "2021-05-21T11:35:41",
"upload_time_iso_8601": "2021-05-21T11:35:41.608793Z",
"url": "https://files.pythonhosted.org/packages/cd/8f/8339663a443ab74d894c761fdb12edbf47f3096d50a6478a35247800529b/d8s_math-0.7.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3cba1d675b372f82665f2c04c79b4a7cb668603c84bf531e82f7305187eca80e",
"md5": "cb82254e93e0e89f9c63759e60ca9c91",
"sha256": "32acfc784842def2e1f9a5c69cfb9e09887f8151a8483f434752badd40f7959f"
},
"downloads": -1,
"filename": "d8s_math-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "cb82254e93e0e89f9c63759e60ca9c91",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 39561,
"upload_time": "2021-05-21T11:35:42",
"upload_time_iso_8601": "2021-05-21T11:35:42.756276Z",
"url": "https://files.pythonhosted.org/packages/3c/ba/1d675b372f82665f2c04c79b4a7cb668603c84bf531e82f7305187eca80e/d8s_math-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-05-21 11:35:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "democritus-project",
"github_project": "d8s-math",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "d8s-math"
}
JSON
