FE_DOWNWARD, FE_TONEAREST, FE_TOWARDZERO, FE_UPWARD

C++

Language

Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

Numerics library

Common mathematical functions

Special mathematical functions

Floating-point environment (C++11)

Complex numbers

Numeric arrays

Pseudo-random number generation

Compile-time rational arithmetic (C++11)

Numeric algorithms

gcd (C++17)

lcm (C++17)

Generic numeric operations

iota (C++11)

accumulate

inner_product

adjacent_difference

partial_sum

reduce (C++17)

transform_reduce (C++17)

inclusive_scan (C++17)

exclusive_scan (C++17)

transform_inclusive_scan (C++17)

transform_exclusive_scan (C++17)

Bit operations

bit_cast (C++20)

ispow2 (C++20)

ceil2 (C++20)

floor2 (C++20)

log2p1 (C++20)

Floating-point environment

Functions

feclearexcept (C++11)

fetestexcept (C++11)

feraiseexcept (C++11)

fegetexceptflagfesetexceptflag (C++11)(C++11)

fegetroundfesetround (C++11)(C++11)

fegetenvfesetenv (C++11)

feholdexcept (C++11)

feupdateenv (C++11)

Macro constants

FE_ALL_EXCEPTFE_DIVBYZEROFE_INEXACTFE_INVALIDFE_OVERFLOWFE_UNDERFLOW (C++11)

FE_DOWNWARDFE_TONEARESTFE_TOWARDZEROFE_UPWARD (C++11)

FE_DFL_ENV (C++11)

Defined in header <cfenv>
#define FE_DOWNWARD /*implementation defined*/		(since C++11)
#define FE_TONEAREST /*implementation defined*/		(since C++11)
#define FE_TOWARDZERO /*implementation defined*/		(since C++11)
#define FE_UPWARD /*implementation defined*/		(since C++11)

Each of these macro constants expands to a nonnegative integer constant expression, which can be used with std::fesetround and std::fegetround to indicate one of the supported floating-point rounding modes. The implementation may define additional rounding mode constants in <cfenv>, which should all begin with FE_ followed by at least one uppercase letter. Each macro is only defined if it is supported.

On most implementations, these macro constants expand to the values equal to the values of FLT_ROUNDS and std::float_round_style

Constant	Explanation
FE_DOWNWARD	rounding towards negative infinity
FE_TONEAREST	rounding towards nearest representable value
FE_TOWARDZERO	rounding towards zero
FE_UPWARD	rounding towards positive infinity

Additional rounding modes may be supported by an implementation.

The current rounding mode affects the following:

• results of floating-point arithmetic operators outside of constant expressions

double x = 1;
x/10; // 0.09999999999999999167332731531132594682276248931884765625
   // or 0.1000000000000000055511151231257827021181583404541015625

• results of standard library mathematical functions

std::sqrt(2); // 1.41421356237309492343001693370752036571502685546875
           // or 1.4142135623730951454746218587388284504413604736328125

• floating-point to floating-point implicit conversion and casts

double d = 1 + std::numeric_limits<double>::epsilon();
float f = d; //  1.00000000000000000000000
           // or 1.00000011920928955078125

• string conversions such as std::strtod or std::printf

std::stof("0.1"); // 0.0999999940395355224609375
               // or 0.100000001490116119384765625

• the library rounding functions std::nearbyint, std::rint, std::lrint

std::lrint(2.1); // 2 or 3

The current rounding mode does NOT affect the following:

• floating-point to integer implicit conversion and casts (always towards zero)
• results of floating-point arithmetic operators in expressions executed at compile time (always to nearest)
• the library functions std::round, std::lround, std::llround, std::ceil, std::floor, std::trunc

As with any floating-point environment functionality, rounding is only guaranteed if #pragma STDC FENV_ACCESS ON is set.

Example

Run this code

#include <iostream>
#include <iomanip>
#include <string>
#include <cfenv>
#include <cmath>
int main()
{
#pragma STDC FENV_ACCESS ON
    std::fesetround(FE_DOWNWARD);
    std::cout << "rounding down: \n" << std::setprecision(50)
              << "         pi = " << std::acos(-1.f) << '\n'
              << "stof(\"1.1\") = " << std::stof("1.1") << '\n'
              << "  rint(2.1) = " << std::rint(2.3) << "\n\n";
    std::fesetround(FE_UPWARD);
    std::cout << "rounding up: \n"
              << "         pi = " << std::acos(-1.f) << '\n'
              << "stof(\"1.1\") = " << std::stof("1.1") << '\n'
              << "  rint(2.1) = " << std::rint(2.3) << '\n';
}

Output:

rounding down: 
         pi = 3.141592502593994140625
stof("1.1") = 1.099999904632568359375
  rint(2.1) = 2

rounding up: 
         pi = 3.1415927410125732421875
stof("1.1") = 1.10000002384185791015625
  rint(2.1) = 3

See also

float_round_style	indicates floating-point rounding modes (enum)
fegetroundfesetround (C++11)(C++11)	gets or sets rounding direction (function)