number_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_NUMBER_TRAITS_HPP
#define OPENKALMAN_NUMBER_TRAITS_HPP

#include <limits>
#include <complex>
#include "basics/basics.hpp"

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


    static constexpr bool is_complex = false;


#ifdef DOXYGEN_SHOULD_SKIP_THIS

    static constexpr auto real = [](T t) { return std::real(std::move(t)); };


    static constexpr auto imag = [](T t) { return std::imag(std::move(t)); };


    static constexpr auto make_complex = [](auto re, auto im) { return std::complex<T> {std::move(re), std::move(im)}; };

#endif
  };


#ifdef __cpp_concepts
  template<typename T> requires std::is_arithmetic_v<T>
  struct number_traits<T>
#else
  template<typename T>
  struct number_traits<T, std::enable_if_t<std::is_arithmetic_v<T>>>
#endif
  {
    static constexpr bool is_specialized = true;
    static constexpr bool is_complex = false;
    static constexpr auto real = [](T t) { return std::real(std::move(t)); };
    static constexpr auto imag = [](T t) { return std::imag(std::move(t)); };
    static constexpr auto make_complex = [](T re, T im) { return std::complex<T> {std::move(re), std::move(im)}; };
  };


  template<typename T>
  struct number_traits<std::complex<T>>
  {
    static constexpr bool is_specialized = true;
    static constexpr bool is_complex = true;
    static constexpr auto real = [](std::complex<T> t) { return std::real(std::move(t)); };
    static constexpr auto imag = [](std::complex<T> t) { return std::imag(std::move(t)); };
    static constexpr auto make_complex = [](T re, T im) { return std::complex<T> {std::move(re), std::move(im)}; };
  };

}

#endif