0.2.1 DistanceTable

Author: RobTillaart

libraries/DistanceTable/.arduino-ci.yml

@@ -2,6 +2,10 @@ compile:
   # Choosing to run compilation tests on 2 different Arduino platforms
   platforms:
     - uno
-    - leonardo
-    - due
-    - zero
+    # - due
+    # - zero
+    # - leonardo
+    - m4
+    - esp32
+    # - esp8266
+    # - mega2560

libraries/DistanceTable/.github/workflows/arduino_test_runner.yml

@@ -4,10 +4,14 @@ name: Arduino CI
 on: [push, pull_request]
 
 jobs:
-  arduino_ci:
+  runTest:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v2
-      - uses: Arduino-CI/action@master
-          #   Arduino-CI/[email protected]
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+      - run: |
+          gem install arduino_ci
+          arduino_ci.rb

libraries/DistanceTable/DistanceTable.cpp

@@ -1,29 +1,31 @@
 //
 //    FILE: DistanceTable.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.0
+// VERSION: 0.2.1
 // PURPOSE: Arduino library to store a symmetrical distance table in less memory
 //     URL: https://github.com/RobTillaart/DistanceTable
 
-
+//  HISTORY
+//  0.1.00  initial version
+//  0.1.01  refactor
+//  0.1.2   fix overflow;  add some error detection;  revert float to float to memory
+//  0.1.3   2017-07-27  Fix issue #33
+//  0.1.4   2019-01-10  add size()
+//  0.1.5   2020-06-07  fix library.json, minor edits
+//  0.1.6   2020-12-20  arduino-ci + unit test
 //  0.2.0   2021-01-19  refactor
 //                      properly named functions, 
 //                      add setAll(), minimum(), maximum() and count()
-//  0.1.6   2020-12-20  arduino-ci + unit test
-//  0.1.5   2020-06-07  fix library.json, minor edits
-//  0.1.4   2019-01-10  add size()
-//  0.1.3   2017-07-27  Fix issue #33
-//  0.1.2   fix overflow;  add some error detection;  revert float to float to memory
-//  0.1.01  refactor
-//  0.1.00  initial version
+//  0.2.1   2021-10-26  update build-CI, update readme.md
+//                      default value in constructor
 
 
 #include "DistanceTable.h"
 
 
-DistanceTable::DistanceTable(uint8_t dimension)
+DistanceTable::DistanceTable(uint8_t dimension, float value)
 {
-  // ATMEL 328 has 2000 bytes mem,
+  // ATMEL 328 has ~2000 bytes RAM,
   // so roughly 30X30 = 900 floats(4Bytes) => 1740 bytes is max feasible
   _dimension = 0;
   _elements  = 0;
@@ -38,7 +40,7 @@ DistanceTable::DistanceTable(uint8_t dimension)
     _dimension = 0;
     _elements  = 0;
   }
-  setAll(0);
+  setAll(value);
 }
 
 
@@ -63,7 +65,7 @@ void DistanceTable::setAll(float value)
 void DistanceTable::set(uint8_t x, uint8_t y, float value )
 {
   if ( x == y ) return;
-  // comment next line to skip rangecheck (squeeze performance)
+  // comment next line to skip range check (squeeze performance)
   if ( (x >= _dimension) || (y >= _dimension)) return;
 
   if ( x < y )
@@ -80,7 +82,7 @@ void DistanceTable::set(uint8_t x, uint8_t y, float value )
 float DistanceTable::get (uint8_t x, uint8_t y)
 {
   if ( x == y ) return 0.0;  // TODO even true when x and y are out of range??
-  // comment next line to skip rangecheck (squeeze performance)
+  // comment next line to skip range check (squeeze performance)
   if ( (x >= _dimension) || (y >= _dimension)) return -1;  // NAN ?
 
   if ( x < y )

libraries/DistanceTable/DistanceTable.h

@@ -2,7 +2,7 @@
 //
 //    FILE: DistanceTable.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.2.0
+// VERSION: 0.2.1
 // PURPOSE: Arduino library to store a symmetrical distance table in less memory
 //     URL: https://github.com/RobTillaart/DistanceTable
 //
@@ -11,13 +11,13 @@
 #include "Arduino.h"
 
 
-#define DISTANCETABLE_LIB_VERSION     (F("0.2.0"))
+#define DISTANCETABLE_LIB_VERSION     (F("0.2.1"))
 
 
 class DistanceTable
 {
 public:
-  explicit DistanceTable(uint8_t dimension);
+  explicit DistanceTable(uint8_t dimension, float value = 0);
   ~DistanceTable();
 
   void     clear() { setAll(0); };
@@ -55,4 +55,5 @@ class DistanceTable
 
 };
 
+
 // --- END OF FILE ---

libraries/DistanceTable/library.json

@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/DistanceTable"
   },
-  "version": "0.2.0",
+  "version": "0.2.1",
   "license": "MIT",
   "frameworks": "arduino",
   "platforms": "*"

libraries/DistanceTable/library.properties

@@ -1,5 +1,5 @@
 name=DistanceTable
-version=0.2.0
+version=0.2.1
 author=Rob Tillaart <[email protected]>
 maintainer=Rob Tillaart <[email protected]>
 sentence=Library for a memory efficient DistanceTable for Arduino. 

libraries/DistanceTable/readme.md

@@ -1,5 +1,7 @@
 
 [![Arduino CI](https://github.com/RobTillaart/Distancetable/workflows/Arduino%20CI/badge.svg)](https://github.com/marketplace/actions/arduino_ci)
+[![Arduino-lint](https://github.com/RobTillaart/DistanceTable/actions/workflows/arduino-lint.yml/badge.svg)](https://github.com/RobTillaart/DistanceTable/actions/workflows/arduino-lint.yml)
+[![JSON check](https://github.com/RobTillaart/DistanceTable/actions/workflows/jsoncheck.yml/badge.svg)](https://github.com/RobTillaart/DistanceTable/actions/workflows/jsoncheck.yml)
 [![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/RobTillaart/Distancetable/blob/master/LICENSE)
 [![GitHub release](https://img.shields.io/github/release/RobTillaart/Distancetable.svg?maxAge=3600)](https://github.com/RobTillaart/Distancetable/releases)
 
@@ -13,7 +15,7 @@ Arduino library to store a symmetrical distance table in less memory.
 
 The DistanceTable library is a class that stores a symmetrical distance table 
 which is typically N x N entries in less memory space. 
-It uses (N x (N-1))/2 ("in a triangle") as an eucledian distance table is 
+It uses (N x (N-1))/2 ("in a triangle") as an euclidean distance table is 
 symmetrical around its main diagonal. 
 Furthermore as the main diagonal are all zero it does not need to be stored either.
 
@@ -25,15 +27,15 @@ Within the 2K RAM of an Arduino one could store normally a 21 x 21 matrix (1764
 
 ## Interface
 
-- **DistanceTable(uint8_t size)** Constructor, allocates memory and clears them.
+- **DistanceTable(uint8_t size, float value = 0.0)** Constructor, allocates memory and sets initial value to all elements.
 - **~DistanceTable();** Destructor, frees memory
 - **void clear()** sets all entries to 0.0.
-- **void setAll(value)** sets all entries to value;
+- **void setAll(float value)** sets all entries to value;
 - **void set(uint8_t x, uint8_t y, float value )** sets a value for (x,y) and automatically for (y, x)
 - **float get(uint8_t x, uint8_t y)** gets a value from (x,y). If x == y it will return 0.
-- **float minimum(uint8_t &x, uint8_t &y)** Returns minimum and first occurence in x and y. It does skip x == y pairs as these are 0.
-- **float maximum(uint8_t &x, uint8_t &y)** Returns maximum and first occurence in x and y. It does skip x == y pairs as these are 0.
-- **uint16_t count(value, epsilon)** counts the number of occurences of value. As we are comparing floats the epsilon can set a margin for 'almost equal'.
+- **float minimum(uint8_t &x, uint8_t &y)** Returns minimum and first occurrence in x and y. It does skip x == y pairs as these are 0.
+- **float maximum(uint8_t &x, uint8_t &y)** Returns maximum and first occurrence in x and y. It does skip x == y pairs as these are 0.
+- **uint16_t count(value, epsilon)** counts the number of occurrences of value. As we are comparing floats the epsilon can set a margin for 'almost equal'.
 
 
 
@@ -47,13 +49,12 @@ Within the 2K RAM of an Arduino one could store normally a 21 x 21 matrix (1764
 
 ## Future
 
-- **count()** could get an epsilon to count also nearly hits (default 0.0);
-- **clear()** could set all to NAN? is that better as it iindicates unknown?  
+- **clear()** could set all to NAN? is that better as it indicates unknown?  
   setAll() let the user decide.
 
 
-Note: table can be used for other symmetrical 2D tables. And therefor include 
-negative values.
+Note: table can be used for other symmetrical 2D tables. 
+And therefore include negative values.
 
 
 ## Operational