std::isinf
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 isinf( float num );
(since C++11) bool isinf( double num );
(until C++23)
constexpr bool isinf( /*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 isinf( Integer num );
(A)
(since C++11) bool isinf( Integer num );
(constexpr since C++23)
1) Determines if the given floating-point number num is a positive or negative infinity. 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::isinf 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 infinite, false otherwise.
S) A data-parallel mask object where the ith element equals true if v_num[i] is infinite or false otherwise for all i in the range
[0, v_num.size()).[edit] Notes
GCC and Clang support a -ffinite-math option (additionally implied by -ffast-math), which allows the respective compiler to assume the nonexistence of special IEEE-754 floating point values such as NaN, infinity, or negative zero. In other words, std::isinf is assumed to always return false under this option.
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::isinf(num) has the same effect as std::isinf(static_cast<double>(num)).
[edit] Example
Run this code
#include <cfloat> #include <cmath> #include <iostream> #include <limits> int main() { const double max = std::numeric_limits <double>::max(); const double inf = std::numeric_limits <double>::infinity(); std::cout << std::boolalpha << "isinf(NaN) = " << std::isinf(NAN ) << '\n' << "isinf(Inf) = " << std::isinf(INFINITY ) << '\n' << "isinf(max) = " << std::isinf(max) << '\n' << "isinf(inf) = " << std::isinf(inf) << '\n' << "isinf(0.0) = " << std::isinf(0.0) << '\n' << "isinf(exp(800)) = " << std::isinf(std::exp (800)) << '\n' << "isinf(DBL_MIN/2.0) = " << std::isinf(DBL_MIN / 2.0) << '\n'; }
Output:
isinf(NaN) = false isinf(Inf) = true isinf(max) = false isinf(inf) = true isinf(0.0) = false isinf(exp(800)) = true isinf(DBL_MIN/2.0) = false
[edit] See also
C documentation for isinf