world.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2025 VTT Technical Research Centre of Finland Ltd
// SPDX-License-Identifier: AGPL-3.0-or-later
 
#pragma once
 
#include <array>
#include <ostream>
 
#include "csys.hpp"
#include "types.hpp"
 
namespace pfc {
namespace world {
 
using pfc::csys::CartesianTag;
using pfc::csys::CoordinateSystem;
using pfc::types::Int3;
 
template <typename T> struct World final {
  const Int3 m_lower;             
  const Int3 m_upper;             
  const Int3 m_size;              
  const CoordinateSystem<T> m_cs; 
 
  explicit World(const Int3 &lower, const Int3 &upper,
                 const CoordinateSystem<T> &cs);
 
  bool operator==(const World &other) const noexcept {
    return m_lower == other.m_lower && m_upper == other.m_upper &&
           m_size == other.m_size && m_cs == other.m_cs;
  }
 
  bool operator!=(const World &other) const noexcept { return !(*this == other); }
 
  template <typename T_>
  friend std::ostream &operator<<(std::ostream &os, const World<T_> &w) noexcept;
};
 
using CartesianWorld = World<CartesianTag>;
 
} // namespace world
 
// Export World to pfc namespace for convenient usage
using World = world::CartesianWorld;
 
} // namespace pfc
 
// Include World functionality modules
#include "world_factory.hpp"
#include "world_helpers.hpp"
#include "world_queries.hpp"