Develop (#3)

* add unit tests
* fix negative numbers

Author: RobTillaart

README.md

@@ -25,22 +25,43 @@ a floating point number. As it is only 2 bytes where float and double have typic
 4 and 8, gains can be made at the price of range and precision.
 
 
-## specs
+## Specifications
 
-To elaborate table
 
-| attribute | value      |
-|:---------:|:----------:|
-| Size      | 2 bytes    |
-| mantissa  |            |
-| exponent  |            |
-| minimum   |            |
-| maximum   |            |
+| attribute | value        |  notes       |
+|:----------|:-------------|:-------------|
+| Size      | 2 bytes      |              |
+| sign      | 1 bit        |              |
+| mantissa  | 11 bit       | ~ 3 digits   |
+| exponent  | 4 bit        |              |
+| minimum   | 1.0009765625 |  1 + 2^−10   |
+| maximum   | 65504        |              |
+|           |              |              |
 
 
 ## Interface
 
-See float16.h for a list of functions implemented.
+to elaborate
+
+#### Constructors
+
+- **float16(void)** defaults to zero.
+- **float16(double f)** constructor.
+- **float16(const float16 &f)** copy constructor.
+
+
+#### Conversion
+
+- **double toDouble(void)** convert to double (or float)
+- **size_t printTo(Print& p) const** Printable interface.
+- **void setDecimals(uint8_t d)** idem, used for printTo.
+- **uint8_t getDecimals()** idem.
+
+Note the setDecimals takes one byte per object which is not efficient for arrays.
+See array example for efficient storage using set/getBinary() functions.
+
+
+#### Compare
 
 to elaborate
 
@@ -56,16 +77,47 @@ The strategy is to get these working first and optionally optimize them later.
 
 ## TODO (future)
 
-not in priority order.
+to get focus on getting things done...
+
+
+#### 0.1.4
+
+the following should work:
+
+- update documentation
+- positive numbers
+- negative numbers
+- infinity
+- rounding to zero (e.g. 1e-30)
+- array of numbers.
+- unit tests of the above..
+
+
+#### 0.1.5
+
+- update documentation
+- comparison operators
+- unit tests of the above..
+
+
+#### 0.1.6
 
 - update documentation
 - get basic math working (+-*/)
-- divide by zero errors.
-- f16tof32() + f32tof16()
-- rewrite toDouble with bit magic
 - isNan()
 - isINF()
 - abs()
 - sgn()
+- unit tests of the above..
+
+
+#### later
+
+- update documentation
+- get basic math II working += -= *= /=
+- divide by zero errors.
+- f16tof32() + f32tof16()
+- rewrite toDouble with bit magic
+- ...
 
 

examples/float16_test0/float16_test0.ino

@@ -31,14 +31,16 @@
 
 #include "float16.h"
 
-uint32_t start;
-uint32_t stop;
 
 void setup()
 {
+  while(!Serial);
   Serial.begin(115200);
-  Serial.print("Start float16_test0,  LIB_VERSION: ");
+  Serial.println(__FILE__);
+  Serial.print("FLOAT16_LIB_VERSION: ");
   Serial.println(FLOAT16_LIB_VERSION);
+  Serial.println("\nStart ");
+
   Serial.println();
 
   test_constructors();

examples/float16_test1/float16_test1.ino

@@ -1,25 +1,25 @@
 //
-//    FILE: .ino
+//    FILE: float16_test1.ino
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.00
-// PURPOSE:
-//    DATE:
-//     URL:
-//
-// Released to the public domain
+// VERSION: 0.1.0
+// PURPOSE: test float16
+//    DATE: 2015-03-11
+//     URL: https://github.com/RobTillaart/float16
 //
 
 #include "float16.h"
 
 float16 X;
 
-uint32_t start;
-uint32_t stop;
 
 void setup()
 {
+  while(!Serial);
   Serial.begin(115200);
-  Serial.println("Start ");
+  Serial.println(__FILE__);
+  Serial.print("FLOAT16_LIB_VERSION: ");
+  Serial.println(FLOAT16_LIB_VERSION);
+  Serial.println("\nStart ");
 
   float f;
 
@@ -29,11 +29,12 @@ void setup()
     Serial.print(n);
     Serial.print('\t');
     Serial.println(f, 6);
-
   }
-  Serial.println("done");
+
+  Serial.println("\ndone");
 }
 
+
 void loop()
 {
 }

examples/float16_test_array/float16_test_array.ino

@@ -0,0 +1,80 @@
+//
+//    FILE: float16_test_array.ino
+//  AUTHOR: Rob Tillaart
+// VERSION: 0.1.0
+// PURPOSE: test float16
+//    DATE: 2015-03-11
+//     URL: https://github.com/RobTillaart/float16
+//
+
+// show different storage needs 
+
+#include "float16.h"
+
+float16 temperature[10];   // pointers + object are stored.
+uint16_t temp2[10];        // only raw data is stored.
+
+
+void setup()
+{
+  while (!Serial);
+  Serial.begin(115200);
+  Serial.println(__FILE__);
+  Serial.print("FLOAT16_LIB_VERSION: ");
+  Serial.println(FLOAT16_LIB_VERSION);
+  Serial.println("\nStart ");
+
+  // simulate temperature with random numbers
+  for (uint32_t n = 0; n < 10; n++)
+  {
+    temperature[n] = (random(1000) - 300) * 0.01;
+    temp2[n] = temperature[n].getBinary();
+  }
+  Serial.println();
+
+
+  float average = 0;
+  for (uint32_t n = 0; n < 10; n++)
+  {
+    Serial.print(n);
+    Serial.print("\t");
+    Serial.print(temperature[n].toDouble());
+    Serial.println();
+    average += temperature[n].toDouble();
+  }
+  Serial.print("\t");
+  Serial.println(average * 0.01);
+  Serial.println();
+
+
+  average = 0;
+  for (uint32_t n = 0; n < 10; n++)
+  {
+    float16 f16;
+    f16.setBinary(temp2[n]);
+    Serial.print(n);
+    Serial.print("\t");
+    Serial.print(f16.toDouble());
+    Serial.println();
+    average += f16.toDouble();
+  }
+  Serial.print("\t");
+  Serial.println(average * 0.01);
+  Serial.println();
+
+
+  Serial.print("SIZE: ");
+  Serial.println(sizeof(temperature));
+  Serial.print("SIZE: ");
+  Serial.println(sizeof(temp2));
+
+  Serial.println("\ndone");
+}
+
+
+void loop()
+{
+}
+
+
+// -- END OF FILE --

examples/float16_test_negative/float16_test_negative.ino

@@ -0,0 +1,40 @@
+//
+//    FILE: float16_test_negative.ino
+//  AUTHOR: Rob Tillaart
+// VERSION: 0.1.0
+// PURPOSE: test float16
+//    DATE: 2021-11-26
+//     URL: https://github.com/RobTillaart/float16
+//
+
+#include "float16.h"
+
+
+void setup()
+{
+  while(!Serial);
+  Serial.begin(115200);
+  Serial.println(__FILE__);
+  Serial.print("FLOAT16_LIB_VERSION: ");
+  Serial.println(FLOAT16_LIB_VERSION);
+  Serial.println("\nStart ");
+
+
+  for( int i = -10; i < 2; i++)
+  {
+    float16 f16(i);
+    Serial.print(i);
+    Serial.print("\t");
+    Serial.println(f16.toDouble(), 4);
+  }
+
+  Serial.println("\ndone");
+}
+
+
+void loop()
+{
+}
+
+
+// -- END OF FILE --

examples/float16_test_performance/float16_test_performance.ino

@@ -0,0 +1,52 @@
+//
+//    FILE: float16_test_performance.ino
+//  AUTHOR: Rob Tillaart
+// VERSION: 0.1.0
+// PURPOSE: test float16
+//    DATE: 2021-11-26
+//     URL: https://github.com/RobTillaart/float16
+//
+
+// TO ELABORATE
+
+#include "float16.h"
+
+uint32_t start, stop;
+volatile float f;
+
+
+void setup()
+{
+  while (!Serial);
+  Serial.begin(115200);
+  Serial.println(__FILE__);
+  Serial.print("FLOAT16_LIB_VERSION: ");
+  Serial.println(FLOAT16_LIB_VERSION);
+  Serial.println("\nStart ");
+
+  f = random(1000000) * 0.001;
+
+  start = micros();
+  float16 f16(f);
+  stop = micros();
+  Serial.print("Constructor: \t");
+  Serial.println(stop - start);
+  delay(10);
+
+  start = micros();
+  f = f16.toDouble();
+  stop = micros();
+  Serial.print("toDouble(): \t");
+  Serial.println(stop - start);
+  delay(10);
+
+  Serial.println("\ndone");
+}
+
+
+void loop()
+{
+}
+
+
+// -- END OF FILE --