array.cc

Go to the documentation of this file.

 
/*
                          Aleph_w
 
  Data structures & Algorithms
  version 2.0.0b
  https://github.com/lrleon/Aleph-w
 
  This file is part of Aleph-w library
 
  Copyright (c) 2002-2026 Leandro Rabindranath Leon
 
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
 
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/
 
 
#include <gtest/gtest.h>
 
#include <tpl_array.H>
#include <ah-unique.H>
 
#include <array>
#include <numeric>
#include <string>
#include <type_traits>
#include <vector>
 
using namespace Aleph;
 
namespace {
 
TEST(ArrayBasics, DefaultConstructionAndBase)
{
  Array<int> arr;
  EXPECT_TRUE(arr.is_empty());
  EXPECT_EQ(arr.size(), 0u);
  EXPECT_THROW(arr.base(), std::underflow_error);
 
  const Array<int> empty_const;
  EXPECT_THROW(empty_const.base(), std::underflow_error);
 
  arr.append(10);
  arr.append(20);
  EXPECT_FALSE(arr.is_empty());
  EXPECT_EQ(arr.size(), 2u);
  EXPECT_EQ(arr.base(), 10);
  EXPECT_EQ(arr.get_first(), 10);
  EXPECT_EQ(arr.get_last(), 20);
 
  const auto & carr = arr;
  EXPECT_EQ(carr.get_first(), 10);
  EXPECT_EQ(carr.get_last(), 20);
}
 
TEST(ArrayFunctional, ToArrayPreservesOrder)
{
  Array<int> src = {5, 7, 9, 11};
 
  auto copy = src.to_array();
 
  ASSERT_EQ(copy.size(), src.size());
  for (size_t i = 0; i < copy.size(); ++i)
    EXPECT_EQ(copy(i), src(i));
 
  // original remains unchanged
  EXPECT_EQ(src.size(), 4u);
}
 
TEST(ArrayModifiers, InsertAppendAndRemove)
{
  Array<int> arr;
  arr.append(1);
  arr.append(2);
  arr.insert(-1);
 
  ASSERT_EQ(arr.size(), 3u);
  EXPECT_EQ(arr.get_first(), -1);
  EXPECT_EQ(arr.get_last(), 2);
 
  EXPECT_EQ(arr.remove_first(), -1);
  EXPECT_EQ(arr.remove_last(), 2);
  EXPECT_EQ(arr.size(), 1u);
  EXPECT_EQ(arr.base(), 1);
 
  arr.empty();
  EXPECT_TRUE(arr.is_empty());
}
 
TEST(ArrayCopyMove, CopyAndMoveSemantics)
{
  Array<int> original = {1, 2, 3, 4};
  Array<int> copy(original);
  ASSERT_EQ(copy.size(), original.size());
  copy[0] = 100;
  EXPECT_EQ(original[0], 1);
 
  Array<int> assigned;
  assigned = copy;
  EXPECT_EQ(assigned.size(), copy.size());
  EXPECT_EQ(assigned[0], 100);
 
  Array<int> moved(std::move(copy));
  EXPECT_EQ(moved.size(), 4u);
  EXPECT_EQ(moved[0], 100);
 
  Array<int> move_assigned;
  move_assigned.append(999);
  move_assigned = std::move(moved);
  EXPECT_EQ(move_assigned.size(), 4u);
  EXPECT_EQ(move_assigned[3], 4);
}
 
TEST(ArrayCapacity, ReservePutnAndSwap)
{
  Array<int> arr;
  const auto initial_cap = arr.capacity();
  arr.reserve(initial_cap + 50);
  EXPECT_GE(arr.capacity(), initial_cap + 50);
 
  arr.putn(5);
  ASSERT_EQ(arr.size(), 5u);
  for (size_t i = 0; i < arr.size(); ++i)
    arr[i] = static_cast<int>(i * 10);
 
  Array<int> other;
  other.append(-1);
  arr.swap(other);
  EXPECT_EQ(arr.size(), 1u);
  EXPECT_EQ(arr[0], -1);
  EXPECT_EQ(other.size(), 5u);
  EXPECT_EQ(other[2], 20);
}
 
TEST(ArrayAccessors, BoundsCheckingAndConstVariants)
{
  Array<std::string> arr;
  arr.append("hello");
  arr.append("world");
 
  EXPECT_EQ(arr[0], "hello");
  EXPECT_EQ(arr(1), "world");
  EXPECT_THROW(arr[2], std::out_of_range);
 
  const Array<std::string> carr = arr;
  EXPECT_EQ(carr[0], "hello");
  EXPECT_EQ(carr(1), "world");
  EXPECT_THROW(carr[3], std::out_of_range);
}
 
TEST(ArrayReverse, ReverseAndReverseInPlaceAliases)
{
  Array<int> arr;
  for (int i = 1; i <= 5; ++i)
    arr.append(i);
 
  const std::array<int, 5> ascending = {1, 2, 3, 4, 5};
  const std::array<int, 5> descending = {5, 4, 3, 2, 1};
 
  arr.reverse();
  for (size_t i = 0; i < descending.size(); ++i)
    EXPECT_EQ(arr[i], descending[i]) << "reverse() should mutate in place";
 
  const Array<int> &carr = arr;
  const auto copy = carr.reverse();
  for (size_t i = 0; i < ascending.size(); ++i)
    EXPECT_EQ(copy[i], ascending[i]) << "const reverse() should return new copy";
 
  arr.reverse_in_place();
  for (size_t i = 0; i < ascending.size(); ++i)
    EXPECT_EQ(arr[i], ascending[i]) << "reverse_in_place() alias should behave like reverse()";
 
  const auto copy_rev = carr.rev();
  for (size_t i = 0; i < descending.size(); ++i)
    EXPECT_EQ(copy_rev[i], descending[i]) << "const rev() should return reversed copy";
}
 
TEST(ArrayReverse, NonConstRevReversesInPlaceAndReturnsReference)
{
  Array<int> arr = {1, 2, 3};
 
  Array<int> &alias = arr.rev();
 
  EXPECT_EQ(&alias, &arr);
  EXPECT_EQ(arr[0], 3);
  EXPECT_EQ(arr[1], 2);
  EXPECT_EQ(arr[2], 1);
}
 
struct MoveOnlyOp
{
  bool *called;
  explicit MoveOnlyOp(bool *c) : called(c) {}
  MoveOnlyOp(const MoveOnlyOp &) = delete;
  MoveOnlyOp & operator=(const MoveOnlyOp &) = delete;
  MoveOnlyOp(MoveOnlyOp &&) = default;
  MoveOnlyOp & operator=(MoveOnlyOp &&) = default;
  bool operator()(int)
  {
    *called = true;
    return true;
  }
};
 
TEST(ArrayTraverse, TraversalVariants)
{
  Array<int> arr = {1, 2, 3, 4};
 
  int sum = 0;
  auto accumulate = [&sum](int value)
    {
      sum += value;
      return true;
    };
  EXPECT_TRUE(arr.traverse(accumulate));
  EXPECT_EQ(sum, 10);
 
  int visited = 0;
  auto stop_at_three = [&visited](int value)
    {
      ++visited;
      return value < 3;
    };
  EXPECT_FALSE(arr.traverse(stop_at_three));
  EXPECT_EQ(visited, 3);
 
  bool called = false;
  EXPECT_TRUE(arr.traverse(MoveOnlyOp(&called)));
  EXPECT_TRUE(called);
}
 
TEST(ArrayTraverse, ConstElementsCannotBeModified)
{
  Array<int> arr = {1, 2, 3};
  const Array<int> &const_arr = arr;
 
  auto increment = [](int &value)
    {
      ++value;
      return true;
    };
  int sum = 0;
  auto accumulate_const = [&sum](const int &value)
    {
      sum += value;
      return true;
    };
 
  EXPECT_TRUE(arr.traverse(increment));
  EXPECT_EQ(arr[0], 2);
  EXPECT_EQ(arr[1], 3);
  EXPECT_EQ(arr[2], 4);
  EXPECT_TRUE(const_arr.traverse(accumulate_const));
  EXPECT_EQ(sum, 9);
  EXPECT_TRUE(const_arr.traverse([](const int &value) { return value > 0; }));
  EXPECT_EQ(arr[0], 2);
  EXPECT_EQ(arr[1], 3);
  EXPECT_EQ(arr[2], 4);
}
 
template <class Container, class Operation>
concept CanTraverse = requires(Container &container, Operation &operation)
{
  container.traverse(operation);
};
 
struct MutableArrayOperation
{
  bool operator () (int &) const { return true; }
};
 
static_assert(CanTraverse<Array<int>, MutableArrayOperation>);
static_assert(not CanTraverse<const Array<int>, MutableArrayOperation>);
 
TEST(ArrayAlgorithms, InPlaceUnique)
{
  Array<int> arr = {1, 2, 1, 3, 2, 4, 4};
 
  in_place_unique(arr);
 
  ASSERT_EQ(arr.size(), 4u);
  EXPECT_EQ(arr[0], 1);
  EXPECT_EQ(arr[1], 2);
  EXPECT_EQ(arr[2], 3);
  EXPECT_EQ(arr[3], 4);
}
 
TEST(ArrayIterators, IteratorCoversAllElements)
{
  Array<int> arr = {0, 1, 2, 3};
  Array<int>::Iterator it(arr);
 
  int expected = 0;
  for (; it.has_curr(); it.next())
    {
      EXPECT_EQ(it.get_curr(), expected);
      ++expected;
    }
  EXPECT_EQ(expected, 4);
}
 
TEST(ArrayUtilities, BuildArrayAndStdVector)
{
  auto arr = build_array<int>(5, 4, 3, 2, 1);
  EXPECT_EQ(arr.size(), 5u);
  EXPECT_EQ(arr[0], 5);
  EXPECT_EQ(arr[4], 1);
 
  const auto vec = to_stdvector(arr);
  ASSERT_EQ(vec.size(), arr.size());
  for (size_t i = 0; i < vec.size(); ++i)
    EXPECT_EQ(vec[i], arr(i));
}
 
namespace
{
struct DefaultInit
{
  int v;
  DefaultInit() : v(123) {}
  explicit DefaultInit(int x) : v(x) {}
  bool operator==(const DefaultInit &o) const { return v == o.v; }
};
}
 
TEST(ArrayCtors, ValueConstructorInitializesAllElements_POD)
{
  const size_t n = 8;
  const int value = 42;
  Array<int> arr(n, value);
  ASSERT_EQ(arr.size(), n);
  for (size_t i = 0; i < n; ++i)
    EXPECT_EQ(arr[i], value);
}
 
TEST(ArrayCtors, ValueConstructorInitializesAllElements_NonPOD)
{
  const size_t n = 6;
  const std::string value = "abc";
  Array<std::string> arr(n, value);
  ASSERT_EQ(arr.size(), n);
  for (size_t i = 0; i < n; ++i)
    EXPECT_EQ(arr[i], value);
}
 
TEST(ArrayFactory, CreateYieldsLogicalSizeAndRequiresAssignBeforeReadForPOD)
{
  const size_t n = 10;
  auto arr = Array<int>::create(n);
  static_assert(std::is_trivially_default_constructible_v<int>);
  ASSERT_EQ(arr.size(), n);
 
  for (size_t i = 0; i < arr.size(); ++i)
    arr[i] = static_cast<int>(i * 3);
  for (size_t i = 0; i < arr.size(); ++i)
    EXPECT_EQ(arr[i], static_cast<int>(i * 3));
}
 
TEST(ArrayFactory, CreateDefaultConstructsClassTypes)
{
  const size_t n = 7;
  auto arr = Array<DefaultInit>::create(n);
  static_assert(!std::is_trivially_default_constructible_v<DefaultInit>);
  ASSERT_EQ(arr.size(), n);
  for (size_t i = 0; i < n; ++i)
    EXPECT_EQ(arr[i].v, 123);
 
  arr[0] = DefaultInit(7);
  EXPECT_EQ(arr[0].v, 7);
}
 
TEST(ArrayFactory, PutnAndAppendPopulateBothPODAndNonPOD)
{
  Array<int> pod;
  pod.putn(3);
  pod[0] = 1;
  pod[1] = 2;
  pod[2] = 3;
  pod.append(4);
  ASSERT_EQ(pod.size(), 4u);
  EXPECT_EQ(pod[3], 4);
 
  Array<std::string> nonpod;
  nonpod.putn(2);
  nonpod[0] = "x";
  nonpod[1] = "y";
  nonpod.append("z");
  ASSERT_EQ(nonpod.size(), 3u);
  EXPECT_EQ(nonpod[2], "z");
}
 
TEST(ArraySearch, Contains)
{
  Array<int> arr = {10, 20, 30, 40};
  EXPECT_TRUE(arr.contains(20));
  EXPECT_TRUE(arr.contains(40));
  EXPECT_FALSE(arr.contains(50));
 
  EXPECT_TRUE(arr.contains_if([](int x) { return x > 25; }));
  EXPECT_FALSE(arr.contains_if([](int x) { return x > 100; }));
}
 
TEST(ArraySearch, ContainsEmpty)
{
  Array<int> empty;
  EXPECT_FALSE(empty.contains(10));
  EXPECT_FALSE(empty.contains_if([](int) { return true; }));
}
 
} // namespace