Merge pull request #2 from KredeGC/dev

More tests and comments

Author: KredeGC

include/bitstream/stream/bit_reader.h

@@ -174,7 +174,7 @@ namespace bitstream
 		/**
 		 * @brief Pads the buffer with up to 8 zeros, so that the next read is byte-aligned
 		 * @notes Return false if the padded bits are not zeros
-		 * @return Success
+		 * @return Returns false if the padded bits are not zeros
 		*/
 		bool align() noexcept
 		{

include/bitstream/traits/integral_traits.h

@@ -40,14 +40,11 @@ namespace bitstream
 			if constexpr (sizeof(T) > 4)
 			{
 				// If the given range is bigger than a word (32 bits)
-				int max_words = (num_bits - 1) / 32 + 1;
-				for (int i = 0; i < max_words; i++)
-				{
-					int shift = i * 32;
-					int bit_count = (std::min)(num_bits - shift, 32);
-					uint32_t unsigned_value = static_cast<uint32_t>((value - min) >> shift);
-					BS_ASSERT(writer.serialize_bits(unsigned_value, bit_count));
-				}
+				uint32_t unsigned_value = static_cast<uint32_t>(value - min);
+				BS_ASSERT(writer.serialize_bits(unsigned_value, 32));
+
+				unsigned_value = static_cast<uint32_t>((value - min) >> 32);
+				BS_ASSERT(writer.serialize_bits(unsigned_value, num_bits - 32));
 			}
 			else
 			{
@@ -69,19 +66,15 @@ namespace bitstream
 
 			if constexpr (sizeof(T) > 4)
 			{
+				// If the given range is bigger than a word (32 bits)
 				value = 0;
+				uint32_t unsigned_value;
 
-				// If the given range is bigger than a word (32 bits)
-				int max_words = (num_bits - 1) / 32 + 1;
-				for (int i = 0; i < max_words; i++)
-				{
-					uint32_t unsigned_value;
-					int shift = i * 32;
-					int bit_count = (std::min)(num_bits - shift, 32);
-					BS_ASSERT(reader.serialize_bits(unsigned_value, bit_count));
+				BS_ASSERT(reader.serialize_bits(unsigned_value, 32));
+				value |= static_cast<T>(unsigned_value);
 
-					value |= static_cast<T>(unsigned_value) << shift;
-				}
+				BS_ASSERT(reader.serialize_bits(unsigned_value, num_bits - 32));
+				value |= static_cast<T>(unsigned_value) << 32;
 
 				value += min;
 			}
@@ -124,14 +117,11 @@ namespace bitstream
 			if constexpr (sizeof(T) > 4 && num_bits > 32)
 			{
 				// If the given range is bigger than a word (32 bits)
-				int max_words = (num_bits - 1) / 32 + 1;
-				for (int i = 0; i < max_words; i++)
-				{
-					int shift = i * 32;
-					int bit_count = (std::min)(num_bits - shift, 32);
-					uint32_t unsigned_value = static_cast<uint32_t>((value - Min) >> shift);
-					BS_ASSERT(writer.serialize_bits(unsigned_value, bit_count));
-				}
+				uint32_t unsigned_value = static_cast<uint32_t>(value - Min);
+				BS_ASSERT(writer.serialize_bits(unsigned_value, 32));
+
+				unsigned_value = static_cast<uint32_t>((value - Min) >> 32);
+				BS_ASSERT(writer.serialize_bits(unsigned_value, num_bits - 32));
 			}
 			else
 			{
@@ -153,19 +143,15 @@ namespace bitstream
 
 			if constexpr (sizeof(T) > 4 && num_bits > 32)
 			{
+				// If the given range is bigger than a word (32 bits)
 				value = 0;
+				uint32_t unsigned_value;
 
-				// If the given range is bigger than a word (32 bits)
-				int max_words = (num_bits - 1) / 32 + 1;
-				for (int i = 0; i < max_words; i++)
-				{
-					uint32_t unsigned_value;
-					int shift = i * 32;
-					int bit_count = (std::min)(num_bits - shift, 32);
-					BS_ASSERT(reader.serialize_bits(unsigned_value, bit_count));
-
-					value |= static_cast<T>(unsigned_value) << shift;
-				}
+				BS_ASSERT(reader.serialize_bits(unsigned_value, 32));
+				value |= static_cast<T>(unsigned_value);
+
+				BS_ASSERT(reader.serialize_bits(unsigned_value, num_bits - 32));
+				value |= static_cast<T>(unsigned_value) << 32;
 
 				value += Min;
 			}

include/bitstream/traits/string_traits.h

@@ -103,7 +103,7 @@ namespace bitstream
 		}
 
 		/**
-		 * @brief Reads a string from the @p writer into @p value
+		 * @brief Reads a string from the @p reader into @p value
 		 * @param reader The stream to read from
 		 * @param value The string to read into. It will be resized if the read string won't fit
 		 * @param max_size The maximum expected length of the string

test/include/test_types.h

@@ -0,0 +1,27 @@
+#pragma once
+
+#include <cstddef>
+
+namespace bitstream::test
+{
+	struct quaternion
+	{
+		// smallest_three supports any combination of w, x, y and z, as long as it's consistent
+		float w;
+		float x;
+		float y;
+		float z;
+
+		quaternion() = default;
+
+		// The constructor order must be the same as the operator[]
+		quaternion(float w, float x, float y, float z)
+			: w(w), x(x), y(y), z(z) {}
+
+		// smallest_three uses this operator
+		float operator[](size_t index) const
+		{
+			return reinterpret_cast<const float*>(this)[index];
+		}
+	};
+}

test/src/test/quantization_test.cpp

@@ -1,5 +1,6 @@
 #include "test_assert.h"
 #include "test.h"
+#include "test_types.h"
 
 #include <bitstream/quantization/bounded_range.h>
 #include <bitstream/quantization/half_precision.h>
@@ -10,27 +11,6 @@
 
 namespace bitstream::test::quantization
 {
-	struct quaternion
-	{
-		// smallest_three supports any combination of w, x, y and z, as long as it's consistent
-		float w;
-		float x;
-		float y;
-		float z;
-
-		quaternion() = default;
-
-		// The constructor order must be the same as the operator[]
-		quaternion(float w, float x, float y, float z)
-			: w(w), x(x), y(y), z(z) {}
-
-		// smallest_three uses this operator
-		float operator[](size_t index) const
-		{
-			return reinterpret_cast<const float*>(this)[index];
-		}
-	};
-
 	BS_ADD_TEST(test_half_precision)
 	{
 		float value_in = 3.141592f;