Further code cleanups and documentation.

- Coverity defects.
- Documentation.

include/scmp/filter/Madgwick.h

@@ -1,5 +1,5 @@
 ///
-/// \file Madwick.cc
+/// \file Madgwick.h
 /// \author K. Isom <kyle@imap.cc>
 /// \date 2019-08-06
 /// \brief Implementation of a Madgwick filter.
@@ -22,10 +22,6 @@
 /// PERFORMANCE OF THIS SOFTWARE.
 ///
 
-/// \file madgwick.h
-/// \brief Implementation of a Madgwick filter.
-///
-/// See
 #ifndef SCMP_FILTER_MADGWICK_H
 #define SCMP_FILTER_MADGWICK_H
 
@@ -56,7 +52,8 @@ template <typename T>
 class Madgwick {
 public:
 	/// \brief The Madgwick filter is initialised with an identity quaternion.
-	Madgwick() : deltaT(0.0), previousSensorFrame(), sensorFrame() {};
+	Madgwick() : deltaT(0.0), previousSensorFrame(), sensorFrame()
+	{};
 
 
 	/// \brief The Madgwick filter is initialised with a sensor frame.
@@ -75,10 +72,12 @@ public:
 	///
 	/// \param sf A quaternion representing the current Orientation.
 	Madgwick(scmp::geom::Quaternion<T> sf) :
-	    deltaT(0.0), previousSensorFrame(), sensorFrame(sf) {};
+	    deltaT(0.0), previousSensorFrame(), sensorFrame(sf)
+	{};
 
 
-	/// \brief Return the current Orientation as measured by the filter.
+	/// \brief Return the current orientation as measured by the
+	///        filter.
 	///
 	/// \return The current sensor frame.
 	scmp::geom::Quaternion<T>
@@ -111,27 +110,65 @@ public:
 	UpdateFrame(const scmp::geom::Quaternion<T> &sf, T delta)
 	{
 		this->previousSensorFrame = this->sensorFrame;
-		this->sensorFrame = sf;
-		this->deltaT = delta;
+		this->sensorFrame         = sf;
+		this->deltaT              = delta;
 	}
 
+	/// \brief Update the sensor frame to a new frame.
+	///
+	/// \warning The filter's default Δt must be set before calling
+	// 	     this.
+	///
+	/// \param sf The new sensor frame replacing the previous one.
+	void
+	UpdateFrame(const scmp::geom::Quaternion<T> &sf)
+	{
+		this->UpdateFrame(sf, this->deltaT);
+	}
 
 	/// \brief Update the sensor frame with a gyroscope reading.
 	///
+	/// This method will assert that the Δt value is not zero
+	/// within a 100μs tolerance. This assert is compiled out with
+	/// the compile flag NDEBUG, but may be useful to catch
+	/// possible errors.
+	///
 	/// \param gyro A three-dimensional vector containing gyro readings
 	///             as w_x, w_y, w_z.
 	/// \param delta The time step between readings. It must not be zero.
 	void
 	UpdateAngularOrientation(const scmp::geom::Vector<T, 3> &gyro, T delta)
 	{
-		// Ensure the delta isn't zero within a 100 μs tolerance.
+		// Ensure the delta isn't zero within a 100 μs
+		// tolerance. The assert helps to catch bugs in
+		// testing, but otherwise we should refused to do
+		// anything.
 		assert(!scmp::WithinTolerance<T>(delta, 0.0, 0.0001));
-		scmp::geom::Quaternion<T>	q = this->AngularRate(gyro) * delta;
+		if (scmp::WithinTolerance<T>(delta, 0.0, 0.00001)) {
+			return;
+		}
+		scmp::geom::Quaternion<T> q = this->AngularRate(gyro) * delta;
 
 		this->UpdateFrame(this->sensorFrame + q, delta);
 	}
 
 
+	/// \brief Update the sensor frame with a gyroscope reading.
+	///
+	/// If no Δt is provided, the filter's default is used.
+	///
+	/// \warning The default Δt must be explicitly set using DeltaT
+	///          before calling this.
+	///
+	/// \param gyro A three-dimensional vector containing gyro readings
+	///             as w_x, w_y, w_z.
+	void
+	UpdateAngularOrientation(const scmp::geom::Vector<T, 3> &gyro)
+	{
+		this->UpdateAngularOrientation(gyro, this->deltaT);
+	}
+
+
 	/// \brief Retrieve a vector of the Euler angles in ZYX Orientation.
 	///
 	/// \return A vector of Euler angles as <ψ, θ, ϕ>.
@@ -141,6 +178,25 @@ public:
 		return this->sensorFrame.euler();
 	}
 
+	/// \brief Set the default Δt.
+	///
+	/// \note This must be explicitly called before calling any
+	///       method which uses the filter's internal Δt.
+	///
+	/// \param The time delta to use when no time delta is
+	///	   provided.
+	void
+	DeltaT(T newDeltaT)
+	{
+		this->deltaT = newDeltaT;
+	}
+
+	/// \brief Retrieve the filter's current ΔT.
+	///
+	/// \return The current value the filter will default to using
+	///	    if no time delta is provided.
+	T	DeltaT() { return this->deltaT; }
+
 private:
 	T				deltaT;
 	scmp::geom::Quaternion<T>	previousSensorFrame;

include/sctest/Assert.h

@@ -1,5 +1,5 @@
 ///
-/// \file Test.h
+/// \file Assert.h
 /// \author K. Isom <kyle@imap.cc>
 /// \date 2023-10-09
 /// \brief Tooling to assist in building test programs..

include/sctest/Report.h

@@ -40,10 +40,15 @@ public:
 	/// \return The number of tests that failed.
 	size_t	Failing() const;
 
+	/// \brief Returns the number of tests that have passed
+	///	   successfully.
+	size_t Passing() const;
+
 	/// \brief Total is the number of tests registered.
 	size_t	Total() const;
 
 	void	Failed();
+	void	Passed();
 	void	AddTest(size_t testCount = 0);
 	void	Reset(size_t testCount = 0);
 
@@ -54,8 +59,9 @@ public:
 
 	Report();
 private:
-	size_t	failing{};
-	size_t	total{};
+	size_t	failing;
+	size_t	passed;
+	size_t	total;
 
 	std::chrono::time_point<std::chrono::steady_clock>	start;
 	std::chrono::time_point<std::chrono::steady_clock>	end;

include/sctest/SimpleSuite.h

@@ -41,6 +41,9 @@ struct UnitTest {
 
 	/// This is the test function to be run.
 	std::function<bool()>	test;
+
+	/// This is the value the test returns if it passes.
+	bool			expect;
 };
 
 /// \brief SimpleSuite is a test-running harness for simple tests.
@@ -105,8 +108,8 @@ public:
 
 private:
 	bool				quiet;
-	std::function<bool(void)> fnSetup, fnTeardown;
-	std::vector<UnitTest>     tests;
+	std::function<bool(void)>	fnSetup, fnTeardown;
+	std::vector<UnitTest>		tests;
 
 	// Report functions.
 	Report	report;