Geometric Functions

Общее описание

Проект содержит простые математические функции для демонстрации принципов документирования кода.
В текущей версии реализованы функции для возведения числа в квадрат и для сложения чисел с выводом результата в двоичной системе.

---

Описание функций

1. square(n: int) -> int

Принимает число n, возвращает его квадрат.

Параметры:

• n (int) — число для возведения в квадрат

Возвращает:

• int — квадрат числа n

Пример:

>>> square(5)
25

add_binary(a: int, b: int) -> str

Возвращает сумму двух десятичных чисел в двоичном формате.

Функция принимает два аргумента a и b, складывает их в десятичной системе и переводит результат в двоичную систему счисления. Для этого используется встроенная функция Python bin(), которая возвращает строку в формате '0b...'. Чтобы убрать префикс '0b', применяется срез строки [2:]. В итоге остаётся только двоичное представление числа.

Параметры:

a (int) — первое десятичное целое число

b (int) — второе десятичное целое число

Возвращает:

str — двоичная строка суммы a и b

Примеры:

>>> add_binary(5, 3)
'1000'   # так как 5 + 3 = 8, а 8 в двоичной системе = 1000

>>> add_binary(2, 6)
'1000'   # 2 + 6 = 8 → '1000'

>>> add_binary(7, 1)
'1000'   # 7 + 1 = 8 → '1000'

>>> add_binary(4, 4)
'1000'   # 4 + 4 = 8 → '1000'