single.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_SINGLE_HPP
#define OPENKALMAN_COMPATIBILITY_VIEWS_SINGLE_HPP

#include "basics/compatibility/internal/movable_box.hpp"
#include "view-concepts.hpp"
#include "view_interface.hpp"

namespace OpenKalman::stdex::ranges
{
#ifdef __cpp_lib_ranges
  using std::ranges::single_view;
  namespace views
  {
    using std::ranges::views::single;
  }
#else

#ifdef __cpp_concepts
  template<std::move_constructible T> requires std::is_object_v<T>
#else
  template<typename T>
#endif
  struct single_view : view_interface<single_view<T>>
  {
    static_assert(stdex::move_constructible<T> and std::is_object_v<T>);


#ifdef __cpp_concepts
    constexpr
    single_view() requires std::default_initializable<T> = default;
#else
    template<bool Enable = true, std::enable_if_t<Enable and stdex::default_initializable<T>, int> = 0>
    constexpr
    single_view() {}
#endif


#ifdef __cpp_concepts
    explicit constexpr
    single_view(const T& t) requires std::copy_constructible<T> : value_ {t} {}
    requires std::copy_constructible<T>
#else
    template<bool Enable = true, std::enable_if_t<stdex::copy_constructible<T>, int> = 0>
    explicit constexpr
    single_view(const T& t) : value_ {t} {}
#endif


    explicit constexpr
    single_view(T&& t) : value_ {std::move(t)} {}


    constexpr T*
    begin() noexcept { return data(); }

    constexpr const T*
    begin() const noexcept { return data(); }


    constexpr T*
    end() noexcept { return data() + 1_uz; }

    constexpr const T*
    end() const noexcept { return data() + 1_uz; }


    static constexpr auto
    empty() noexcept { return false; }


    static constexpr std::size_t
    size() noexcept { return 1_uz; }


    constexpr T*
    data() noexcept { return std::addressof(*value_); }


    constexpr const T*
    data() const noexcept { return std::addressof(*value_); }

  private:

    OpenKalman::internal::movable_box<T> value_;

  };


  template<typename Arg>
  single_view(Arg) -> single_view<Arg>;


#ifdef __cpp_impl_three_way_comparison
  template<typename T>
  constexpr std::partial_ordering
  operator<=>(const single_view<T>& lhs, const T& rhs) noexcept
  {
    return get(lhs, std::integral_constant<std::size_t, 0>{}) <=> rhs;
  }

  template<typename T>
  constexpr bool
  operator==(const single_view<T>& lhs, const T& rhs) noexcept
  {
    return stdex::is_eq(operator<=>(lhs, rhs));
  }
#else
  template<typename T>
  constexpr bool operator==(const single_view<T>& lhs, const T& rhs) noexcept { return get(lhs, std::integral_constant<std::size_t, 0>{}) == rhs; }

  template<typename T>
  constexpr bool operator!=(const single_view<T>& lhs, const T& rhs) noexcept { return get(lhs, std::integral_constant<std::size_t, 0>{}) != rhs; }

  template<typename T>
  constexpr bool operator<(const single_view<T>& lhs, const T& rhs) noexcept { return get(lhs, std::integral_constant<std::size_t, 0>{}) < rhs; }

  template<typename T>
  constexpr bool operator>(const single_view<T>& lhs, const T& rhs) noexcept { return get(lhs, std::integral_constant<std::size_t, 0>{}) > rhs; }

  template<typename T>
  constexpr bool operator<=(const single_view<T>& lhs, const T& rhs) noexcept { return get(lhs, std::integral_constant<std::size_t, 0>{}) <= rhs; }

  template<typename T>
  constexpr bool operator>=(const single_view<T>& lhs, const T& rhs) noexcept { return get(lhs, std::integral_constant<std::size_t, 0>{}) >= rhs; }


  template<typename T>
  constexpr bool operator==(const T& lhs, const single_view<T>& rhs) noexcept { return lhs == get(rhs, std::integral_constant<std::size_t, 0>{}); }

  template<typename T>
  constexpr bool operator!=(const T& lhs, const single_view<T>& rhs) noexcept { return lhs != get(rhs, std::integral_constant<std::size_t, 0>{}); }

  template<typename T>
  constexpr bool operator<(const T& lhs, const single_view<T>& rhs) noexcept { return lhs < get(rhs, std::integral_constant<std::size_t, 0>{}); }

  template<typename T>
  constexpr bool operator>(const T& lhs, const single_view<T>& rhs) noexcept { return lhs > get(rhs, std::integral_constant<std::size_t, 0>{}); }

  template<typename T>
  constexpr bool operator<=(const T& lhs, const single_view<T>& rhs) noexcept { return lhs <= get(rhs, std::integral_constant<std::size_t, 0>{}); }

  template<typename T>
  constexpr bool operator>=(const T& lhs, const single_view<T>& rhs) noexcept { return lhs >= get(rhs, std::integral_constant<std::size_t, 0>{}); }

#endif


  namespace views
  {
    namespace detail
    {
      struct single_impl
      {
        template<typename T>
        constexpr auto
        operator() [[nodiscard]] (T&& t) const { return single_view<std::decay_t<T>> {std::forward<T>(t)}; }
      };
    }


    inline constexpr detail::single_impl single;

  }

#endif
}

#endif