Easy Numbers

`py_simple.easy_numbers`

easy_numbers is built to simplify different types of number operations.

`average(nums)`

Returns the average of a list of numbers.

Parameters:

Name	Type	Description	Default
`nums`	`list[float]`	List of numbers to average.	required

Returns:

Name	Type	Description
`float`	`float`	The average, rounded to 2 decimal places.

Example

The Py_simple WayThe Traditional Way

from py_simple import average

result = average([1.5, 2, 3])  # -> 2.17

nums = [1.5, 2, 3]
result = round(sum(nums) / len(nums), 2)

`clamp(number, minimum, maximum)`

Keeps a number within a minimum and maximum range.

Parameters:

Name	Type	Description	Default
`number`	`float`	Number to clamp.	required
`minimum`	`float`	Minimum allowed value.	required
`maximum`	`float`	Maximum allowed value.	required

Returns:

Name	Type	Description
`float`	`float`	Clamped number.

Example

The Py_simple WayThe Traditional Way

from py_simple import clamp

result = clamp(15, 0, 10)  # -> 10

number, minimum, maximum = 15, 0, 10
result = max(minimum, min(number, maximum))

`greatest_common_divisor(a, b)`

Returns the greatest common divisor (GCD) of two numbers.

Parameters:

Name	Type	Description	Default
`a`	`int`	First number.	required
`b`	`int`	Second number.	required

Returns:

Name	Type	Description
`int`	`int`	Greatest common divisor.

Example

The Py_simple WayThe Traditional Way

from py_simple import greatest_common_divisor

result = greatest_common_divisor(12, 18)  # -> 6

import math

a, b = 12, 18
result = math.gcd(a, b)

`is_even(number)`

Returns true if the number is even and false if it is odd.

Parameters:

Name	Type	Description	Default
`number`	`int`	Number to check.	required

Returns:

Name	Type	Description
`bool`	`bool`	True if even, False if odd.

Example

The Py_simple WayThe Traditional Way

from py_simple import is_even

result = is_even(90)  # -> True

number = 90
result = number % 2 == 0

`is_evenly_divisible(number, divisor)`

Returns true if the number can be evenly divided by divisor.

Parameters:

Name	Type	Description	Default
`number`	`int`	Number to check.	required
`divisor`	`int`	Number to divide by.	required

Returns:

Name	Type	Description
`bool`	`bool`	True if number divides evenly by divisor, False otherwise.

Example

The Py_simple WayThe Traditional Way

from py_simple import is_evenly_divisible

result = is_evenly_divisible(90, 9)  # -> True

number, divisor = 90, 9
result = number % divisor == 0

`is_negative(number)`

Returns true if the number is negative and false if it is positive.

Parameters:

Name	Type	Description	Default
`number`	`int`	Number to check.	required

Returns:

Name	Type	Description
`bool`	`bool`	True if negative, False otherwise.

Example

The Py_simple WayThe Traditional Way

from py_simple import is_negative

result = is_negative(-10)  # -> True

number = -10
result = number < 0

`is_odd(number)`

Returns true if the number is odd and false if it is even.

Parameters:

Name	Type	Description	Default
`number`	`int`	Number to check.	required

Returns:

Name	Type	Description
`bool`	`bool`	True if odd, False if even.

Example

The Py_simple WayThe Traditional Way

from py_simple import is_odd

result = is_odd(67)  # -> True

number = 67
result = number % 2 == 1

`is_positive(number)`

Returns true if the number is positive and false if it is negative.

Parameters:

Name	Type	Description	Default
`number`	`int`	Number to check.	required

Returns:

Name	Type	Description
`bool`	`bool`	True if positive, False otherwise.

Example

The Py_simple WayThe Traditional Way

from py_simple import is_positive

result = is_positive(90)  # -> True

number = 90
result = number > 0

`is_prime(number)`

Returns true if the number is prime and false if it is not.

Parameters:

Name	Type	Description	Default
`number`	`int`	Number to check.	required

Returns:

Name	Type	Description
`bool`	`bool`	True if prime, False otherwise.

Example

The Py_simple WayThe Traditional Way

from py_simple import is_prime

result = is_prime(2)  # -> True

def is_prime(n):
    if n < 2:
        return False
    for i in range(2, int(n ** 0.5) + 1):
        if n % i == 0:
            return False
    return True

result = is_prime(2)

`percentage_of(number, percentage)`

Returns percentage of number as a float.

Parameters:

Name	Type	Description	Default
`number`	`int`	Number to get percentage of.	required
`percentage`	`float`	Percentage to get, between 0 and 1 (e.g. 0.5, 0.75).	required

Returns:

Name	Type	Description
`float`	`float`	The calculated percentage, rounded to 2 decimal places.

Example

The Py_simple WayThe Traditional Way

from py_simple import percentage_of

result = percentage_of(100, 0.5)  # -> 50.0

number, percentage = 100, 0.5
result = round(number * percentage, 2)

`round_to_nearest(number, nearest)`

Returns a number rounded to the nearest multiple.

Parameters:

Name	Type	Description	Default
`number`	`float`	Number to round.	required
`nearest`	`int`	Multiple to round to.	required

Returns:

Name	Type	Description
`float`	`float`	Rounded number.

Example

The Py_simple WayThe Traditional Way

from py_simple import round_to_nearest

result = round_to_nearest(23, 5)  # -> 25.0

number, nearest = 23, 5
result = round(number / nearest) * nearest