fixed

Реализация 32-бит типа с фиксированной точкой для Arduino

• Размер дробной части (точность) на выбор
• Перегружены все операторы для удобства
• Все методы сделаны constexpr
• Литеральные суффиксы для цифр в программе
• Вычисления в 2-4 раза быстрее float
• Поддержка всех операций занимает на 1.5 кБ меньше float

Совместимость

Совместима со всеми Arduino платформами (используются Arduino-функции)

Содержание

• Использование
• Пример
• Версии
• Установка
• Баги и обратная связь

Использование

Тип fixed можно просто использовать как тип данных вместо float.

Класс

fixed(любой тип);

int32_t getRaw();
int32_t toInt();
float toFloat();

static int32_t MAX_INT;
static int32_t MIN_INT;

Точность

По умолчанию fixed имеет 16 бит под целое и 16 бит под дробное, но есть варианты:

	Точность, бит	Точность, мин.	Целая часть, +-макс.
fixedT<дробных_бит>	На выбор	1 / 2^бит	2^(31 - бит)
fixed8	8	0.0039	8'388'608
fixed16	16	0.000015	32'768
fixed24	24	0.00000006	128

Переполнение * и /

По умолчанию деление и умножение (у сложения и вычитания этой проблемы нет) выполняются в 32-бит ячейке, что выполняется очень быстро, но легко переполняется - нужно правильно выбрать размер целой части под свой диапазон значений. Можно переключиться на 64-бит вычисления:

#define FIXED_USE_64
#include <fixed.h>

В этом случае все вычисления будут корректными, но на некоторых платформах размер кода и скорость выполнения почти сравняются с float и фиксированная точка потеряет смысл.

Литералы

В программе можно добавлять к числам литералы, например 3.14_fx8 это число 3.14 сразу в формате fixed8, т.е. аналог вызова fixed8(3.14), а 123_fx16 - в формате fixed16.

Пример

#include <fixed.h>

void setup() {
  Serial.begin(115200);

  fixed f;
  f = 123;
  f += 0.456;

  Serial.println(f.toFloat());

  fixed f2 = (12.34 + f * 123) / 12;

  Serial.println(f2.toInt());

  // авто-конвертация
  int iv = f2;
  float fv = f2;

  // сравнение
  if (f2) {}
  f2 == 123;
  f2 > 3.14;

  // действия
  f2 = -f2;
  f2 += 123;
  f2 += f;
}

void loop() {
}

Версии

• v1.0
• v2.0 - библиотека переписана, улучшена, добавлены операторы и constexpt

Установка

• Библиотеку можно найти по названию fixed и установить через менеджер библиотек в:
  • Arduino IDE
  • Arduino IDE v2
  • PlatformIO
• Скачать библиотеку .zip архивом для ручной установки:
  • Распаковать и положить в C:\Program Files (x86)\Arduino\libraries (Windows x64)
  • Распаковать и положить в C:\Program Files\Arduino\libraries (Windows x32)
  • Распаковать и положить в Документы/Arduino/libraries/
  • (Arduino IDE) автоматическая установка из .zip: Скетч/Подключить библиотеку/Добавить .ZIP библиотеку… и указать скачанный архив
• Читай более подробную инструкцию по установке библиотек здесь

Обновление

• Рекомендую всегда обновлять библиотеку: в новых версиях исправляются ошибки и баги, а также проводится оптимизация и добавляются новые фичи
• Через менеджер библиотек IDE: найти библиотеку как при установке и нажать "Обновить"
• Вручную: удалить папку со старой версией, а затем положить на её место новую. "Замену" делать нельзя: иногда в новых версиях удаляются файлы, которые останутся при замене и могут привести к ошибкам!

Баги и обратная связь

При нахождении багов создавайте Issue, а лучше сразу пишите на почту [email protected]
Библиотека открыта для доработки и ваших Pull Request'ов!

При сообщении о багах или некорректной работе библиотеки нужно обязательно указывать:

• Версия библиотеки
• Какой используется МК
• Версия SDK (для ESP)
• Версия Arduino IDE
• Корректно ли работают ли встроенные примеры, в которых используются функции и конструкции, приводящие к багу в вашем коде
• Какой код загружался, какая работа от него ожидалась и как он работает в реальности
• В идеале приложить минимальный код, в котором наблюдается баг. Не полотно из тысячи строк, а минимальный код