make_complex_number.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_MAKE_COMPLEX_NUMBER_HPP
#define OPENKALMAN_MAKE_COMPLEX_NUMBER_HPP

#include "values/interface/number_traits.hpp"
#include "values/concepts/number.hpp"
#include "values/concepts/complex.hpp"
#include "values/math/real.hpp"
#include "values/math/imag.hpp"
#include "values/traits/real_type_of_t.hpp"

namespace OpenKalman::values::internal
{
#ifdef __cpp_concepts
  template<values::complex T, std::convertible_to<real_type_of_t<T>> Re, std::convertible_to<real_type_of_t<T>> Im = Re> requires
    values::value<Re> and values::value<Im> and (not values::complex<Re>) and (not values::complex<Im>)
#else
  template<typename T, typename Re, typename Im = Re, std::enable_if_t<values::complex<T> and
    std::is_convertible_v<Re, real_type_of_t<T>> and std::is_convertible_v<Im, real_type_of_t<T>> and
    values::value<Re> and values::value<Im> and (not values::complex<Re>) and (not values::complex<Im>), int> = 0>
#endif
  constexpr std::decay_t<T>
  make_complex_number(Re&& re, Im&& im = 0)
  {
    return interface::number_traits<std::decay_t<T>>::make_complex(std::forward<Re>(re), std::forward<Im>(im));
  }


#ifdef __cpp_concepts
  template<values::value T, values::complex Arg> requires std::constructible_from<real_type_of_t<T>, real_type_of_t<Arg>>
  constexpr values::complex decltype(auto)
#else
  template<typename T, typename Arg, std::enable_if_t<values::value<T> and values::complex<Arg> and
    std::is_constructible_v<real_type_of_t<T>, real_type_of_t<Arg>>, int> = 0>
  constexpr decltype(auto)
#endif
  make_complex_number(Arg&& arg)
  {
    using R = real_type_of_t<T>;
    if constexpr (std::is_same_v<R, std::decay_t<Arg>>)
    {
      return std::forward<Arg>(arg);
    }
    else
    {
      return interface::number_traits<std::decay_t<T>>::make_complex(
        static_cast<R>(values::real(arg)), static_cast<R>(values::imag(arg)));
    }
  }


#ifdef __cpp_concepts
  template<values::number Re, values::number Im> requires
    (not values::complex<Re>) and (not values::complex<Im>) and std::common_with<Re, Im>
  constexpr values::complex auto
#else
  template<typename Re, typename Im, std::enable_if_t<values::number<Re> and values::number<Im> and
    (not values::complex<Re>) and (not values::complex<Im>), int> = 0>
  constexpr auto
#endif
  make_complex_number(const Re& re, const Im& im = 0)
  {
    return interface::number_traits<std::decay_t<std::common_type_t<Re, Im>>>::make_complex(re, im);
  }


} // namespace OpenKalman::values::internal

#endif //OPENKALMAN_MAKE_COMPLEX_NUMBER_HPP