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-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_OBJECT_TRAITS_HPP
#define OPENKALMAN_OBJECT_TRAITS_HPP

#ifdef DOXYGEN_SHOULD_SKIP_THIS
#include "coordinates/coordinates.hpp"
#include "linear-algebra/enumerations.hpp"
#endif

namespace OpenKalman::interface
{
#ifdef __cpp_concepts
  template<typename T>
#else
  template<typename T, typename = void>
#endif
  struct object_traits
  {
    static const bool
    is_specialized = false;


#ifdef DOXYGEN_SHOULD_SKIP_THIS

    static constexpr auto
    get_mdspan = [](std::convertible_to<const T&> auto&& t) -> decltype(auto) { return std::mdspan{t}; };


    static constexpr auto
    get_pattern_collection = [](std::convertible_to<const T&> auto&&)
      -> coordinates::pattern_collection decltype(auto) { return std::tuple{}; };


    static constexpr triangle_type
    triangle_type_value = triangle_type::none;


    static constexpr auto
    get_constant = [](std::convertible_to<const T&> auto&&) -> values::value auto { return ...; };


    static constexpr auto
    nested_object = [](std::convertible_to<const T&> auto&& t)
      -> indexible decltype(auto) { return std::forward<decltype(t)>(t); };


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


    static constexpr bool
    is_triangular_adapter = false;


    static constexpr bool
    is_hermitian = false;


    static constexpr HermitianAdapterType
    hermitian_adapter_type = HermitianAdapterType::any;

#endif // DOXYGEN_SHOULD_SKIP_THIS
  };

}


#endif