compartment_sets.h

#pragma once
 
#include <bbp/sonata/nodes.h>
 
#include <nlohmann/json.hpp>
 
namespace bbp {
namespace sonata {
namespace detail {
class CompartmentSetFilteredIterator;
class CompartmentSet;
class CompartmentSets;
}  // namespace detail
 
struct CompartmentLocation {
  public:
    uint64_t nodeId = 0;
    uint64_t sectionIndex = 0;
    double offset = 0.0;
 
    bool operator==(const CompartmentLocation& other) const {
        return nodeId == other.nodeId && sectionIndex == other.sectionIndex &&
               offset == other.offset;
    }
 
    bool operator!=(const CompartmentLocation& other) const {
        return !(*this == other);
    }
};
 
inline std::ostream& operator<<(std::ostream& os, const CompartmentLocation& cl) {
    os << "CompartmentLocation("
       << "nodeId: " << cl.nodeId << ", "
       << "sectionIndex: " << cl.sectionIndex << ", "
       << "offset: " << cl.offset << ")";
    return os;
}
 
class SONATA_API CompartmentSetFilteredIterator {
public:
  using iterator_category = std::forward_iterator_tag;
  using value_type = CompartmentLocation;
  using difference_type = std::ptrdiff_t;
  using pointer = const CompartmentLocation*;
  using reference = const CompartmentLocation&;
 
  explicit CompartmentSetFilteredIterator(
      std::unique_ptr<detail::CompartmentSetFilteredIterator> impl);
  CompartmentSetFilteredIterator(const CompartmentSetFilteredIterator& other);
  CompartmentSetFilteredIterator& operator=(const CompartmentSetFilteredIterator& other);
  CompartmentSetFilteredIterator(CompartmentSetFilteredIterator&&) noexcept;
  CompartmentSetFilteredIterator& operator=(CompartmentSetFilteredIterator&&) noexcept;
  ~CompartmentSetFilteredIterator();
 
  const CompartmentLocation& operator*() const;
  const CompartmentLocation* operator->() const;
 
  CompartmentSetFilteredIterator& operator++();    // prefix ++
  CompartmentSetFilteredIterator operator++(int);  // postfix ++
  bool operator==(const CompartmentSetFilteredIterator& other) const;
  bool operator!=(const CompartmentSetFilteredIterator& other) const;
 
private:
    std::unique_ptr<detail::CompartmentSetFilteredIterator> impl_;
};
 
 
class SONATA_API CompartmentSet
{
  public:
    CompartmentSet() = delete;
 
    explicit CompartmentSet(const std::string& json_content);
    explicit CompartmentSet(std::shared_ptr<detail::CompartmentSet>&& impl);
 
    std::pair<CompartmentSetFilteredIterator, CompartmentSetFilteredIterator> filtered_crange(
        Selection selection = Selection({})) const;
 
    std::size_t size(const Selection& selection = Selection({})) const;
 
    // Is empty?
    bool empty() const;
 
    const std::string& population() const;
 
    CompartmentLocation operator[](std::size_t index) const;
 
    Selection nodeIds() const;
 
    CompartmentSet filter(const Selection& selection = Selection({})) const;
 
    std::string toJSON() const;
 
    bool operator==(const CompartmentSet& other) const;
    bool operator!=(const CompartmentSet& other) const;
 
  private:
    std::shared_ptr<detail::CompartmentSet> impl_;
};
 
 
class SONATA_API CompartmentSets
{
public:
 
    CompartmentSets(const std::string& content);
    CompartmentSets(std::unique_ptr<detail::CompartmentSets>&& impl);
    CompartmentSets(detail::CompartmentSets&& impl);
    CompartmentSets(CompartmentSets&&) noexcept;
    CompartmentSets(const CompartmentSets& other) = delete;
    CompartmentSets& operator=(CompartmentSets&&) noexcept;
    ~CompartmentSets();
 
    static CompartmentSets fromFile(const std::string& path);
 
    CompartmentSet getCompartmentSet(const std::string& key) const;
 
    std::size_t size() const;
 
    bool empty() const;
 
    bool contains(const std::string& key) const;
 
    std::vector<std::string> names() const;
 
    std::vector<CompartmentSet> getAllCompartmentSets() const;
 
    std::vector<std::pair<std::string, CompartmentSet>> items() const;
 
    std::string toJSON() const;
 
    bool operator==(const CompartmentSets& other) const;
    bool operator!=(const CompartmentSets& other) const;
 
private:
    std::unique_ptr<detail::CompartmentSets> impl_;
};
 
}  // namespace sonata
}  // namespace bbp