Skip to content

Commit fd21987

Browse files
authored
docs: add text about true_round to the documentation section
1 parent 63deb8c commit fd21987

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ pip install pycustomrand
9595

9696

9797
## 📚 Документация
98-
Ниже представлено описание всех доступных функций библиотеки. Для удобства они импортируются напрямую из пакета (`pycustomrand.FUNC_NAME`).
98+
Ниже представлено описание всех доступных функций библиотеки. Для удобства они могут импороваться напрямую из пакета (`from pycustomrand import FUNC_NAME`).
9999

100100
### 1. Управление состоянием (Seeding)
101101
Инициализация генератора позволяет получать воспроизводимые последовательности (например, для тестов или сохранения генерации мира).
@@ -173,6 +173,20 @@ pip install pycustomrand
173173

174174
* `random_bool(true_chance=0.5)`: Возвращает True или False c вероятностью `true_chance`.
175175

176+
### 🎯 О модуле `true_round`
177+
Модуль решает проблему "банковского округления" в Python 3, где `round(x.5)` округляется до ближайшего чётного числа.
178+
`true_round` использует **честное математическое округление** (отсюда и название "true" — истинное/честное).
179+
180+
Для удобства модуль может быть импортирован напрямую из пакета (`from pycustomrand import true_round`).
181+
182+
| Число | Стандартный `round()` | PyCustomRand `true_round()` | Примечание |
183+
| :--- | :---: | :---: | :--- |
184+
| **2.5** | 2 | **3** | Математическое округление (0.5 → вверх) |
185+
| **3.5** | 4 | **4** | Совпадает |
186+
| **2.675** (до 2-ух знаков) | 2.67 | **2.68** | Исправление погрешности Floating Point Error |
187+
| **1.005** (до 2-ух знаков) | 1.0 | **1.01** | Корректная обработка граничных значений |
188+
| **0.00049** (до 3-ёх знаков) | 0.0 | **0.001** | Точность при работе с малыми числами |
189+
176190

177191
## 📂 Структура репозитория
178192
Проект имеет следующую файловую структуру:

0 commit comments

Comments
 (0)