Documentation for Bitset

Former-commit-id: f06a3bdb376bcfafb60d0386993806c818ca2c45

tests/Engine/Core/Bitset.cpp

@@ -0,0 +1,117 @@
+#include <Nazara/Core/Bitset.hpp>
+#include <Catch/catch.hpp>
+
+#include <string>
+
+SCENARIO("Bitset", "[CORE][BITSET]")
+{
+	GIVEN("Allocate and constructor")
+	{
+		Nz::Bitset<> bitset(3);
+
+		THEN("Capacity is 3 and size is 3")
+		{
+			REQUIRE(bitset.GetSize() == 3);
+			REQUIRE(bitset.GetCapacity() >= 3);
+		}
+	}
+
+	GIVEN("Iterator and default constructor")
+	{
+		Nz::String anotherDataString("0101");
+		Nz::Bitset<> defaultByte;
+		Nz::Bitset<> anotherData(anotherDataString.GetConstBuffer());
+
+		WHEN("We assign 'anotherData'")
+		{
+			defaultByte = anotherDataString;
+			REQUIRE(anotherData == defaultByte);
+			REQUIRE(defaultByte.GetSize() == 4);
+			REQUIRE(defaultByte.GetCapacity() >= 4);
+			REQUIRE(anotherData.GetSize() == 4);
+			REQUIRE(anotherData.GetCapacity() >= 4);
+		}
+	}
+
+	GIVEN("Copy and Move constructor")
+	{
+		Nz::Bitset<> originalArray(3, true);
+
+		WHEN("We copy")
+		{
+			Nz::Bitset<> copyBitset(originalArray);
+
+			THEN("We get a copy")
+			{
+				REQUIRE(copyBitset == originalArray);
+
+				AND_WHEN("We modify one")
+				{
+					for (auto i = 0; i < copyBitset.GetSize(); ++i)
+						copyBitset[i] = false;
+
+					THEN("They are no more equal")
+					{
+						REQUIRE(copyBitset != originalArray);
+						REQUIRE(copyBitset == Nz::Bitset<>(3, false));
+					}
+				}
+			}
+		}
+
+		WHEN("We move")
+		{
+			Nz::Bitset<> moveBitset(std::move(originalArray));
+
+			THEN("These results are expected")
+			{
+				REQUIRE(moveBitset == Nz::Bitset<>(3, true));
+				REQUIRE(originalArray.GetCapacity() == 0);
+			}
+		}
+	}
+
+	GIVEN("Three bitsets")
+	{
+		Nz::Bitset<> first("01001");
+		Nz::Bitset<> second("10110");
+		Nz::Bitset<> third;
+
+		WHEN("We swap first and third, then second and third and finally third and first")
+		{
+			Nz::Bitset<> oldFirst(first);
+			Nz::Bitset<> oldSecond(second);
+
+			first.Swap(third);
+			std::swap(second, third);
+			third.Swap(first);
+
+			THEN("First and second have been swapped and third is still empty.")
+			{
+				REQUIRE(oldFirst == second);
+				REQUIRE(oldSecond == first);
+				REQUIRE(third.GetSize() == 0);
+			}
+		}
+	}
+
+	GIVEN("Two bitsets")
+	{
+		Nz::Bitset<> first("01001");
+		Nz::Bitset<> second("10111");
+
+		WHEN("We perform operators")
+		{
+			Nz::Bitset<> andBitset = first & second;
+			Nz::Bitset<> orBitset = first | second;
+			Nz::Bitset<> xorBitset = first ^ second;
+
+			THEN("They should operate as logical operators")
+			{
+				REQUIRE(andBitset == Nz::Bitset<>("00001"));
+				REQUIRE(orBitset == Nz::Bitset<>("11111"));
+				REQUIRE(xorBitset == Nz::Bitset<>("11110"));
+			}
+		}
+	}
+}