fixed codestyle, added some documentation, fixed unsigned/signed warnings

mtapi_c/test/embb_mtapi_test_id_pool.cc

@@ -33,7 +33,7 @@ IdPoolTest::IdPoolTest() {
     Post(&IdPoolTest::TestBasicPost, this);
 
   CreateUnit("mtapi id pool test concurrent").
-    Add(&IdPoolTest::TestParallel, this, CONCURRENT_ACCESSORS_ID_POOL_2
+    Add(&IdPoolTest::TestParallel, this, concurrent_accessors_id_pool_2
     , 20).
     Post(&IdPoolTest::TestParallelPost, this).
     Pre(&IdPoolTest::TestParallelPre, this);
@@ -43,33 +43,33 @@ void IdPoolTest::TestParallel() {
   // allocate ID_ELEMENTS_PER_ACCESSOR elements. Each test thread is
   // guaranteed to be able to allocate this amount of elements.
   TestAllocateDeallocateNElementsFromPool(id_pool_parallel,
-    ID_ELEMENTS_PER_ACCESSOR);
+    id_elements_per_accessor);
 }
 
 void IdPoolTest::TestParallelPre() {
   // create second id pool with CONCURRENT_ACCESSORS_ID_POOL_2*
   // ID_ELEMENTS_PER_ACCESSOR elements
   embb_mtapi_id_pool_initialize(&id_pool_parallel,
-    CONCURRENT_ACCESSORS_ID_POOL_2*ID_ELEMENTS_PER_ACCESSOR);
+    concurrent_accessors_id_pool_2*id_elements_per_accessor);
 }
 
 void IdPoolTest::TestParallelPost() {
   // after the parallel tests, try to again allocate and deallocate all
   // elements sequentially.
   TestAllocateDeallocateNElementsFromPool(id_pool_parallel,
-    CONCURRENT_ACCESSORS_ID_POOL_2*ID_ELEMENTS_PER_ACCESSOR, true);
+    concurrent_accessors_id_pool_2*id_elements_per_accessor, true);
   
   // finalize pool
   embb_mtapi_id_pool_finalize(&id_pool_parallel);
 }
 
 void IdPoolTest::TestBasic() {
-  TestAllocateDeallocateNElementsFromPool(id_pool, ID_POOL_SIZE_1, true);
+  TestAllocateDeallocateNElementsFromPool(id_pool, id_pool_size_1, true);
 }
 
 void IdPoolTest::TestBasicPre() {
   // create id pool with ID_POOL_SIZE_1 elements
-  embb_mtapi_id_pool_initialize(&id_pool, ID_POOL_SIZE_1);
+  embb_mtapi_id_pool_initialize(&id_pool, id_pool_size_1);
 }
 
 void IdPoolTest::TestBasicPost() {
@@ -81,16 +81,16 @@ void IdPoolTest::TestAllocateDeallocateNElementsFromPool(
   embb_mtapi_id_pool_t &pool,
   int count_elements, 
   bool empty_check) {
-  std::vector<int> allocated;
+  std::vector<unsigned int> allocated;
 
   for (int i = 0; i != count_elements; ++i) {
     allocated.push_back(embb_mtapi_id_pool_allocate(&pool));
   }
 
   // the allocated elements should be disjunctive, and never invalid element
-  for (int x = 0; x != allocated.size(); ++x) {
+  for (unsigned int x = 0; x != allocated.size(); ++x) {
     PT_ASSERT(allocated[x] != EMBB_MTAPI_IDPOOL_INVALID_ID);
-    for (int y = 0; y != allocated.size(); ++y) {
+    for (unsigned int y = 0; y != allocated.size(); ++y) {
       if (x == y) {
         continue;
       }
@@ -103,7 +103,7 @@ void IdPoolTest::TestAllocateDeallocateNElementsFromPool(
   if (empty_check) {
     for (int i = 0; i != 10; ++i) {
       PT_ASSERT_EQ(embb_mtapi_id_pool_allocate(&pool),
-        EMBB_MTAPI_IDPOOL_INVALID_ID
+        static_cast<unsigned int>(EMBB_MTAPI_IDPOOL_INVALID_ID)
         )
     }
   }
@@ -112,7 +112,8 @@ void IdPoolTest::TestAllocateDeallocateNElementsFromPool(
   ::std::random_shuffle(allocated.begin(), allocated.end());
 
   for (int i = 0; i != count_elements; ++i) {
-    embb_mtapi_id_pool_deallocate(&pool, allocated[i]);
+    embb_mtapi_id_pool_deallocate(&pool, 
+      allocated[static_cast<unsigned int>(i)]);
   }
 }
 

mtapi_c/test/embb_mtapi_test_id_pool.h

@@ -33,22 +33,39 @@
 // for shuffling a vector
 #include <algorithm>
 
-#define ID_POOL_SIZE_1 100
-#define CONCURRENT_ACCESSORS_ID_POOL_2 10
-#define ID_ELEMENTS_PER_ACCESSOR 10
-
 class IdPoolTest : public partest::TestCase {
-public:
+ public:
   embb_mtapi_id_pool_t id_pool;
   embb_mtapi_id_pool_t id_pool_parallel;
 
   IdPoolTest();
 
-private:
+ private:
+
+  static const unsigned int id_pool_size_1 = 100;
+  static const unsigned int concurrent_accessors_id_pool_2 = 10;
+  static const unsigned int id_elements_per_accessor = 10;
+  
+  /**  
+   * We create a pool of size number_accessors*elements_per_accessor, so
+   * at each time we can guarantee each thread to be able to allocate 
+   * elements_per_accessor elements.
+   * We create number_accessor threads, where each thread iteratively 
+   * allocates and frees elements_per_accessor elements, which in each case
+   * has to be successful. Additionally, the sanity checks from the basic tests
+   * are repeated. The TestParallelPost function also repeats all
+   * sequential tests.
+   */
   void TestParallel();
   void TestParallelPre();
   void TestParallelPost();
 
+  /**
+   * Create a pool of size N. We repeatedly allocate and free N elements, check
+   * if the pool always returns disjunctive ids and check that the pool never
+   * returns the invalid element, if the pool is not empty. Check that the 
+   * invalid element is returned if the pool is empty.
+   */
   void TestBasic();
   void TestBasicPre();
   void TestBasicPost();