constant_mdspan_policies.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_CONSTANT_MDSPAN_POLICIES_HPP
#define OPENKALMAN_CONSTANT_MDSPAN_POLICIES_HPP

#include "basics/basics.hpp"

namespace OpenKalman::internal
{
  struct layout_constant
  {
    template<class Extents>
    struct mapping
    {
      using extents_type = Extents;
      using index_type = typename extents_type::index_type;
      using size_type = typename extents_type::size_type;
      using rank_type = typename extents_type::rank_type;
      using layout_type = layout_constant;

      constexpr explicit
      mapping(const extents_type& e) : extents_(e) {}

      constexpr const extents_type&
      extents() const noexcept { return extents_; }

      constexpr index_type
#ifdef __cpp_concepts
      operator() (std::convertible_to<index_type> auto...i) const
#else
      template<typename...IndexTypes, std::enable_if_t<
        (... and std::is_convertible_v<IndexTypes, index_type>), int> = 0>
      operator() (IndexTypes...i) const
#endif
      {
        return 0;
      }

      constexpr index_type
      required_span_size() const noexcept { return 0; }

      static constexpr bool is_always_unique() noexcept { return false; }
      static constexpr bool is_always_exhaustive() noexcept { return false; }
      static constexpr bool is_always_strided() noexcept { return false; }

      constexpr bool is_unique() const { return false; }
      constexpr bool is_exhaustive() const { return false; }
      constexpr bool is_strided() const { return false; }

      constexpr index_type
      stride(std::size_t) const { return 0; }

      template<class OtherExtents>
      friend constexpr bool
      operator==(const mapping& lhs, const mapping<OtherExtents>& rhs) noexcept
      {
        return lhs.extents() == rhs.extents();
      }

    private:

      extents_type extents_;

    };
  };


  template<typename ElementType>
  struct accessor_constant {
    using offset_policy = accessor_constant;
    using element_type = ElementType;
    using reference = const element_type&;
    using data_handle_type = const element_type*;

    constexpr accessor_constant() noexcept = default;

#ifdef __cpp_concepts
    template<stdex::convertible_to<element_type> OtherElementType>
#else
    template<typename OtherElementType, std::enable_if_t<stdex::convertible_to<OtherElementType, element_type>, int> = 0>
#endif
    constexpr accessor_constant(const accessor_constant<OtherElementType>& other) noexcept
      : element_ {other.element_} {}

#ifdef __cpp_concepts
    template<stdex::convertible_to<element_type> OtherElementType>
#else
    template<typename OtherElementType, std::enable_if_t<stdex::convertible_to<OtherElementType, element_type>, int> = 0>
#endif
    constexpr accessor_constant(accessor_constant<OtherElementType>&& other) noexcept
      : element_ {std::move(other).element_} {}

    constexpr accessor_constant(ElementType e) : element_ {std::move(e)} {}

    constexpr reference
    access(data_handle_type p, std::size_t i) const noexcept { return element_; }

    constexpr data_handle_type
    offset(data_handle_type p, std::size_t i) const noexcept { return &element_; }

    constexpr data_handle_type
    data_handle() const noexcept { return &element_; }

  private:

    const ElementType element_;

    template<typename OtherElementType>
    friend struct accessor_constant;

  };


}

#endif