Merge branch 'develop'

Author: gbmhunter

.gitignore

@@ -1,3 +1,4 @@
 build/
 cmake-build-debug/
-.idea/workspace.xml
+.idea/workspace.xml
+.vscode/

CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [v8.0.2] - 2019-05-22
+
+### Added
+- `.vscode/` directory added to `.gitignore`.
+
+### Fixed
+- Fixed bug where the `FpF` class was calculating incorrect results when peforming certain arithmetic (and when constructing), due to hard coded use of `int32_t`, where instead it should be using `BaseClass` (thanks [TheZoq2](https://github.com/TheZoq2) for finding this and sending in a MR). Added unit tests to prevent regresison.
+- Fixed URL to git repo in build section of README.
+- Updated dependencies in README.
+
 ## [v8.0.1] - 2018-06-02
 
 ### Fixed

README.rst

@@ -161,7 +161,7 @@ The cmake method will build the fixed point library and automatically runs all u
 
 .. code:: bash
 
-	~$ git clone https://github.com/mbedded-ninja/MFixedPoint.git
+	~$ git clone https://github.com/gbmhunter/MFixedPoint.git
 	~$ cd MFixedPoint
 	~/MFixedPoint$ mkdir build
 	~/MFixedPoint$ cd build
@@ -253,6 +253,9 @@ The following table lists all of MFixedPoint's dependencies.
 ====================== ==================== ======================================================================
 Dependency             Delivery             Usage
 ====================== ==================== ======================================================================
-<cstdint>              C standard library   For platform agnostic fixed-width integers.
+<cstdint.h>            C std lib.           For platform agnostic fixed-width integers.
+<ostream>              C++ std lib.
+<string>               C++ std lib.
+<type_traits>          C++ std lib.
 MUnitTest              External module      Framework for unit tests.
 ====================== ==================== ======================================================================

include/MFixedPoint/FpF.hpp

@@ -42,7 +42,7 @@ namespace MFixedPoint {
 /// 			prevent intermediary overflow problems.
 /// \note 		Slower than FpF::FixMulF()
 template<class BaseType, class OverflowType, uint8_t numFracBits>
-inline BaseType FpFMultiply(int32_t a, int32_t b) {
+inline BaseType FpFMultiply(BaseType a, BaseType b) {
     return (BaseType) (((OverflowType) a * b) >> numFracBits);
 }
 
@@ -204,13 +204,13 @@ class FpF {
     }
 
     FpF(int8_t i) :
-            rawVal_((int32_t) i << numFracBits) {}
+            rawVal_((BaseType) i << numFracBits) {}
 
     FpF(int16_t i) :
-            rawVal_((int32_t) i << numFracBits) {}
+            rawVal_((BaseType) i << numFracBits) {}
 
     FpF(int32_t i) :
-            rawVal_(i << numFracBits) {}
+            rawVal_((BaseType)i << numFracBits) {}
 
     /// \brief		Constructor that accepts a float.
     FpF(float f) :

test/FpF/FpFConversions.cpp

@@ -3,7 +3,7 @@
 //! \author 			Geoffrey Hunter <[email protected]> (www.mbedded.ninja)
 //! \edited 			n/a
 //! \created			2013-07-22
-//! \last-modified		2018-01-10
+//! \last-modified		2019-05-22
 //! \brief 				Performs unit tests on the fixed point FpF class.
 //! \details
 //!						See README.rst in root dir for more info.
@@ -18,12 +18,6 @@ using namespace mn::MFixedPoint;
 
 MTEST_GROUP(FpFConversions) {
 
-	// MTEST(README) {
-	// 	FpS32 fp1(2.22, 8);	
-	// 	printf("ToInt<int32_t>() = %i\n", fp1.ToInt<int32_t>()); // Prints "ToInt<int32_t>() = 2"
-	// 	printf("ToDouble() = %.2f\n", fp1.ToDouble()); // Prints "ToDouble() = 2.22"
-	// }
-
 	// Check double->fixed conversion first as the
 	// rest of the tests depend on it
 	MTEST(PositiveDoubleToFixedConversionTest) {
@@ -80,4 +74,9 @@ MTEST_GROUP(FpFConversions) {
 		FpF32<15> fp1(-34.982);
         CHECK_CLOSE((double)fp1, -34.982, 0.01);
 	}
+
+	MTEST(ConstructFromIntTest) {
+		FpF<int64_t, int64_t, 25> fp1 = 75;
+		CHECK_CLOSE(fp1.ToInt<int64_t>(), 75, 0.1);		
+	}
 }

test/FpF/FpFWithFpFArithmeticTests.cpp

@@ -3,7 +3,7 @@
 //! \author 			Geoffrey Hunter <[email protected]> (www.mbedded.ninja)
 //! \edited 			n/a
 //! \created			2013-07-22
-//! \last-modified		2018-02-11
+//! \last-modified		2019-05-22
 //! \brief 				Performs unit tests on the fixed point FpF class.
 //! \details
 //!						See README.rst in root dir for more info.
@@ -18,16 +18,6 @@ using namespace mn::MFixedPoint;
 
 MTEST_GROUP(FpFArithmeticTests) {
 
-	// MTEST(ArithmeticOnReadme) {
-	// 	FpS32 fp1(5.0, 8);
-	// 	FpS32 fp2(1.5, 8);
-
-	// 	printf("add = %.2f\n", (fp1 + fp2).ToDouble());
-	// 	printf("sub = %.2f\n", (fp1 - fp2).ToDouble());
-	// 	printf("mult = %.2f\n", (fp1 * fp2).ToDouble());
-	// 	printf("div = %.2f\n", (fp1 / fp2).ToDouble());
-	// }
-
 	MTEST(AdditionSameNumFracBits) {
 		FpF32<8> fp1(1.11);
 		FpF32<8> fp2(2.22);
@@ -77,6 +67,13 @@ MTEST_GROUP(FpFArithmeticTests) {
 		CHECK_CLOSE(fp3.ToDouble(), 1.92, 0.1);		
 	}
 
+	MTEST(OverflowMultiplicationTest) {
+		FpF<int64_t, int64_t, 20> fp1(-4000.0);
+		FpF<int64_t, int64_t, 20> fp2(-0.01);
+		auto fp3 = fp1 * fp2;
+		CHECK_CLOSE(fp3.ToDouble(), 40.0, 0.1);		
+	}
+
 	MTEST(PositiveDivisionTest)	{
 		FpF32<12> fp1(3.2);
 		FpF32<12> fp2(0.6);		

test/FpS/FpSArithmeticTests.cpp

@@ -3,7 +3,7 @@
 //! \author 			Geoffrey Hunter <[email protected]> (www.mbedded.ninja)
 //! \edited 			n/a
 //! \created			2013-07-22
-//! \last-modified		2018-01-08
+//! \last-modified		2019-05-22
 //! \brief 				Performs unit tests on the fixed point FpS class.
 //! \details
 //!						See README.rst in root dir for more info.
@@ -18,16 +18,6 @@ using namespace mn::MFixedPoint;
 
 MTEST_GROUP(FpSArithmeticTests) {
 
-	// MTEST(ArithmeticOnReadme) {
-	// 	FpS32 fp1(5.0, 8);
-	// 	FpS32 fp2(1.5, 8);
-
-	// 	printf("add = %.2f\n", (fp1 + fp2).ToDouble());
-	// 	printf("sub = %.2f\n", (fp1 - fp2).ToDouble());
-	// 	printf("mult = %.2f\n", (fp1 * fp2).ToDouble());
-	// 	printf("div = %.2f\n", (fp1 / fp2).ToDouble());
-	// }
-
 	MTEST(AdditionSameNumFracBits) {
 		FpS32 fp1(1.11, 8);
 		FpS32 fp2(2.22, 8);
@@ -101,6 +91,13 @@ MTEST_GROUP(FpSArithmeticTests) {
 		CHECK_CLOSE(1.92, fp3.ToDouble(), 0.1);
 	}
 
+	MTEST(OverflowMultiplicationTest) {
+		FpS<int64_t, int64_t> fp1(-4000.0, 20);
+		FpS<int64_t, int64_t> fp2(-0.01, 20);
+		auto fp3 = fp1 * fp2;
+		CHECK_CLOSE(fp3.ToDouble(), 40.0, 0.1);		
+	}
+
 	MTEST(PositiveDivisionTest)	{
 		FpS32 fp1(3.2, 12);
 		FpS32 fp2(0.6, 12);		

test/FpS/FpSConstructors.cpp

@@ -3,7 +3,7 @@
 //! \author 			Geoffrey Hunter <[email protected]> (www.mbedded.ninja)
 //! \edited 			n/a
 //! \created			2018-01-08
-//! \last-modified		2017-01-08
+//! \last-modified		2019-05-22
 //! \brief 				Performs unit tests on the fixed point FpS class.
 //! \details
 //!						See README.rst in root dir for more info.
@@ -18,11 +18,16 @@ using namespace mn::MFixedPoint;
 
 MTEST_GROUP(FpSTests) {
 
-	MTEST(CreateFromInteger)	{
+	MTEST(CreateFromIntFpS32)	{
 		FpS32 fp1(34, 0);		
         CHECK_EQUAL(fp1.GetRawVal(), 34 << 0);
 	}
 
+	MTEST(CreateFromIntFpS64) {
+		FpS<int64_t, int64_t> fp1(75, 20);
+		CHECK_CLOSE(fp1.ToInt<int64_t>(), 75, 0.1);		
+	}
+
 	MTEST(CreateFromFloat)	{
 		FpS32 fp1(34.2f, 8);		
         CHECK_EQUAL(fp1.GetRawVal(), (int32_t)(34.2f * (1 << 8)));