for_each_test.cc

/*
 * Copyright (c) 2014-2015, Siemens AG. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include <for_each_test.h>
#include <embb/algorithms/for_each.h>
#include <embb/mtapi/execution_policy.h>
#include <vector>
#include <deque>
#include <sstream>

/**
 * Functor to compute the square of a number.
 *
 * The result overwrites the original number.
 */
struct Square {
  template<typename Type>
  void operator()(Type& l) const {
    l = l * l;
  }
};

/**
 * Free function to compute the square of a number.
 *
 * The result overwrites the original number.
 */
static void SquareFunction(int &val) {
  val = val * val;
}

ForEachTest::ForEachTest() {
  CreateUnit("Different data structures")
    .Add(&ForEachTest::TestDataStructures, this);
  CreateUnit("Function Pointers").Add(&ForEachTest::TestFunctionPointers, this);
  CreateUnit("Ranges").Add(&ForEachTest::TestRanges, this);
  CreateUnit("Block sizes").Add(&ForEachTest::TestBlockSizes, this);
  CreateUnit("Policies").Add(&ForEachTest::TestPolicy, this);
  CreateUnit("Stress test").Add(&ForEachTest::StressTest, this);
}

void ForEachTest::TestDataStructures() {
  using embb::algorithms::ForEach;

  int array[kCountSize];
  std::vector<int> vector(kCountSize);
  std::deque<int> deque(kCountSize);
  for (size_t i = 0; i < kCountSize; i++) {
    array[i] = static_cast<int>(i+2);
    vector[i] = static_cast<int>(i+2);
    deque[i] = static_cast<int>(i+2);
  }

  ForEach(array, array + kCountSize, Square());
  ForEach(vector.begin(), vector.end(), Square());
  ForEach(deque.begin(), deque.end(), Square());

  for (size_t i = 0; i < kCountSize; i++) {
    int expected = static_cast<int>(i+2);
    expected = expected * expected;
    PT_EXPECT_EQ(expected, array[i]);
    PT_EXPECT_EQ(expected, vector[i]);
    PT_EXPECT_EQ(expected, deque[i]);
  }
}

void ForEachTest::TestFunctionPointers() {
  using embb::algorithms::ForEach;

  std::vector<int> vector(kCountSize);
  for (size_t i = 0; i < kCountSize; i++) {
    vector[i] = static_cast<int>(i+2);
  }
  ForEach(vector.begin(), vector.end(), &SquareFunction);
  for (size_t i = 0; i < kCountSize; i++) {
    int expected = static_cast<int>(i+2);
    expected = expected * expected;
    PT_EXPECT_EQ(expected, vector[i]);
  }
}

void ForEachTest::TestRanges() {
  using embb::algorithms::ForEach;
  size_t count = 4;
  std::vector<int> init(count);
  std::vector<int> vector(count);
  for (size_t i = 0; i < count; i++) {
    init[i] = static_cast<int>(i+2);
  }

  // Ommit first element
  vector = init;
  ForEach(vector.begin() + 1, vector.end(), Square());
  PT_EXPECT_EQ(vector[0], init[0]);
  for (size_t i = 1; i < count; i++) {
    PT_EXPECT_EQ(vector[i], init[i]*init[i]);
  }

  // Ommit last element
  vector = init;
  ForEach(vector.begin(), vector.end() - 1, Square());
  for (size_t i = 0; i < count - 1; i++) {
    PT_EXPECT_EQ(vector[i], init[i]*init[i]);
  }
  PT_EXPECT_EQ(vector[count - 1], init[count - 1]);

  // Ommit first and last element
  vector = init;
  ForEach(vector.begin() + 1, vector.end() - 1, Square());
  PT_EXPECT_EQ(vector[0], init[0]);
  for (size_t i = 1; i < count - 1; i++) {
    PT_EXPECT_EQ(vector[i], init[i]*init[i]);
  }
  PT_EXPECT_EQ(vector[count - 1], init[count - 1]);

  // Only do first element
  vector = init;
  ForEach(vector.begin(), vector.begin() + 1, Square());
  PT_EXPECT_EQ(vector[0], init[0] * init[0]);
  for (size_t i = 1; i < count; i++) {
    PT_EXPECT_EQ(vector[i], init[i]);
  }

  // Only do last element
  vector = init;
  ForEach(vector.end() - 1, vector.end(), Square());
  for (size_t i = 0; i < count - 1; i++) {
    PT_EXPECT_EQ(vector[i], init[i]);
  }
  PT_EXPECT_EQ(vector[count - 1], init[count - 1] * init[count - 1]);

  // Only do second element
  vector = init;
  ForEach(vector.begin() + 1, vector.begin() + 2, Square());
  for (size_t i = 1; i < count; i++) {
    if (i != 1) {
      PT_EXPECT_EQ(vector[i], init[i]);
    } else {
      PT_EXPECT_EQ(vector[i], init[i] * init[i]);
    }
  }
}

void ForEachTest::TestBlockSizes() {
  using embb::algorithms::ForEach;
  using embb::mtapi::ExecutionPolicy;
  size_t count = 4;
  std::vector<int> init(count);
  std::vector<int> vector(count);
  for (size_t i = 0; i < count; i++) {
    init[i] = static_cast<int>(i+2);
  }

  for (size_t block_size = 1; block_size < count + 2; block_size++) {
    vector = init;
    ForEach(vector.begin(), vector.end(), Square(), ExecutionPolicy(),
            block_size);
    for (size_t i = 0; i < count; i++) {
      PT_EXPECT_EQ(vector[i], init[i]*init[i]);
    }
  }
}

void ForEachTest::TestPolicy() {
  using embb::algorithms::ForEach;
  using embb::mtapi::ExecutionPolicy;
  size_t count = 4;
  std::vector<int> init(count);
  std::vector<int> vector(count);
  for (size_t i = 0; i < count; i++) {
    init[i] = static_cast<int>(i+2);
  }

  vector = init;
  ForEach(vector.begin(), vector.end(), Square(), ExecutionPolicy());
  for (size_t i = 0; i < count; i++) {
    PT_EXPECT_EQ(vector[i], init[i]*init[i]);
  }

  vector = init;
  ForEach(vector.begin(), vector.end(), Square(), ExecutionPolicy(true));
  for (size_t i = 0; i < count; i++) {
    PT_EXPECT_EQ(vector[i], init[i]*init[i]);
  }
  
  vector = init;
  ForEach(vector.begin(), vector.end(), Square(), ExecutionPolicy(true, 1));
  for (size_t i = 0; i < count; i++) {
    PT_EXPECT_EQ(vector[i], init[i]*init[i]);
  }
}

void ForEachTest::StressTest() {
  using embb::algorithms::ForEach;
  using embb::mtapi::ExecutionPolicy;
  size_t count = embb::mtapi::Node::GetInstance().GetCoreCount() *10;
  std::vector<int> large_vector(count);
  for (size_t i = 0; i < count; i++) {
    large_vector[i] = static_cast<int>((i + 2) % 1000);
  }
  ForEach(large_vector.begin(), large_vector.end(), Square(), ExecutionPolicy(),
          2000);
  for (size_t i = 0; i < count; i++) {
    int expected = static_cast<int>((i + 2) % 1000);
    expected = expected * expected;
    PT_EXPECT_EQ(large_vector[i], expected);
  }
}