reverse.hpp

Go to the documentation of this file.

/* This file is part of OpenKalman, a header-only C++ library for
 * Kalman filters and other recursive filters.
 *
 * Copyright (c) 2025 Christopher Lee Ogden <ogden@gatech.edu>
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

#ifndef OPENKALMAN_COMPATIBILITY_VIEWS_REVERSE_HPP
#define OPENKALMAN_COMPATIBILITY_VIEWS_REVERSE_HPP

#ifndef __cpp_lib_ranges

#include<type_traits>
#include "basics/compatibility/language-features.hpp"
#include "basics/compatibility/ranges/range-access.hpp"
#include "basics/compatibility/ranges/range-concepts.hpp"
#include "view-concepts.hpp"
#include "view_interface.hpp"
#include "range_adaptor_closure.hpp"
#include "all.hpp"

namespace OpenKalman::ranges
{
  template<typename V>
  struct reverse_view : ranges::view_interface<reverse_view<V>>
  {
    template<bool Enable = true, std::enable_if_t<Enable and std::is_default_constructible_v<V>, int> = 0>
    constexpr reverse_view() {}

    //explicit constexpr reverse_view(V r) : base_ {std::move(r)} {} //- This is what it should be, but doesn't work here

    explicit constexpr reverse_view(V&& r) : base_ {std::move(r)} {}

    explicit constexpr reverse_view(V& r) : base_ {r} {}


    template<bool Enable = true, std::enable_if_t<Enable and std::is_copy_constructible_v<V>, int> = 0>
    constexpr V base() const& { return base_; }

    constexpr V base() && { return std::move(base_); }


    template<bool Enable = true, std::enable_if_t<Enable and not ranges::common_range<V>, int> = 0>
    constexpr std::reverse_iterator<ranges::iterator_t<V>>
    begin()
    { return std::make_reverse_iterator(ranges::next(ranges::begin(base_), ranges::end(base_))); }

    template<bool Enable = true, std::enable_if_t<Enable and ranges::common_range<V>, int> = 0>
    constexpr std::reverse_iterator<ranges::iterator_t<V>>
    begin() { return std::make_reverse_iterator(ranges::end(base_)); }

    template<bool Enable = true, std::enable_if_t<Enable and ranges::common_range<const V>, int> = 0>
    constexpr auto
    begin() const { return std::make_reverse_iterator(ranges::end(base_)); }


    constexpr std::reverse_iterator<ranges::iterator_t<V>>
    end() { return std::make_reverse_iterator(ranges::begin(base_)); }

    template<bool Enable = true, std::enable_if_t<Enable and ranges::common_range<const V>, int> = 0>
    constexpr auto
    end() const { return std::make_reverse_iterator(ranges::begin(base_)); }


    template<bool Enable = true, std::enable_if_t<Enable and ranges::sized_range<const V>, int> = 0>
    constexpr auto
    size() { return ranges::size(base_); }

    template<bool Enable = true, std::enable_if_t<Enable and ranges::sized_range<const V>, int> = 0>
    constexpr auto
    size() const { return ranges::size(base_); }

  private:

    V base_;
  };


  template<typename R>
  reverse_view(R&&) -> reverse_view<views::all_t<R>>;

}


#ifdef __cpp_lib_ranges
namespace std::ranges
#else
namespace OpenKalman::ranges
#endif
{
  template<typename T>
  constexpr bool enable_borrowed_range<OpenKalman::ranges::reverse_view<T>> = enable_borrowed_range<T>;
}


namespace OpenKalman::ranges::views
{
  namespace detail
  {
    struct reverse_closure
      : ranges::range_adaptor_closure<reverse_closure>
    {
      template<typename R, std::enable_if_t<viewable_range<R>, int> = 0>
      constexpr auto
      operator() [[nodiscard]] (R&& r) const
      {
        return reverse_view {all(std::forward<R>(r))};
      }


      template<typename T>
      constexpr auto
      operator() [[nodiscard]] (const reverse_view<T>& r) const
      {
        return r.base();
      }


      template<typename T>
      constexpr auto
      operator() [[nodiscard]] (reverse_view<T>&& r) const
      {
        return std::move(r).base();
      }
    };

  }


  inline constexpr detail::reverse_closure reverse;

}


#endif

#endif //OPENKALMAN_COMPATIBILITY_VIEWS_REVERSE_HPP