Skip to content

make LinkCollectionIterator fulfil std::input_iterator concept #725

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tmadlener merged 1 commit into from
Jan 17, 2025
Merged

make LinkCollectionIterator fulfil std::input_iterator concept #725

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 30 additions & 10 deletions include/podio/detail/LinkCollectionIterator.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@

#include "podio/detail/LinkFwd.h"
#include "podio/utilities/MaybeSharedPtr.h"
#include <iterator>

namespace podio {
template <typename FromT, typename ToT, bool Mutable>
Expand All @@ -11,20 +12,33 @@ class LinkCollectionIteratorT {
using LinkObjT = LinkObj<FromT, ToT>;

public:
using value_type = LinkType;
using difference_type = ptrdiff_t;
using reference = LinkType;
using pointer = LinkType*;
using iterator_category = std::input_iterator_tag;
using iterator_concept = std::input_iterator_tag;

LinkCollectionIteratorT(size_t index, const LinkObjPointerContainer<FromT, ToT>* coll) :
m_index(index), m_object(podio::utils::MaybeSharedPtr<LinkObjT>{nullptr}), m_collection(coll) {
}

LinkCollectionIteratorT(const LinkCollectionIteratorT&) = delete;
LinkCollectionIteratorT& operator=(const LinkCollectionIteratorT&) = delete;
LinkCollectionIteratorT() = default;
LinkCollectionIteratorT(const LinkCollectionIteratorT&) = default;
LinkCollectionIteratorT& operator=(const LinkCollectionIteratorT&) = default;
LinkCollectionIteratorT(LinkCollectionIteratorT&&) = default;
LinkCollectionIteratorT& operator=(LinkCollectionIteratorT&&) = default;
~LinkCollectionIteratorT() = default;

bool operator!=(const LinkCollectionIteratorT& other) const {
return m_index != other.m_index; // TODO: may not be complete
return m_index != other.m_index;
}

LinkType operator*() {
m_object.m_obj = podio::utils::MaybeSharedPtr<LinkObjT>((*m_collection)[m_index]);
return m_object;
bool operator==(const LinkCollectionIteratorT& other) const {
return m_index == other.m_index;
}

LinkType operator*() const {
return LinkType{podio::utils::MaybeSharedPtr<LinkObjT>((*m_collection)[m_index])};
}

LinkType* operator->() {
Expand All @@ -37,10 +51,16 @@ class LinkCollectionIteratorT {
return *this;
}

LinkCollectionIteratorT operator++(int) {
auto copy = *this;
++m_index;
return copy;
}

private:
size_t m_index;
LinkType m_object;
const LinkObjPointerContainer<FromT, ToT>* m_collection;
size_t m_index{0};
LinkType m_object{podio::utils::MaybeSharedPtr<LinkObjT>{nullptr}};
const LinkObjPointerContainer<FromT, ToT>* m_collection{nullptr};
};
} // namespace podio

Expand Down
18 changes: 18 additions & 0 deletions tests/unittests/std_interoperability.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
#include "datamodel/ExampleHit.h"
#include "datamodel/ExampleHitCollection.h"
#include "datamodel/MutableExampleHit.h"
#include "podio/LinkCollection.h"

#include <catch2/catch_test_macros.hpp>

Expand Down Expand Up @@ -1184,5 +1185,22 @@ TEST_CASE("Collection and unsupported std ranges algorithms", "[collection][rang
DOCUMENTED_STATIC_FAILURE(is_range_fillable<CollectionType>);
}

TEST_CASE("LinkCollectionIterator and iterator concepts", "[links][iterator][std]") {
using link_iterator = podio::LinkCollectionIteratorT<ExampleHit, ExampleHit, true>;
using link_const_iterator = podio::LinkCollectionIteratorT<ExampleHit, ExampleHit, false>;

STATIC_REQUIRE(std::input_iterator<link_iterator>);
STATIC_REQUIRE(std::input_iterator<link_const_iterator>);
}

TEST_CASE("LinkCollection and range concepts", "[links][iterator][std]") {
using link_collection = podio::LinkCollection<ExampleHit, ExampleHit>;

STATIC_REQUIRE(std::ranges::input_range<link_collection>);
STATIC_REQUIRE(std::ranges::sized_range<link_collection>);
STATIC_REQUIRE(std::ranges::common_range<link_collection>);
STATIC_REQUIRE(std::ranges::viewable_range<link_collection>);
}

#undef DOCUMENTED_STATIC_FAILURE
#undef DOCUMENTED_FAILURE
Loading