diff --git a/libraries/Complex/CHANGELOG.md b/libraries/Complex/CHANGELOG.md index 7cf12191..56e27666 100644 --- a/libraries/Complex/CHANGELOG.md +++ b/libraries/Complex/CHANGELOG.md @@ -6,12 +6,15 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/). +## [0.3.3] - 2023-10-18 +- update readme.md + + ## [0.3.2] - 2022-10-29 - add changelog.md - add rp2040 to build-CI - minor edit unit test - ## [0.3.1] - 2021-12-14 - update library.json - update license diff --git a/libraries/Complex/README.md b/libraries/Complex/README.md index d517ae11..c005b157 100644 --- a/libraries/Complex/README.md +++ b/libraries/Complex/README.md @@ -2,8 +2,11 @@ [![Arduino CI](https://github.com/RobTillaart/Complex/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci) [![Arduino-lint](https://github.com/RobTillaart/Complex/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/Complex/actions/workflows/arduino-lint.yml) [![JSON check](https://github.com/RobTillaart/Complex/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/Complex/actions/workflows/jsoncheck.yml) +[![GitHub issues](https://img.shields.io/github/issues/RobTillaart/Complex.svg)](https://github.com/RobTillaart/Complex/issues) + [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/Complex/blob/master/LICENSE) [![GitHub release](https://img.shields.io/github/release/RobTillaart/Complex.svg?maxAge=3600)](https://github.com/RobTillaart/Complex/releases) +[![PlatformIO Registry](https://badges.registry.platformio.org/packages/robtillaart/library/Complex.svg)](https://registry.platformio.org/libraries/robtillaart/Complex) # Complex @@ -23,6 +26,10 @@ in any stream e.g. Serial. ## Interface +```cpp +#include "Complex.h" +``` + See Complex.h for a full list of functions implemented. The library uses **float** for the real and imaginary part so precision is limited. @@ -58,9 +65,31 @@ so it won't include the Complex.h file. Problem seen on Due and Teensy3.5 ## Future +#### Must + +- improve documentation + +#### Should + +#### Could + - create a (8 byte) double based variant for high precision e.g. Complex8() -Note that some platforms map double to float, others support float in hardware etc -so there is a big difference expected in both memory and performance + - Note that some platforms map double to float + - others support float in hardware etc. + - so expect a big difference in both memory and performance. + +#### Wont + - create the constant **i** ?? + - => expect conflicts with int i... + + +## Support + +If you appreciate my libraries, you can support the development and maintenance. +Improve the quality of the libraries by providing issues and Pull Requests, or +donate through PayPal or GitHub sponsors. + +Thank you, diff --git a/libraries/Complex/complex.cpp b/libraries/Complex/complex.cpp index 4229377b..43ed1270 100644 --- a/libraries/Complex/complex.cpp +++ b/libraries/Complex/complex.cpp @@ -1,12 +1,10 @@ // // FILE: Complex.cpp // AUTHOR: Rob Tillaart -// VERSION: 0.3.2 +// VERSION: 0.3.3 // PURPOSE: Arduino library for Complex math // URL: https://github.com/RobTillaart/Complex // http://arduino.cc/playground/Main/ComplexMath -// -// HISTORY: see changelog.md #include "Complex.h" diff --git a/libraries/Complex/complex.h b/libraries/Complex/complex.h index 195600da..9d5dbbfb 100644 --- a/libraries/Complex/complex.h +++ b/libraries/Complex/complex.h @@ -2,7 +2,7 @@ // // FILE: Complex.h // AUTHOR: Rob Tillaart -// VERSION: 0.3.2 +// VERSION: 0.3.3 // PURPOSE: Arduino library for Complex math // URL: https://github.com/RobTillaart/Complex // http://arduino.cc/playground/Main/ComplexMath @@ -12,7 +12,7 @@ #include "Printable.h" -#define COMPLEX_LIB_VERSION (F("0.3.2")) +#define COMPLEX_LIB_VERSION (F("0.3.3")) class Complex: public Printable diff --git a/libraries/Complex/library.json b/libraries/Complex/library.json index aac3ebda..0f489f75 100644 --- a/libraries/Complex/library.json +++ b/libraries/Complex/library.json @@ -15,9 +15,9 @@ "type": "git", "url": "https://github.com/RobTillaart/Complex.git" }, - "version": "0.3.2", + "version": "0.3.3", "license": "MIT", - "frameworks": "arduino", + "frameworks": "*", "platforms": "*", "headers": "Complex.h" } diff --git a/libraries/Complex/library.properties b/libraries/Complex/library.properties index 3432609c..70667cdb 100644 --- a/libraries/Complex/library.properties +++ b/libraries/Complex/library.properties @@ -1,5 +1,5 @@ name=Complex -version=0.3.2 +version=0.3.3 author=Rob Tillaart maintainer=Rob Tillaart sentence=Arduino library for Complex math.