Diffusion akantu (bugfixes/missing_information_in_doc) Browse

missing_inform…

aka_zip_iterator.hh
View Options

			/**
			* @file aka_zip_iterator.hh
			*
			* @author Nicolas Richart
			*
			* @date creation jeu déc 12 2019
			*
			* @brief A Documented file.
			*
			*
			* Copyright (©) 2010-2011 EPFL (Ecole Polytechnique Fédérale de Lausanne)
			* Laboratory (LSMS - Laboratoire de Simulation en Mécanique des Solides)
			*
			* akantu-iterators is free software: you can redistribute it and/or modify it
			* under the terms of the GNU Lesser General Public License as published by
			* the Free Software Foundation, either version 3 of the License, or (at your
			* option) any later version.
			*
			* akantu-iterators is distributed in the hope that it will be useful, but
			* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
			* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
			* License for more details.
			*
			* You should have received a copy of the GNU Lesser General Public License
			* along with akantu-iterators. If not, see <http://www.gnu.org/licenses/>.
			*
			*/
			/* -------------------------------------------------------------------------- */
			#include "aka_compatibilty_with_cpp_standard.hh"
			#include "aka_iterator_tools.hh"
			#include "aka_tuple_tools.hh"
			/* -------------------------------------------------------------------------- */
			#include <iterator>
			#include <utility>
			/* -------------------------------------------------------------------------- */

			#ifndef AKA_ZIP_ITERATOR_HH
			#define AKA_ZIP_ITERATOR_HH

			#ifndef AKANTU_ITERATORS_NAMESPACE
			#define AKANTU_ITERATORS_NAMESPACE akantu
			#endif

			namespace AKANTU_ITERATORS_NAMESPACE {

			/* -------------------------------------------------------------------------- */
			namespace iterators {
			/* ------------------------------------------------------------------------ */
			template <template <class...> class Tuple, class... Iterators>
			class ZipIterator_
			: public details::CopyAssignmentEnabler<
			aka::conjunction<std::is_copy_assignable<Iterators>...,
			std::is_copy_constructible<Iterators>...>::value>,
			public details::MoveAssignmentEnabler<
			aka::conjunction<std::is_move_assignable<Iterators>...,
			std::is_move_constructible<Iterators>...>::value> {
			private:
			using tuple_t = Tuple<Iterators...>;

			public:
			using value_type =
			Tuple<typename std::iterator_traits<Iterators>::value_type...>;
			using difference_type = std::common_type_t<
			typename std::iterator_traits<Iterators>::difference_type...>;
			using pointer = Tuple<typename std::iterator_traits<Iterators>::pointer...>;
			using reference =
			Tuple<typename std::iterator_traits<Iterators>::reference...>;
			using iterator_category = // std::input_iterator_tag;
			std::common_type_t<
			typename std::iterator_traits<Iterators>::iterator_category...>;

			// using nb_iterators = sizeof...(Iterators);

			public:
			explicit ZipIterator_(tuple_t iterators)
			: iterators(std::move(iterators)) {}

			/* ---------------------------------------------------------------------- */
			template <class iterator_category_ = iterator_category,
			std::enable_if_t<aka::is_iterator_category_at_least<
			iterator_category_,
			std::bidirectional_iterator_tag>::value> * = nullptr>
			ZipIterator_ & operator--() {
			tuple::foreach ([](auto && it) { --it; }, iterators);
			return *this;
			}

			template <class iterator_category_ = iterator_category,
			std::enable_if_t<aka::is_iterator_category_at_least<
			iterator_category_,
			std::bidirectional_iterator_tag>::value> * = nullptr>
			ZipIterator_ operator--(int) {
			auto cpy = *this;
			this->operator--();
			return cpy;
			}

			// input iterator ++it
			ZipIterator_ & operator++() {
			tuple::foreach ([](auto && it) { ++it; }, iterators);
			return *this;
			}

			// input iterator it++
			ZipIterator_ operator++(int) {
			auto cpy = *this;
			this->operator++();
			return cpy;
			}

			// input iterator it != other_it
			bool operator!=(const ZipIterator_ & other) const {
			// return tuple::are_not_equal(iterators, other.iterators);
			return std::get<0>(iterators) !=
			std::get<0>(other.iterators); // helps the compiler to optimize
			}

			// input iterator dereference *it
			decltype(auto) operator*() {
			return tuple::transform([](auto && it) -> decltype(auto) { return *it; },
			iterators);
			}

			template <class iterator_category_ = iterator_category,
			std::enable_if_t<aka::is_iterator_category_at_least<
			iterator_category_,
			std::random_access_iterator_tag>::value> * = nullptr>
			difference_type operator-(const ZipIterator_ & other) {
			return std::get<0>(this->iterators) - std::get<0>(other.iterators);
			}

			// random iterator it[idx]
			template <class iterator_category_ = iterator_category,
			std::enable_if_t<aka::is_iterator_category_at_least<
			iterator_category_,
			std::random_access_iterator_tag>::value> * = nullptr>
			decltype(auto) operator[](std::size_t idx) {
			return tuple::transform(
			[idx](auto && it) -> decltype(auto) { return it[idx]; }, iterators);
			}

			// random iterator it + n
			template <class iterator_category_ = iterator_category,
			std::enable_if_t<aka::is_iterator_category_at_least<
			iterator_category_,
			std::random_access_iterator_tag>::value> * = nullptr>
			decltype(auto) operator+(std::size_t n) {
			return ZipIterator_(std::forward<tuple_t>(tuple::transform(
			[n](auto && it) -> decltype(auto) { return it + n; }, iterators)));
			}

			// random iterator it - n
			template <class iterator_category_ = iterator_category,
			std::enable_if_t<aka::is_iterator_category_at_least<
			iterator_category_,
			std::random_access_iterator_tag>::value> * = nullptr>
			decltype(auto) operator-(std::size_t n) {
			return ZipIterator_(std::forward<tuple_t>(tuple::transform(
			[n](auto && it) -> decltype(auto) { return it - n; }, iterators)));
			}

			template <
			class iterator_category_ = iterator_category,
			std::enable_if_t<aka::is_iterator_category_at_least<
			iterator_category_, std::forward_iterator_tag>::value> * = nullptr>
			bool operator==(const ZipIterator_ & other) const {
			return not tuple::are_not_equal(iterators, other.iterators);
			}

			private:
			tuple_t iterators;
			};

			template <class... Iterators>
			using ZipIterator = ZipIterator_<std::tuple, Iterators...>;

			template <class... Iterators>
			using NamedZipIterator = ZipIterator_<tuple::named_tuple, Iterators...>;
			} // namespace iterators

			/* -------------------------------------------------------------------------- */
			template <class... Iterators>
			decltype(auto) zip_iterator(std::tuple<Iterators...> && iterators_tuple) {
			auto zip = iterators::ZipIterator<Iterators...>(
			std::forward<decltype(iterators_tuple)>(iterators_tuple));
			return zip;
			}

			template <class... Iterators>
			decltype(auto)
			zip_iterator(tuple::named_tuple<Iterators...> && iterators_tuple) {
			auto zip = iterators::NamedZipIterator<Iterators...>(
			std::forward<decltype(iterators_tuple)>(iterators_tuple));
			return zip;
			}

			/* -------------------------------------------------------------------------- */
			namespace containers {
			template <template <class...> class Tuple, class... Containers>
			class ZipContainer_ {
			using containers_t = Tuple<Containers...>;

			public:
			explicit ZipContainer_(Containers &&... containers)
			: containers(std::forward<Containers>(containers)...) {}

			decltype(auto) begin() const {
			return zip_iterator(
			tuple::transform([](auto && c) { return c.begin(); },
			std::forward<containers_t>(containers)));
			}

			decltype(auto) end() const {
			return zip_iterator(
			tuple::transform([](auto && c) { return c.end(); },
			std::forward<containers_t>(containers)));
			}

			decltype(auto) begin() {
			return zip_iterator(
			tuple::transform([](auto && c) { return c.begin(); },
			std::forward<containers_t>(containers)));
			}

			decltype(auto) end() {
			return zip_iterator(
			tuple::transform([](auto && c) { return c.end(); },
			std::forward<containers_t>(containers)));
			}

			private:
			containers_t containers;
			};

			template <class... Containers>
			using ZipContainer = ZipContainer_<std::tuple, Containers...>;

			template <class... Containers>
			using NamedZipContainer = ZipContainer_<tuple::named_tuple, Containers...>;
			} // namespace containers

			/* -------------------------------------------------------------------------- */
			template <class... Containers> decltype(auto) zip(Containers &&... conts) {
			return containers::ZipContainer<Containers...>(
			std::forward<Containers>(conts)...);
			}

			template <class... NamedContainers>
			decltype(auto) named_zip(NamedContainers &&... conts) {
			return containers::NamedZipContainer<NamedContainers...>(
			std::forward<NamedContainers>(conts)...);
			}

			/* -------------------------------------------------------------------------- */
			template <class... zip_container_t>
			decltype(auto) make_zip_cat(zip_container_t &&... cont) {
			return make_transform_adaptor(
			zip(std::forward<zip_container_t>(cont)...),
			[](auto && value) { return tuple::flatten(value); });
			}

			} // namespace AKANTU_ITERATORS_NAMESPACE

			namespace std {
			template <template <class...> class Tuple, typename... Its>
			struct iterator_traits<
			::AKANTU_ITERATORS_NAMESPACE::iterators::ZipIterator_<Tuple, Its...>> {
			private:
			using iterator_type =
			typename ::AKANTU_ITERATORS_NAMESPACE::iterators::ZipIterator_<Tuple,
			Its...>;

			public:
			using iterator_category = typename iterator_type::iterator_category;
			using value_type = typename iterator_type::value_type;
			using difference_type = typename iterator_type::difference_type;
			using pointer = typename iterator_type::pointer;
			using reference = typename iterator_type::reference;
			};
			} // namespace std

			#endif /* AKA_ZIP_ITERATOR_HH */

rAKA/third-party/akantu_iterators/include/iterators/aka_zip_iterator.hh9f083289cd9bbugfixes/missing_inform…

aka_zip_iterator.hhView Options

rAKA/third-party/akantu_iterators/include/iterators/aka_zip_iterator.hh
9f083289cd9bbugfixes/missing_inform…

aka_zip_iterator.hh
View Options