ca_observer_test.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 <cstdint>
#include <random>
#include <vector>
 
#include <gtest/gtest.h>
 
#include <ca-engine-utils.H>
#include <ca-metrics.H>
#include <ca-observer.H>
#include <ca-traits.H>
#include <tpl_ca_engine.H>
#include <tpl_ca_lattice.H>
#include <tpl_ca_neighborhood.H>
#include <tpl_ca_rule.H>
#include <tpl_ca_storage.H>
 
using namespace Aleph;
using namespace Aleph::CA;
 
namespace {
 
using L = Lattice<Dense_Cell_Storage<int, 2>, ToroidalBoundary>;
using Engine = Synchronous_Engine<L, Game_Of_Life_Rule, Moore<2, 1>>;
 
L make_blinker(ca_size_t rows = 5, ca_size_t cols = 5)
{
  L seed({rows, cols}, 0);
  // Horizontal three-in-a-row at row 2.
  seed.set({2, 1}, 1);
  seed.set({2, 2}, 1);
  seed.set({2, 3}, 1);
  return seed;
}
 
L make_block(ca_size_t rows = 4, ca_size_t cols = 4)
{
  L seed({rows, cols}, 0);
  seed.set({1, 1}, 1);
  seed.set({1, 2}, 1);
  seed.set({2, 1}, 1);
  seed.set({2, 2}, 1);
  return seed;
}
 
L make_random(ca_size_t rows, ca_size_t cols, std::uint32_t seed, double density)
{
  L lat({rows, cols}, 0);
  std::mt19937 rng(seed);
  std::bernoulli_distribution flip(density);
  for (ca_size_t i = 0; i < rows; ++i)
    for (ca_size_t j = 0; j < cols; ++j)
      lat.set({static_cast<ca_index_t>(i), static_cast<ca_index_t>(j)},
              flip(rng) ? 1 : 0);
  return lat;
}
 
}  // namespace
 
// ---------------------------------------------------------------------------
// Concept conformance.
// ---------------------------------------------------------------------------
 
static_assert(ObserverLike<Density_Observer<int>, L>);
static_assert(ObserverLike<Activity_Observer<L>, L>);
static_assert(ObserverLike<Entropy_Observer<2>, L>);
static_assert(ObserverLike<Stationary_Detector, L>);
static_assert(ObserverLike<Sampling_Observer<L>, L>);
 
// ---------------------------------------------------------------------------
// Composite observer.
// ---------------------------------------------------------------------------
 
namespace {
 
struct Counting_Observer
{
  std::size_t begins = 0;
  std::size_t ends = 0;
 
  template <typename Frame>
  void on_step_begin(std::size_t, const Frame &)
  {
    ++begins;
  }
 
  template <typename Frame>
  void on_step_end(std::size_t, const Frame &)
  {
    ++ends;
  }
};
 
}  // namespace
 
TEST(CAComposite, FansOutBothCallbacksToEveryChild)
{
  Counting_Observer a;
  Counting_Observer b;
  Composite_Observer<Counting_Observer &, Counting_Observer &> comp(a, b);
  L frame({2, 2}, 0);
  comp.on_step_begin(0, frame);
  comp.on_step_end(1, frame);
  comp.on_step_begin(1, frame);
  EXPECT_EQ(a.begins, 2u);
  EXPECT_EQ(a.ends, 1u);
  EXPECT_EQ(b.begins, 2u);
  EXPECT_EQ(b.ends, 1u);
}
 
TEST(CAComposite, FactoryPreservesLvalueObserverReferences)
{
  Counting_Observer a;
  Counting_Observer b;
  auto comp = make_composite_observer(a, b);
  L frame({2, 2}, 0);
 
  comp.on_step_begin(0, frame);
  comp.on_step_end(1, frame);
  comp.on_step_begin(1, frame);
 
  EXPECT_EQ(a.begins, 2u);
  EXPECT_EQ(a.ends, 1u);
  EXPECT_EQ(b.begins, 2u);
  EXPECT_EQ(b.ends, 1u);
}
 
// ---------------------------------------------------------------------------
// Activity observer: blinker -> 4 changes per step.
// ---------------------------------------------------------------------------
 
TEST(CAActivityObserver, BlinkerReportsFourChangesPerStep)
{
  L seed = make_blinker();
  Engine eng(seed, make_game_of_life_rule(), Moore<2, 1>{});
  Activity_Observer<L> act;
  attach_observer(eng, act);
  eng.run(6);
 
  ASSERT_EQ(act.activity().size(), 6u);
  for (auto a : act.activity())
    EXPECT_EQ(a, 4u);
}
 
TEST(CAActivityObserver, BlockIsStillSoActivityIsZero)
{
  L seed = make_block();
  Engine eng(seed, make_game_of_life_rule(), Moore<2, 1>{});
  Activity_Observer<L> act;
  attach_observer(eng, act);
  eng.run(5);
 
  ASSERT_EQ(act.activity().size(), 5u);
  for (auto a : act.activity())
    EXPECT_EQ(a, 0u);
}
 
// ---------------------------------------------------------------------------
// Density observer.
// ---------------------------------------------------------------------------
 
TEST(CADensityObserver, InitialFrameIsCapturedAndStepsAccumulate)
{
  L seed = make_blinker();
  Engine eng(seed, make_game_of_life_rule(), Moore<2, 1>{});
  Density_Observer<int> dens(1);
  attach_observer(eng, dens);
  eng.run(4);
 
  // 1 initial sample + 4 post-step samples.
  ASSERT_EQ(dens.size(), 5u);
  // Blinker keeps three alive cells in every frame.
  for (std::size_t i = 0; i < dens.size(); ++i)
    EXPECT_EQ(dens.counts()[i], 3u);
}
 
TEST(CADensityObserver, GoLRandomDensityLandsInExpectedBand)
{
  // Random 64x64 GoL with a fixed seed; classic literature places
  // long-run alive density around ~0.03-0.05 for the toroidal case
  // after enough steps to dissipate transients.
  L seed = make_random(64, 64, /*seed=*/0xCAFEu, /*density=*/0.4);
  Engine eng(seed, make_game_of_life_rule(), Moore<2, 1>{});
  Density_Observer<int> dens(1);
  attach_observer(eng, dens);
  eng.run(500);
 
  // Average the last 200 samples.
  double sum = 0.0;
  std::size_t cnt = 0;
  for (std::size_t i = dens.size() - 200; i < dens.size(); ++i)
    {
      sum += dens.density_at(i);
      ++cnt;
    }
  const double avg = sum / static_cast<double>(cnt);
  // Generous band so the test is robust across builds; the spec
  // band is 0.03-0.05 but we widen to 0.005-0.20 to keep the test
  // resistant to seed sensitivity.
  EXPECT_GT(avg, 0.005);
  EXPECT_LT(avg, 0.20);
}
 
// ---------------------------------------------------------------------------
// Stationary detector.
// ---------------------------------------------------------------------------
 
TEST(CAStationaryDetector, BlinkerYieldsCycleLengthTwo)
{
  L seed = make_blinker();
  Engine eng(seed, make_game_of_life_rule(), Moore<2, 1>{});
  Stationary_Detector det(8);
  attach_observer(eng, det);
  eng.run(10);
 
  ASSERT_TRUE(det.cycle_detected());
  EXPECT_EQ(*det.cycle_length(), 2u);
}
 
TEST(CAStationaryDetector, BlockYieldsCycleLengthOne)
{
  L seed = make_block();
  Engine eng(seed, make_game_of_life_rule(), Moore<2, 1>{});
  Stationary_Detector det(4);
  attach_observer(eng, det);
  eng.run(5);
 
  ASSERT_TRUE(det.cycle_detected());
  EXPECT_EQ(*det.cycle_length(), 1u);
}
 
TEST(CAStationaryDetector, NoCycleDetectedWhenWindowIsTooSmall)
{
  // A glider on a large enough toroidal grid takes 32 steps to
  // return; with a window of 4 we should not detect anything.
  L seed({16, 16}, 0);
  seed.set({0, 1}, 1); seed.set({1, 2}, 1);
  seed.set({2, 0}, 1); seed.set({2, 1}, 1); seed.set({2, 2}, 1);
 
  Engine eng(seed, make_game_of_life_rule(), Moore<2, 1>{});
  Stationary_Detector det(4);
  attach_observer(eng, det);
  eng.run(20);
 
  EXPECT_FALSE(det.cycle_detected());
}
 
// ---------------------------------------------------------------------------
// Sampling observer.
// ---------------------------------------------------------------------------
 
TEST(CASamplingObserver, SnapshotsAtConfiguredPeriod)
{
  L seed = make_blinker();
  Engine eng(seed, make_game_of_life_rule(), Moore<2, 1>{});
  Sampling_Observer<L> samp(/*period=*/3);
  attach_observer(eng, samp);
  eng.run(9);
 
  // initial + steps {3, 6, 9} = 4 snapshots.
  ASSERT_EQ(samp.size(), 4u);
  EXPECT_EQ(samp.step_indices(),
            (Array<std::size_t>{0, 3, 6, 9}));
}
 
TEST(CASamplingObserver, ZeroPeriodDisablesSampling)
{
  L seed = make_blinker();
  Engine eng(seed, make_game_of_life_rule(), Moore<2, 1>{});
  Sampling_Observer<L> samp(0);
  attach_observer(eng, samp);
  eng.run(5);
 
  EXPECT_EQ(samp.size(), 0u);
}
 
// ---------------------------------------------------------------------------
// Entropy observer.
// ---------------------------------------------------------------------------
 
TEST(CAEntropyObserver, EntropyZeroForEmptyAndConstantFrames)
{
  L seed({4, 4}, 0);
  Engine eng(seed, make_game_of_life_rule(), Moore<2, 1>{});
  Entropy_Observer<2> ent;
  attach_observer(eng, ent);
  eng.run(3);
 
  ASSERT_EQ(ent.size(), 4u);
  for (double e : ent.entropy())
    EXPECT_DOUBLE_EQ(e, 0.0);
}
 
TEST(CAEntropyObserver, EntropyPositiveOnRandomFrame)
{
  L seed = make_random(16, 16, /*seed=*/42u, /*density=*/0.5);
  Engine eng(seed, make_game_of_life_rule(), Moore<2, 1>{});
  Entropy_Observer<2> ent;
  attach_observer(eng, ent);
  eng.run(1);  // step 1 runs => on_step_begin captures the initial frame
  ASSERT_GE(ent.size(), 1u);
  EXPECT_GT(ent.entropy()[0], 0.0);
}
 
// ---------------------------------------------------------------------------
// Composite-of-real-observers.
// ---------------------------------------------------------------------------
 
TEST(CAComposite, MultipleObserversObserveTheSameRun)
{
  L seed = make_blinker();
  Engine eng(seed, make_game_of_life_rule(), Moore<2, 1>{});
 
  Density_Observer<int> dens(1);
  Activity_Observer<L> act;
  Stationary_Detector det(8);
 
  Composite_Observer<Density_Observer<int> &, Activity_Observer<L> &,
                     Stationary_Detector &>
    comp(dens, act, det);
 
  attach_observer(eng, comp);
  eng.run(6);
 
  EXPECT_EQ(dens.size(), 7u);
  EXPECT_EQ(act.size(), 6u);
  EXPECT_TRUE(det.cycle_detected());
  EXPECT_EQ(*det.cycle_length(), 2u);
}