utx::sqrt

utx::sqrt

utx::sqrt

utx::sqrt calculates the square root of a real value. The parameter passed to utx::sqrt can be any real type (utx::real_meric), but the returned result is always floating type. If the parameter is negative, it returns NaN value (utx::nan_v result).

Calling Sig :

constexpr auto result = utx::sqrt(value);

constexpr auto result = utx::sqrt.fn<return_type>(value);

utx::sqrt(value) :

It always returns a float value.
The returned float type is one of utx::f32, utx::f64, utx::f128, utx::fmax, utx::fx32, utx::fx64, utx::fx128, utx::fxmax.
If value is negative, it returns utx::nan_v<return_float_type> .
If you want to check if the return value is nan, you'd better use utx::is_nan(value), as the return_float_type is uncertainty.
constexpr support.

utx::sqrt.fn<return_type>(value) :

The result will be converted to return_type .

Header

#include <utxcpp/math.hpp>

c++ example

#include <utxcpp/core.hpp>
#include <utxcpp/math.hpp>

int main()
{
	constexpr auto a = utx::sqrt(3);
	constexpr auto b = utx::sqrt(3.4);
	constexpr auto c = utx::sqrt(utx::ix32{2});
	constexpr auto d = utx::sqrt(utx::fx32{2.8});
	constexpr auto e = utx::sqrt(-7);

	utx::print(a,b,c,d,e);
/*output:
1.732051 1.843909 1.414214 1.673320 nan
*/

	static_assert(utx::is_nan(e));
}

See Also