indexible_object_traits.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) 2022-2024 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_INDEXIBLE_OBJECT_TRAITS_HPP
#define OPENKALMAN_INDEXIBLE_OBJECT_TRAITS_HPP

#include <type_traits>
#include <tuple>

namespace OpenKalman::interface
{
#ifdef __cpp_concepts
  template<typename T>
#else
  template<typename T, typename>
#endif
  struct indexible_object_traits
  {
#ifdef DOXYGEN_SHOULD_SKIP_THIS

    using scalar_type = double;


#ifdef __cpp_concepts
    static constexpr values::index auto
#else
    static constexpr auto
#endif
    count_indices(const T& arg) = delete;


#ifdef __cpp_concepts
    static constexpr coordinates::pattern auto
    get_vector_space_descriptor(const T& arg, const values::index auto& n) = delete;
#else
    template<typename N, std::enable_if_t<values::index<N>, int> = 0>
    static constexpr auto
    get_vector_space_descriptor(const T& arg, const N& n) = delete;
#endif


#ifdef __cpp_concepts
    static indexible decltype(auto)
    nested_object(std::convertible_to<const T&> auto&& arg) = delete;
#else
    template<typename Arg, std::enable_if_t<std::is_convertible_v<Arg, const T&>, int> = 0>
    static decltype(auto)
    nested_object(Arg&& arg) = delete;
#endif


#ifdef __cpp_concepts
    static constexpr values::scalar auto
#else
    static constexpr auto
#endif
    get_constant(const T& arg) = delete;


#ifdef __cpp_concepts
    static constexpr values::scalar auto
#else
    static constexpr auto
#endif
    get_constant_diagonal(const T& arg) = delete;


    template<Applicability b>
    static constexpr bool
    one_dimensional = false;


    template<Applicability b>
    static constexpr bool
    is_square = false;


    template<TriangleType t>
    static constexpr bool
    is_triangular = false;


    static constexpr bool
    is_triangular_adapter = false;


    static constexpr bool
    is_hermitian = false;


    static constexpr HermitianAdapterType
    hermitian_adapter_type = HermitianAdapterType::any;


    static constexpr bool
    is_writable = false;


#ifdef __cpp_lib_concepts
    template<std::convertible_to<const T&> Arg> requires requires(Arg&& arg) { {*std::forward<Arg>(arg).data()} -> values::scalar; } and direct_access
    static constexpr values::number decltype(auto)
#else
    template<typename Arg, std::enable_if_t<
      std::is_convertible_v<Arg, const T> and values::scalar<decltype(*std::declval<Arg&&>().data())> and direct_access, int> = 0>
    static constexpr auto decltype(auto)
#endif
    raw_data(Arg&& arg) = delete;


    static constexpr Layout
    layout = Layout::none;


    static constexpr auto
    strides(const T& arg) = delete;

#endif // DOXYGEN_SHOULD_SKIP_THIS
  };

} // namespace OpenKalman::interface


#endif //OPENKALMAN_INDEXIBLE_OBJECT_TRAITS_HPP