Namespaces
Variants
Views
Actions

std::nan, std::nanf, std::nanl

From cppreference.com
< cpp‎ | numeric‎ | math
 
 
 
Common mathematical functions
Functions
Basic operations
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
nannanfnanl
(C++11)(C++11)(C++11)
Exponential functions
(C++11)
(C++11)
(C++11)
(C++11)
Power functions
(C++11)
(C++11)
Trigonometric and hyperbolic functions
(C++11)
(C++11)
(C++11)
Error and gamma functions
(C++11)
(C++11)
(C++11)
(C++11)
Nearest integer floating point operations
(C++11)(C++11)(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
Floating point manipulation functions
(C++11)(C++11)
(C++11)
(C++11)
(C++11)(C++11)
(C++11)
Classification/Comparison
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
Macro constants
(C++11)(C++11)(C++11)(C++11)(C++11)
 
Defined in header <cmath>
float nanf( const char* arg );
(since C++11)
double nan( const char* arg );
(since C++11)
long double nanl( const char* arg );
(since C++11)

Converts the implementation-defined character string arg into the corresponding quiet NaN value, as if by calling std::strtod, std::strtof, or std::strtold, respectively, as follows:

The call std::nan("string") is equivalent to the call std::strtod("NAN(string)", (char**)nullptr);.

The call std::nan("") is equivalent to the call std::strtod("NAN()", (char**)nullptr);.

The call std::nan(nullptr) is equivalent to the call std::strtod("NAN", (char**)nullptr);.

Contents

[edit] Parameters

arg - narrow character string identifying the contents of a NaN

[edit] Return value

The quiet NaN value that corresponds to the identifying string arg or zero if the implementation does not support quiet NaNs.

[edit] Example

#include <iostream>
#include <cmath>
#include <cstdint>
#include <cstring>
 
int main()
{
    double f1 = std::nan("1");
    std::uint64_t f1n; std::memcpy(&f1n, &f1, sizeof f1);
    std::cout << "nan(\"1\") = " << f1 << " (" << std::hex << f1n << ")\n";
 
    double f2 = std::nan("2");
    std::uint64_t f2n; std::memcpy(&f2n, &f2, sizeof f2);
    std::cout << "nan(\"2\") = " << f2 << " (" << std::hex << f2n << ")\n";
}

Possible output:

nan("1") = nan (7ff0000000000001)
nan("2") = nan (7ff0000000000002)

[edit] See also

(C++11)
checks if the given number is NaN
(function) [edit]
(C++11)
evaluates to a quiet NaN of type float
(macro constant) [edit]
identifies floating-point types that can represent the special value "quiet not-a-number" (NaN)
(public static member constant of std::numeric_limits) [edit]
identifies floating-point types that can represent the special value "signaling not-a-number" (NaN)
(public static member constant of std::numeric_limits) [edit]
[static]
returns a quiet NaN value of the given floating-point type
(public static member function of std::numeric_limits) [edit]
returns a signaling NaN value of the given floating-point type
(public static member function of std::numeric_limits) [edit]
C documentation for nanf, nan, nanl