list_value.hpp

Go to the documentation of this file.

// Copyright 2024 Man Group Operations Limited
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#pragma once
 
#include <ostream>
 
#include "sparrow/config/config.hpp"
#include "sparrow/layout/array_wrapper.hpp"
#include "sparrow/types/data_traits.hpp"
#include "sparrow/utils/iterator.hpp"
 
namespace sparrow
{
 
    class list_value;

    class SPARROW_API list_value_iterator : public iterator_base<
                                                list_value_iterator,
                                                array_traits::const_reference,
                                                std::random_access_iterator_tag,
                                                array_traits::const_reference>
    {
    public:
 
        using self_type = list_value_iterator;
        using base_type = iterator_base<list_value_iterator, list_value, std::random_access_iterator_tag>;
        using size_type = size_t;

        list_value_iterator() noexcept = default;

        list_value_iterator(const list_value* layout, size_type index);
 
    private:

        [[nodiscard]] reference dereference() const;

        void increment();

        void decrement();

        void advance(difference_type n);

        [[nodiscard]] difference_type distance_to(const self_type& rhs) const;

        [[nodiscard]] bool equal(const self_type& rhs) const;

        [[nodiscard]] bool less_than(const self_type& rhs) const;
 
        const list_value* m_list_value = nullptr;  
        difference_type m_index;                   
 
        friend class iterator_access;
    };

    class SPARROW_API list_value
    {
    public:
 
        using value_type = array_traits::value_type;
        using const_reference = array_traits::const_reference;
        using size_type = std::size_t;
        using list_value_reverse_iterator = std::reverse_iterator<list_value_iterator>;

        list_value() = default;

        list_value(const array_wrapper* flat_array, size_type index_begin, size_type index_end);

        [[nodiscard]] size_type size() const;

        [[nodiscard]] bool empty() const;

        const_reference operator[](size_type i) const;

        [[nodiscard]] const_reference front() const;

        [[nodiscard]] const_reference back() const;

        [[nodiscard]] list_value_iterator begin();

        [[nodiscard]] list_value_iterator begin() const;

        [[nodiscard]] list_value_iterator cbegin() const;

        [[nodiscard]] list_value_iterator end();

        [[nodiscard]] list_value_iterator end() const;

        [[nodiscard]] list_value_iterator cend() const;

        [[nodiscard]] list_value_reverse_iterator rbegin();

        [[nodiscard]] list_value_reverse_iterator rbegin() const;

        [[nodiscard]] list_value_reverse_iterator crbegin() const;

        [[nodiscard]] list_value_reverse_iterator rend();

        [[nodiscard]] list_value_reverse_iterator rend() const;

        [[nodiscard]] list_value_reverse_iterator crend() const;
 
    private:
 
        const array_wrapper* p_flat_array = nullptr;  
        size_type m_index_begin = 0u;                 
        size_type m_index_end = 0u;                   
    };

    SPARROW_API
    bool operator==(const list_value& lhs, const list_value& rhs);
}
 
#if defined(__cpp_lib_format)
 
template <>
struct std::formatter<sparrow::list_value>
{
    constexpr auto parse(std::format_parse_context& ctx) -> decltype(ctx.begin())
    {
        return ctx.begin();  // Simple implementation
    }
 
    SPARROW_API auto format(const sparrow::list_value& list_value, std::format_context& ctx) const
        -> decltype(ctx.out());
};
 
namespace sparrow
{
    SPARROW_API std::ostream& operator<<(std::ostream& os, const list_value& value);
}
 
#endif