std::ilogb, std::ilogbf, std::ilogbl
| Definiert in der Header-Datei <cmath> |
||
| (1) | ||
int ilogb ( float num ); int ilogb ( double num ); |
(seit C++11) (bis C++23) |
|
| constexpr int ilogb( /* Gleitkommazahl-Typ */ num ); |
(seit C++23) | |
| int ilogbf( float num ); |
(2) | (seit C++11) (constexpr seit C++23) |
| int ilogbl( long double num ); |
(3) | (seit C++11) (constexpr seit C++23) |
| #define FP_ILOGB0 /* Implementierungsabhängig */ |
(4) | (seit C++11) |
| #define FP_ILOGBNAN /* Implementierungsabhängig */ |
(5) | (seit C++11) |
| Definiert in der Header-Datei <cmath> |
||
| template< class Integer > int ilogb ( Integer num ); |
(A) | (seit C++11) (constexpr seit C++23) |
std::ilogb für alle cv-unqualifizierten Gleitkommazahl-Typen als Parametertyp num bereit.(seit C++23)Formal ist der vorzeichenlose Exponent der ganzzahlige Teil von logr|num| als vorzeichenbehafteter ganzzahliger Wert, für von Null verschiedene num, wobei r std::numeric_limits<T>::radix ist und T der Gleitkommazahltyp von num ist.
Inhalt |
[edit] Parameter
| num | - | Gleitkomma- oder Ganzzahlwert |
[edit] Rückgabewert
Wenn keine Fehler auftreten, wird der vorzeichenlose Exponent von num als vorzeichenbehafteter int-Wert zurückgegeben.
Wenn num Null ist, wird FP_ILOGB0 zurückgegeben.
Wenn num unendlich ist, wird INT_MAX zurückgegeben.
Wenn num eine NaN ist, wird FP_ILOGBNAN zurückgegeben.
Wenn das korrekte Ergebnis größer als INT_MAX oder kleiner als INT_MIN ist, ist der Rückgabewert undefiniert.
[edit] Fehlerbehandlung
Fehler werden wie in math_errhandling beschrieben gemeldet.
Ein Domänenfehler oder Bereichsfehler kann auftreten, wenn num Null, unendlich oder NaN ist.
Wenn das korrekte Ergebnis größer als INT_MAX oder kleiner als INT_MIN ist, kann ein Domänenfehler oder ein Bereichsfehler auftreten.
Wenn die Implementierung IEEE-Gleitkomma-Arithmetik (IEC 60559) unterstützt,
- Wenn das korrekte Ergebnis größer als INT_MAX oder kleiner als INT_MIN ist, wird FE_INVALID ausgelöst.
- Wenn num ±0, ±∞ oder NaN ist, wird FE_INVALID ausgelöst.
- In allen anderen Fällen ist das Ergebnis exakt (FE_INEXACT wird niemals ausgelöst) und der aktuelle Rundungsmodus wird ignoriert.
[edit] Hinweise
Wenn num nicht Null, unendlich oder NaN ist, ist der zurückgegebene Wert exakt äquivalent zu static_cast<int>(std::logb(num)).
POSIX verlangt, dass ein Domänenfehler auftritt, wenn num Null, unendlich, NaN ist oder wenn das korrekte Ergebnis außerhalb des Bereichs von int liegt.
POSIX verlangt außerdem, dass auf XSI-konformen Systemen der zurückgegebene Wert, wenn das korrekte Ergebnis größer als INT_MAX ist, INT_MAX ist und der zurückgegebene Wert, wenn das korrekte Ergebnis kleiner als INT_MIN ist, INT_MIN ist.
Das korrekte Ergebnis kann auf allen bekannten Implementierungen als int dargestellt werden. Damit ein Überlauf auftritt, muss INT_MAX kleiner sein als LDBL_MAX_EXP * std::log2(FLT_RADIX) oder INT_MIN größer sein als LDBL_MIN_EXP - LDBL_MANT_DIG) * std::log2(FLT_RADIX).
Der von std::ilogb zurückgegebene Exponentenwert ist immer um 1 kleiner als der von std::frexp zurückgegebene Exponent, aufgrund der unterschiedlichen Normalisierungsanforderungen: für den von std::ilogb zurückgegebenen Exponenten e gilt |num*r-e
| zwischen 1 und r (typischerweise zwischen 1 und 2), aber für den von std::frexp zurückgegebenen Exponenten e gilt |num*2-e
| zwischen 0.5 und 1.
Die zusätzlichen Überladungen müssen nicht exakt als (A) bereitgestellt werden. Sie müssen nur ausreichen, um sicherzustellen, dass für ihr Argument num vom Ganzzahltyp, std::ilogb(num) denselben Effekt hat wie std::ilogb(static_cast<double>(num)).
[edit] Beispiel
Vergleicht verschiedene Gleitkomma-Zerlegungsfunktionen
#include <cfenv> #include <cmath> #include <iostream> #include <limits> // #pragma STDC FENV_ACCESS ON int main() { double f = 123.45; std::cout << "Given the number " << f << " or " << std::hexfloat << f << std::defaultfloat << " in hex,\n"; double f3; double f2 = std::modf(f, &f3); std::cout << "modf() makes " << f3 << " + " << f2 << '\n'; int i; f2 = std::frexp(f, &i); std::cout << "frexp() makes " << f2 << " * 2^" << i << '\n'; i = std::ilogb(f); std::cout << "logb()/ilogb() make " << f / std::scalbn(1.0, i) << " * " << std::numeric_limits<double>::radix << "^" << std::ilogb(f) << '\n'; // error handling std::feclearexcept(FE_ALL_EXCEPT); std::cout << "ilogb(0) = " << std::ilogb(0) << '\n'; if (std::fetestexcept(FE_INVALID)) std::cout << " FE_INVALID raised\n"; }
Mögliche Ausgabe
Given the number 123.45 or 0x1.edccccccccccdp+6 in hex,
modf() makes 123 + 0.45
frexp() makes 0.964453 * 2^7
logb()/ilogb() make 1.92891 * 2^6
ilogb(0) = -2147483648
FE_INVALID raised[edit] Siehe auch
| (C++11)(C++11) |
zerlegt eine Zahl in Signifikand und Basis-2-Exponent (Funktion) |
| (C++11)(C++11)(C++11) |
extrahiert den Exponenten der Zahl (Funktion) |
| (C++11)(C++11)(C++11)(C++11)(C++11)(C++11) |
multipliziert eine Zahl mit FLT_RADIX hoch einer Potenz (Funktion) |
| C-Dokumentation für ilogb
| |
