std::signbit
From cppreference.com
C++
Feature test macros (C++20)
Concepts library (C++20)
Metaprogramming library (C++11)
Ranges library (C++20)
Filesystem library (C++17)
Concurrency support library (C++11)
Execution control library (C++26)
Numerics library
Mathematical special functions (C++17)
Mathematical constants (C++20)
Basic linear algebra algorithms (C++26)
Data-parallel types (SIMD) (C++26)
Floating-point environment (C++11)
Bit manipulation (C++20)
Saturation arithmetic (C++26)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
(C++17)
Common mathematical functions
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)(C++11)
(C++11)
(C++11)
Defined in header
<cmath>
(1)
bool signbit( float num );
(since C++11) bool signbit( double num );
(until C++23)
constexpr bool signbit( /*floating-point-type*/ num );
(since C++23)
SIMD overload (since C++26)
Defined in header
<simd>
template< /*math-floating-point*/ V >
(S)
(since C++26)
constexpr typename /*deduced-simd-t*/<V>::mask_type
Defined in header
<cmath>
template< class Integer >
bool signbit( Integer num );
(A)
(since C++11) bool signbit( Integer num );
(constexpr since C++23)
1) Determines if the given floating point number num is negative. The library provides overloads for all cv-unqualified floating-point types as the type of the parameter num.(since C++23)
S) The SIMD overload performs an element-wise
std::signbit on v_num.- (See math-floating-point and deduced-simd-t for their definitions.)
A) Additional overloads are provided for all integer types, which are treated as double.
Contents
[edit] Parameters
num
-
floating-point or integer value
v_num
-
a data-parallel object of std::basic_simd specialization where its element type is a floating-point type
[edit] Return value
1) true if num is negative, false otherwise.
S) A data-parallel mask object where the ith element equals true if v_num[i] is negative or false otherwise for all i in the range
[0, v_num.size()).[edit] Notes
This function detects the sign bit of zeroes, infinities, and NaNs. Along with std::copysign , std::signbit is one of the only two portable ways to examine the sign of a NaN.
The additional overloads are not required to be provided exactly as (A). They only need to be sufficient to ensure that for their argument num of integer type, std::signbit(num) has the same effect as std::signbit(static_cast<double>(num)).
[edit] Example
Run this code
#include <cmath> #include <iostream> int main() { std::cout << std::boolalpha << "signbit(+0.0) = " << std::signbit(+0.0) << '\n' << "signbit(-0.0) = " << std::signbit(-0.0) << '\n' << "signbit(+nan) = " << std::signbit(+NAN ) << '\n' << "signbit(-nan) = " << std::signbit(-NAN ) << '\n' << "signbit(+inf) = " << std::signbit(+INFINITY ) << '\n' << "signbit(-inf) = " << std::signbit(-INFINITY ) << '\n'; }
Output:
signbit(+0.0) = false signbit(-0.0) = true signbit(+nan) = false signbit(-nan) = true signbit(+inf) = false signbit(-inf) = true
[edit] See also
C documentation for signbit