dynarray.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_dynArray.H>
#include <ah-unique.H>
 
#include <new>
#include <stdexcept>
 
using namespace Aleph;
using namespace std;
 
namespace {
 
TEST(DynArrayBasics, construction_and_size)
{
  DynArray<int> arr;
  EXPECT_TRUE(arr.is_empty());
  EXPECT_EQ(arr.size(), 0u);
 
  arr.append(42);
  EXPECT_EQ(arr.size(), 1u);
  EXPECT_FALSE(arr.is_empty());
  EXPECT_EQ(arr.access(0), 42);
 
  arr.append(7);
  EXPECT_EQ(arr.size(), 2u);
  EXPECT_EQ(arr.access(1), 7);
}
 
TEST(DynArrayFunctional, ToArrayPreservesOrder)
{
  DynArray<int> src;
  for (int v : {3, 6, 9})
    src.append(v);
 
  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));
}
 
TEST(DynArrayBasics, default_values_and_touch)
{
  DynArray<int> arr;
  arr.set_default_initial_value(123);
 
  arr.reserve(0, 3);
  ASSERT_EQ(arr.size(), 4u);
  for (size_t i = 0; i < arr.size(); ++i)
    EXPECT_EQ(arr.access(i), 123);
 
  arr.access(2) = 77;
  EXPECT_EQ(arr.access(2), 77);
 
  auto & ref = arr.touch(10);
  ref = 99;
  EXPECT_EQ(arr.size(), 11u);
  EXPECT_EQ(arr.access(10), 99);
}
 
TEST(DynArrayAlgorithms, InPlaceUnique)
{
  DynArray<int> arr;
  arr.append(1);
  arr.append(2);
  arr.append(1);
  arr.append(3);
  arr.append(2);
  arr.append(4);
  arr.append(4);
 
  in_place_unique(arr);
 
  ASSERT_EQ(arr.size(), 4u);
  EXPECT_EQ(arr.access(0), 1);
  EXPECT_EQ(arr.access(1), 2);
  EXPECT_EQ(arr.access(2), 3);
  EXPECT_EQ(arr.access(3), 4);
}
 
TEST(DynArrayErrors, stack_operations_on_empty)
{
  DynArray<int> arr;
 
  EXPECT_THROW(arr.pop(), std::underflow_error);
  EXPECT_THROW(arr.top(), std::underflow_error);
  EXPECT_THROW(arr.get_first(), std::underflow_error);
  EXPECT_THROW(arr.get_last(), std::underflow_error);
 
  int dummy = 0;
  EXPECT_THROW(arr.remove(dummy), std::underflow_error);
}
 
TEST(DynArrayReserve, invalid_range_throws)
{
  DynArray<int> arr;
  EXPECT_THROW(arr.reserve(5, 4), std::domain_error);
}
 
TEST(DynArrayReserve, reserve_and_access)
{
  DynArray<int> arr;
  arr.reserve(5);
  ASSERT_EQ(arr.size(), 5u);
  for (size_t i = 0; i < arr.size(); ++i)
    arr.access(i) = static_cast<int>(i * 2);
  for (size_t i = 0; i < arr.size(); ++i)
    EXPECT_EQ(arr.access(i), static_cast<int>(i * 2));
}
 
TEST(DynArrayIterator, get_it_position)
{
  DynArray<int> arr;
  for (int i = 0; i < 6; ++i)
    arr.append(i);
 
  auto it = arr.get_it(3);
  ASSERT_TRUE(it.has_curr());
  EXPECT_EQ(it.get_curr(), 3);
  it.next();
  EXPECT_EQ(it.get_curr(), 4);
 
  const auto & carr = arr;
  auto cit = carr.get_it(5);
  EXPECT_EQ(cit.get_curr(), 5);
  EXPECT_THROW(carr.get_it(6), std::out_of_range);
}
 
TEST(DynArrayIterator, IsLastRequiresCurrentItem)
{
  DynArray<int>::Iterator singular;
  EXPECT_FALSE(singular.is_last());
  singular.reset_last();
  EXPECT_FALSE(singular.has_curr());
  EXPECT_FALSE(singular.is_last());
 
  DynArray<int> empty;
  auto it = empty.get_it();
  it.reset_last();
  EXPECT_FALSE(it.has_curr());
  EXPECT_FALSE(it.is_last());
 
  empty.append(7);
  it.reset_last();
  EXPECT_TRUE(it.has_curr());
  EXPECT_TRUE(it.is_last());
  it.end();
  EXPECT_FALSE(it.is_last());
}
 
TEST(DynArrayIterator, CheckedAccessRejectsInvalidPositions)
{
  DynArray<int>::Iterator singular;
  EXPECT_THROW(singular.get_curr(), std::overflow_error);
  EXPECT_THROW(singular.next(), std::overflow_error);
  singular.reset_last();
  EXPECT_THROW(singular.get_curr(), std::underflow_error);
  EXPECT_THROW(singular.next(), std::overflow_error);
 
  DynArray<int> arr;
  auto it = arr.get_it();
  EXPECT_THROW(it.get_curr(), std::overflow_error);
  EXPECT_THROW(it.next(), std::overflow_error);
  it.reset_last();
  EXPECT_THROW(it.get_curr(), std::underflow_error);
 
  arr.append(42);
  it.reset_first();
  EXPECT_EQ(it.get_curr(), 42);
  it.next();
  EXPECT_THROW(it.get_curr(), std::overflow_error);
  EXPECT_THROW(it.next(), std::overflow_error);
  it.set_pos(-1);
  EXPECT_THROW(it.get_curr(), std::underflow_error);
  it.next();
  EXPECT_EQ(it.get_curr(), 42);
}
 
TEST(DynArrayReserve, adjust_and_cut)
{
  DynArray<int> arr;
  arr.adjust(10);
  EXPECT_EQ(arr.size(), 10u);
  arr.cut(3);
  EXPECT_EQ(arr.size(), 3u);
  arr.empty();
  EXPECT_TRUE(arr.is_empty());
  arr.append(1);
  arr.append(2);
  arr.cut(2);
  EXPECT_EQ(arr.size(), 2u);
 
  arr.clear();
  EXPECT_TRUE(arr.is_empty());
  EXPECT_EQ(arr.size(), 0u);
 
  arr.append(10);
  EXPECT_TRUE(arr.contains(10));
  EXPECT_FALSE(arr.contains(20));
}
 
TEST(DynArrayReserve, reserve_invalid_order)
{
  DynArray<int> arr;
  EXPECT_THROW(arr.reserve(4, 3), std::domain_error);
  EXPECT_EQ(arr.size(), 0u);
}
 
TEST(DynArrayReserve, reserve_touch_consistency)
{
  DynArray<int> arr;
  arr.reserve(2, 5);
  ASSERT_EQ(arr.size(), 6u);
  arr.touch(20) = 100;
  EXPECT_EQ(arr.size(), 21u);
  arr.cut(6);
  EXPECT_EQ(arr.size(), 6u);
}
 
// Default constructor that throws std::bad_alloc once `budget` constructions
// have succeeded. A negative budget never fails. Used to make a block
// allocation fail at a chosen point inside DynArray::reserve().
struct Fails_After_Budget
{
  static inline long budget = -1;
  int value = 0;
 
  Fails_After_Budget()
  {
    if (budget == 0)
      throw std::bad_alloc();
    if (budget > 0)
      --budget;
  }
};
 
// Restores the unlimited budget even if an ASSERT leaves the test early.
struct Budget_Guard
{
  ~Budget_Guard() { Fails_After_Budget::budget = -1; }
};
 
TEST(DynArrayReserve, reserve_fills_missing_blocks_of_existing_segment)
{
  DynArray<int> arr(4, 2, 2);  // segments of 4 blocks of 4 entries
  arr.touch(0) = 7;            // segment 0 exists, but only its block 0
  ASSERT_EQ(arr.get_num_blocks(), 1u);
 
  arr.reserve(0, 15);  // must allocate blocks 1..3 of the existing segment
  EXPECT_EQ(arr.get_num_blocks(), 4u);
  EXPECT_EQ(arr.size(), 16u);
  for (size_t i = 0; i <= 15; ++i)
    EXPECT_TRUE(arr.exist(i)) << "entry " << i;
  EXPECT_EQ(arr.access(0), 7);  // existing data is preserved
}
 
TEST(DynArrayReserve, failed_reserve_releases_only_what_it_allocated)
{
  Budget_Guard guard;
  // 16 segments of 4 blocks of 4 entries: [0, 47] spans segments 0, 1 and 2.
  DynArray<Fails_After_Budget> arr(4, 2, 2);
  const size_t block = arr.get_block_size();
  ASSERT_EQ(block, 4u);
 
  arr.touch(0);  // segment 0 and its block 0 exist before the reserve
  ASSERT_EQ(arr.get_num_blocks(), 1u);
 
  // Blocks 1..3 of segment 0 and block 0 of segment 1 succeed; block 1 of
  // segment 1 fails, after a whole new segment has been allocated.
  Fails_After_Budget::budget = static_cast<long>(4 * block);
  EXPECT_THROW(arr.reserve(0, 47), std::bad_alloc);
  Fails_After_Budget::budget = -1;
 
  EXPECT_EQ(arr.get_num_blocks(), 1u);
  EXPECT_EQ(arr.size(), 1u);
  for (size_t i = 0; i < block; ++i)
    EXPECT_TRUE(arr.exist(i)) << "pre-existing entry " << i;
  for (size_t i = block; i <= 47; ++i)
    EXPECT_FALSE(arr.exist(i)) << "entry " << i << " was not rolled back";
 
  arr.reserve(0, 47);  // the array remains fully usable
  EXPECT_EQ(arr.get_num_blocks(), 12u);
  EXPECT_EQ(arr.size(), 48u);
  for (size_t i = 0; i <= 47; ++i)
    EXPECT_TRUE(arr.exist(i));
}
 
TEST(DynArrayReserve, failure_on_first_block_releases_new_segment)
{
  Budget_Guard guard;
  DynArray<Fails_After_Budget> arr(4, 2, 2);
 
  Fails_After_Budget::budget = 0;  // the very first block allocation fails
  EXPECT_THROW(arr.reserve(20, 40), std::bad_alloc);
  Fails_After_Budget::budget = -1;
 
  EXPECT_EQ(arr.get_num_blocks(), 0u);
  EXPECT_EQ(arr.size(), 0u);
  for (size_t i = 0; i <= 47; ++i)
    EXPECT_FALSE(arr.exist(i));
}
 
TEST(DynArrayReserve, reserve_of_existing_range_constructs_nothing)
{
  Budget_Guard guard;
  DynArray<Fails_After_Budget> arr(4, 2, 2);
  arr.reserve(0, 47);
  ASSERT_EQ(arr.get_num_blocks(), 12u);
 
  Fails_After_Budget::budget = 0;  // any element construction would throw
  EXPECT_NO_THROW(arr.reserve(0, 47));
  EXPECT_NO_THROW(arr.reserve(5, 30));
  EXPECT_EQ(arr.get_num_blocks(), 12u);
  EXPECT_EQ(arr.size(), 48u);
}
 
TEST(DynArrayQueueStack, push_pop_fifo_lifo)
{
  DynArray<int> arr;
  for (int i = 0; i < 5; ++i)
    arr.push(i);
  EXPECT_EQ(arr.get_first(), 0);
  EXPECT_EQ(arr.get_last(), 4);
 
  arr.insert(-1);
  EXPECT_EQ(arr.get_first(), -1);
 
  EXPECT_EQ(arr.pop(), 4);
  EXPECT_EQ(arr.size(), 5u);
  EXPECT_EQ(arr.top(), arr.get_last());
}
 
} // namespace