BLT/include/blt/iterator/zip.h

#pragma once
/*
 *  Copyright (C) 2024  Brett Terpstra
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program 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 General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

#ifndef BLT_ITERATOR_ZIP
#define BLT_ITERATOR_ZIP

#include <blt/iterator/iter_common.h>
#include <blt/meta/meta.h>
#include <blt/meta/iterator.h>
#include <tuple>

namespace blt
{
    namespace iterator
    {
        template<typename Tag, typename... Iter>
        class zip_wrapper;
        
        template<typename... Iter>
        class zip_wrapper<std::input_iterator_tag, Iter...>
        {
            public:
                using iterator_category = std::input_iterator_tag;
                using value_type = std::tuple<meta::deref_return_t<Iter>...>;
                using difference_type = blt::ptrdiff_t;
                using pointer = value_type;
                using reference = value_type;
                
                explicit zip_wrapper(Iter... iter): iter(std::make_tuple(iter...))
                {}
                
                std::tuple<meta::deref_return_t<Iter>...> operator*() const
                {
                    return std::apply([](auto& ... i) { return std::tuple<meta::deref_return_t<Iter>...>{*i...}; }, iter);
                }
                
                friend bool operator==(const zip_wrapper& a, const zip_wrapper& b)
                {
                    return a.iter == b.iter;
                }
                
                friend bool operator!=(const zip_wrapper& a, const zip_wrapper& b)
                {
                    return !(a.iter == b.iter);
                }
                
                zip_wrapper& operator++()
                {
                    std::apply([](auto& ... i) { ((++i), ...); }, iter);
                    return *this;
                }
                
                zip_wrapper operator++(int)
                {
                    auto tmp = *this;
                    ++*this;
                    return tmp;
                }
                
                auto raw_tuple()
                {
                    return iter;
                }
            
            protected:
                std::tuple<Iter...> iter;
        };
        
        template<typename... Iter>
        class zip_wrapper<std::forward_iterator_tag, Iter...> : public zip_wrapper<std::input_iterator_tag, Iter...>
        {
            public:
                using iterator_category = std::forward_iterator_tag;
                using value_type = std::tuple<meta::deref_return_t<Iter>...>;
                using difference_type = blt::ptrdiff_t;
                using pointer = value_type;
                using reference = value_type;
                
                using zip_wrapper<std::input_iterator_tag, Iter...>::zip_wrapper;
        };
        
        template<typename... Iter>
        class zip_wrapper<std::bidirectional_iterator_tag, Iter...> : public zip_wrapper<std::forward_iterator_tag, Iter...>
        {
            public:
                using iterator_category = std::bidirectional_iterator_tag;
                using value_type = std::tuple<meta::deref_return_t<Iter>...>;
                using difference_type = blt::ptrdiff_t;
                using pointer = value_type;
                using reference = value_type;
            public:
                using zip_wrapper<std::forward_iterator_tag, Iter...>::zip_wrapper;
                
                zip_wrapper& operator--()
                {
                    std::apply([](auto& ... i) { ((--i), ...); }, this->iter);
                    return *this;
                }
                
                zip_wrapper operator--(int)
                {
                    auto tmp = *this;
                    --*this;
                    return tmp;
                }
        };
        
        template<typename... Iter>
        class zip_wrapper<std::random_access_iterator_tag, Iter...> : public zip_wrapper<std::bidirectional_iterator_tag, Iter...>
        {
            public:
                using iterator_category = std::random_access_iterator_tag;
                using value_type = std::tuple<meta::deref_return_t<Iter>...>;
                using difference_type = blt::ptrdiff_t;
                using pointer = value_type;
                using reference = value_type;
            private:
                template<typename T, T... n>
                static blt::ptrdiff_t sub(const zip_wrapper& a, const zip_wrapper& b,
                                          std::integer_sequence<T, n...>)
                {
                    blt::ptrdiff_t min = std::numeric_limits<blt::ptrdiff_t>::max();
                    ((min = std::min(min, std::get<n>(a.iter) - std::get<n>(b.iter))), ...);
                    return min;
                }
            
            public:
                using zip_wrapper<std::bidirectional_iterator_tag, Iter...>::zip_wrapper;
                
                zip_wrapper& operator+=(blt::ptrdiff_t n)
                {
                    std::apply([n](auto& ... i) { ((i += n), ...); }, this->iter);
                    return *this;
                }
                
                zip_wrapper& operator-=(blt::ptrdiff_t n)
                {
                    std::apply([n](auto& ... i) { ((i -= n), ...); }, this->iter);
                    return *this;
                }
                
                friend zip_wrapper operator+(const zip_wrapper& a, blt::ptrdiff_t n)
                {
                    return std::apply([n](auto& ... i) { return zip_wrapper{(i + n)...}; }, a.iter);
                }
                
                friend zip_wrapper operator+(blt::ptrdiff_t n, const zip_wrapper& a)
                {
                    return std::apply([n](auto& ... i) { return zip_wrapper{(i + n)...}; }, a.iter);
                }
                
                friend zip_wrapper operator-(const zip_wrapper& a, blt::ptrdiff_t n)
                {
                    return std::apply([n](auto& ... i) { return zip_wrapper{(i - n)...}; }, a.iter);
                }
                
                friend zip_wrapper operator-(blt::ptrdiff_t n, const zip_wrapper& a)
                {
                    return std::apply([n](auto& ... i) { return zip_wrapper{(i - n)...}; }, a.iter);
                }
                
                friend blt::ptrdiff_t operator-(const zip_wrapper& a, const zip_wrapper& b)
                {
                    return sub(a, b, std::index_sequence_for<Iter...>());
                }
                
                auto operator[](blt::ptrdiff_t n) const
                {
                    return *(*this + n);
                }
                
                friend bool operator<(const zip_wrapper& a, const zip_wrapper& b)
                {
                    return b - a > 0;
                }
                
                friend bool operator>(const zip_wrapper& a, const zip_wrapper& b)
                {
                    return b < a;
                }
                
                friend bool operator>=(const zip_wrapper& a, const zip_wrapper& b)
                {
                    return !(a < b); // NOLINT
                }
                
                friend bool operator<=(const zip_wrapper& a, const zip_wrapper& b)
                {
                    return !(a > b); // NOLINT
                }
        };
        
        BLT_META_MAKE_FUNCTION_CHECK(base);
        
        template<typename Iter>
        auto get_base(Iter iter)
        {
            if constexpr (has_func_base_v<Iter>)
            {
                return std::move(iter).base();
            } else
            {
                return std::move(iter);
            }
        }
        
        template<typename Derived>
        class take_impl
        {
            private:
                template<bool check>
                auto take_base(blt::size_t n)
                {
                    static_assert(!std::is_same_v<typename Derived::iterator_category, std::input_iterator_tag>,
                                  "Cannot .take() on an input iterator!");
                    auto* d = static_cast<Derived*>(this);
                    auto begin = d->begin();
                    auto end = d->end();
                    
                    // take variant for forward and bidirectional iterators
                    if constexpr (std::is_same_v<typename Derived::iterator_category, std::forward_iterator_tag> ||
                                  std::is_same_v<typename Derived::iterator_category, std::bidirectional_iterator_tag>)
                    {
                        // with these guys we have to loop forward to move the iterators. an unfortunate inefficiency
                        auto new_end = begin;
                        for (blt::size_t i = 0; i < n; i++)
                        {
                            if constexpr (check)
                            {
                                if (new_end == end)
                                    break;
                            }
                            ++new_end;
                        }
                        return Derived{get_base(std::move(begin)), get_base(std::move(new_end))};
                    } else if constexpr (std::is_same_v<typename Derived::iterator_category, std::random_access_iterator_tag>)
                    {
                        // random access iterators can have math directly applied to them.
                        if constexpr (check)
                        {
                            return Derived{get_base(begin),
                                           get_base(begin + std::min(static_cast<blt::size_t>(n), std::distance(begin, end)))};
                        } else
                        {
                            return Derived{get_base(begin), get_base(begin + n)};
                        }
                    }
                }
            
            public:
                auto take(blt::size_t n)
                { return take_base<false>(n); }
                
                auto take_or(blt::size_t n)
                { return take_base<true>(n); }
        };
        
        template<typename Derived>
        class skip_impl
        {
            private:
                template<bool check>
                auto skip_base(blt::size_t n)
                {
                    auto* d = static_cast<Derived*>(this);
                    auto begin = d->begin();
                    auto end = d->end();
                    
                    if constexpr (std::is_same_v<typename Derived::iterator_category, std::random_access_iterator_tag>)
                    {
                        if constexpr (check)
                        {
                            return Derived{begin + std::min(static_cast<blt::size_t>(n), std::distance(begin, end))};
                        } else
                        {
                            return Derived{begin + n, end};
                        }
                    } else
                    {
                        for (blt::size_t i = 0; i < n; i++)
                        {
                            if constexpr (check){
                                if (begin == end)
                                    break;
                            }
                            ++begin;
                        }
                        return Derived{begin, end};
                    }
                }
            
            public:
                void skip(blt::size_t n)
                { return skip_base<false>(n); }
                
                void skip_or(blt::size_t n)
                { return skip_base<true>(n); }
        };
    }
    
    template<typename Iter>
    struct iterator_pair
    {
        using type = Iter;
        
        iterator_pair(Iter begin, Iter end): begin(std::move(begin)), end(std::move(end))
        {}
        
        Iter begin;
        Iter end;
    };
    
    template<typename... Iter>
    class zip_iterator_storage;
    
    template<typename... Iter>
    class zip_iterator_storage_rev;
    
    template<typename... Iter>
    class zip_iterator_storage : public iterator::take_impl<zip_iterator_storage<Iter...>>
    {
        public:
            using iterator_category = meta::lowest_iterator_category_t<Iter...>;
        public:
            zip_iterator_storage(iterator_pair<Iter>... iterator_pairs):
                    m_begins(std::move(iterator_pairs.begin)...), m_ends(std::move(iterator_pairs.end)...)
            {}
            
            zip_iterator_storage(iterator::zip_wrapper<iterator_category, Iter...> begins, iterator::zip_wrapper<iterator_category, Iter...> ends):
                    m_begins(std::move(begins)), m_ends(std::move(ends))
            {}
            
            auto rev()
            {
                static_assert((std::is_same_v<iterator_category, std::bidirectional_iterator_tag> ||
                               std::is_same_v<iterator_category, std::random_access_iterator_tag>),
                              ".rev() must be used with bidirectional (or better) iterators!");
                return zip_iterator_storage_rev{m_ends, m_begins};
            }
            
            auto skip(blt::size_t n)
            {
                if constexpr (std::is_same_v<iterator_category, std::input_iterator_tag>)
                {
                
                }
            }
            
            auto begin() const
            {
                return m_begins;
            }
            
            auto end() const
            {
                return m_ends;
            }
        
        private:
            iterator::zip_wrapper<iterator_category, Iter...> m_begins;
            iterator::zip_wrapper<iterator_category, Iter...> m_ends;
    };
    
    template<typename... Iter>
    class zip_iterator_storage_rev : public iterator::take_impl<zip_iterator_storage_rev<Iter...>>
    {
        public:
            using iterator_category = meta::lowest_iterator_category_t<Iter...>;
        public:
            zip_iterator_storage_rev(iterator_pair<Iter>... iterator_pairs): m_begins(iterator_pairs.begin...), m_ends(iterator_pairs.end...)
            {
                static_assert((std::is_same_v<iterator_category, std::bidirectional_iterator_tag> ||
                               std::is_same_v<iterator_category, std::random_access_iterator_tag>),
                              "reverse iteration is only supported on bidirectional or better iterators!");
            }
            
            zip_iterator_storage_rev(iterator::zip_wrapper<iterator_category, Iter...> begins,
                                     iterator::zip_wrapper<iterator_category, Iter...> ends): m_begins(std::move(begins)), m_ends(std::move(ends))
            {
                static_assert((std::is_same_v<iterator_category, std::bidirectional_iterator_tag> ||
                               std::is_same_v<iterator_category, std::random_access_iterator_tag>),
                              "reverse iteration is only supported on bidirectional or better iterators!");
            }
            
            auto rev()
            {
                return zip_iterator_storage{m_ends.base(), m_begins.base()};
            }
            
            auto begin() const
            {
                return m_begins;
            }
            
            auto end() const
            {
                return m_ends;
            }
        
        private:
            std::reverse_iterator<iterator::zip_wrapper<iterator_category, Iter...>> m_begins;
            std::reverse_iterator<iterator::zip_wrapper<iterator_category, Iter...>> m_ends;
    };
    
    /*
     * CTAD for the zip containers
     */
    
    template<typename... Iter>
    zip_iterator_storage(iterator_pair<Iter>...) -> zip_iterator_storage<Iter...>;
    
    template<typename... Iter>
    zip_iterator_storage(std::initializer_list<Iter>...) -> zip_iterator_storage<Iter...>;
    
    template<typename... Iter>
    zip_iterator_storage_rev(iterator_pair<Iter>...) -> zip_iterator_storage_rev<Iter...>;
    
    template<typename... Iter>
    zip_iterator_storage_rev(std::initializer_list<Iter>...) -> zip_iterator_storage_rev<Iter...>;
    
    /*
     * Helper functions for creating zip containers
     */
    
    template<typename... Container>
    auto zip(Container& ... container)
    {
        return blt::zip_iterator_storage{iterator_pair{container.begin(), container.end()}...};
    }
}

#endif //BLT_ITERATOR_ZIP