box3d.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
 
#ifndef PFC_BOX3D_HPP
#define PFC_BOX3D_HPP
 
#include <array>
#include <ostream>
#include <stdexcept>
 
namespace pfc {
 
class Box3D {
public:
  using Int3 = std::array<int, 3>;
 
private:
  Int3 m_lower; 
  Int3 m_upper; 
 
public:
  Box3D(const Int3 &lower, const Int3 &upper);
 
  const Int3 &lower() const noexcept;
 
  const Int3 &upper() const noexcept;
 
  Int3 size() const noexcept;
 
  int total_size() const noexcept;
 
  bool contains(const Int3 &index) const noexcept;
 
  bool operator==(const Box3D &other) const noexcept;
 
  bool operator!=(const Box3D &other) const noexcept;
 
  friend std::ostream &operator<<(std::ostream &os, const Box3D &box) noexcept;
};
 
} // namespace pfc
 
#endif // PFC_BOX3D_HPP