arg.hpp

Go to the documentation of this file.

// SPDX-License-Identifier: BSL-1.0
// SPDX-FileCopyrightText: Copyright (C) 2021 Tobias Hienzsch
 
#ifndef TETL_COMPLEX_ARG_HPP
#define TETL_COMPLEX_ARG_HPP
 
#include <etl/_cmath/atan2.hpp>
#include <etl/_complex/complex.hpp>
#include <etl/_concepts/floating_point.hpp>
#include <etl/_concepts/integral.hpp>
 
namespace etl {
 
/// \ingroup complex
template <typename T>
[[nodiscard]] constexpr auto arg(complex<T> const& z) noexcept -> T
{
    return etl::atan2(z.imag(), z.real());
}
 
/// \ingroup complex
template <floating_point Float>
[[nodiscard]] constexpr auto arg(Float f) noexcept -> complex<Float>
{
    return etl::arg(etl::complex<Float>(f));
}
 
/// \ingroup complex
template <integral Integer>
[[nodiscard]] constexpr auto arg(Integer i) noexcept -> complex<double>
{
    return etl::arg(etl::complex<double>(i));
}
 
} // namespace etl
 
#endif // TETL_COMPLEX_ARG_HPP