Namensräume
Varianten
Aktionen

std::expm1, std::expm1f, std::expm1l

Von cppreference.com
< cpp‎ | numeric‎ | math
 
 
 
 
Definiert in der Header-Datei <cmath>
(1)
float          expm1 ( float num );

double        expm1 ( double num );

long double    expm1 ( long double num );
(bis C++23)
/* Gleitkommazahl-Typ */
                 expm1 ( /*floating-point-type*/ num );
(seit C++23)
(constexpr seit C++26)
float          expm1f( float num );
(2) (seit C++11)
(constexpr seit C++26)
long double    expm1l( long double num );
(3) (seit C++11)
(constexpr seit C++26)
SIMD-Überladung (seit C++26)
Definiert im Header <simd>
template< /*math-floating-point*/ V >

constexpr /*deduzierter-simd-t*/<V>

                 expm1 ( const V& v_num );
(S) (seit C++26)
Definiert in der Header-Datei <cmath>
template< class Integer >
double        expm1 ( Integer num );
(A) (constexpr seit C++26)
1-3) Berechnet e (Eulersche Zahl, 2.7182818...) hoch die gegebene Potenz num, minus 1.0. Diese Funktion ist genauer als der Ausdruck std::exp(num) - 1.0 wenn num nahe Null ist. Die Bibliothek stellt Überladungen von std::expm1 für alle cv-unqualifizierten Gleitkommatypen als Parametertyp bereit.(seit C++23)
S) Die SIMD-Überladung führt ein elementweises std::expm1 auf v_num durch.
(Siehe math-floating-point und deduced-simd-t für ihre Definitionen.)
(seit C++26)
A) Zusätzliche Überladungen werden für alle ganzzahligen Typen bereitgestellt, die als double behandelt werden.
(seit C++11)

Inhalt

[edit] Parameter

num - Gleitkomma- oder Ganzzahlwert

[edit] Rückgabewert

Wenn keine Fehler auftreten, wird enum
-1
zurückgegeben.

Wenn ein Bereichsfehler aufgrund von Überlauf auftritt, wird +HUGE_VAL, +HUGE_VALF oder +HUGE_VALL zurückgegeben.

Wenn ein Bereichsfehler aufgrund eines Unterlaufs auftritt, wird das korrekte Ergebnis (nach Rundung) zurückgegeben.

[edit] Fehlerbehandlung

Fehler werden wie in math_errhandling beschrieben gemeldet.

Wenn die Implementierung IEEE-Gleitkomma-Arithmetik (IEC 60559) unterstützt,

  • Wenn das Argument ±0 ist, wird es unverändert zurückgegeben.
  • Wenn das Argument -∞ ist, wird -1 zurückgegeben.
  • Wenn das Argument +∞ ist, wird +∞ zurückgegeben.
  • Wenn das Argument NaN ist, wird NaN zurückgegeben.

[edit] Hinweise

Die Funktionen std::expm1 und std::log1p sind nützlich für Finanzberechnungen, zum Beispiel bei der Berechnung kleiner täglicher Zinssätze: (1+x)n
-1
kann als std::expm1(n * std::log1p(x)) ausgedrückt werden. Diese Funktionen vereinfachen auch das Schreiben von genauen hyperbolischen Umkehrfunktionen.

Für einen IEEE-kompatiblen Typ double ist ein Überlauf garantiert, wenn 709.8 < num.

Die zusätzlichen Überladungen müssen nicht exakt wie in (A) angegeben bereitgestellt werden. Sie müssen nur ausreichend sein, um sicherzustellen, dass für ihr Argument num vom ganzzahligen Typ, std::expm1(num) denselben Effekt hat wie std::expm1(static_cast<double>(num)).

[edit] Beispiel

#include <cerrno>
#include <cfenv>
#include <cmath>
#include <cstring>
#include <iostream>
// #pragma STDC FENV_ACCESS ON
 
int main()
{
    std::cout << "expm1(1) = " << std::expm1(1) << '\n'
              << "Interest earned in 2 days on $100, compounded daily at 1%\n"
              << "    on a 30/360 calendar = "
              << 100 * std::expm1(2 * std::log1p(0.01 / 360)) << '\n'
              << "exp(1e-16)-1 = " << std::exp(1e-16) - 1
              << ", but expm1(1e-16) = " << std::expm1(1e-16) << '\n';
 
    // special values
    std::cout << "expm1(-0) = " << std::expm1(-0.0) << '\n'
              << "expm1(-Inf) = " << std::expm1(-INFINITY) << '\n';
 
    // error handling
    errno = 0;
    std::feclearexcept(FE_ALL_EXCEPT);
 
    std::cout << "expm1(710) = " << std::expm1(710) << '\n';
 
    if (errno == ERANGE)
        std::cout << "    errno == ERANGE: " << std::strerror(errno) << '\n';
    if (std::fetestexcept(FE_OVERFLOW))
        std::cout << "    FE_OVERFLOW raised\n";
}

Mögliche Ausgabe

expm1(1) = 1.71828
Interest earned in 2 days on $100, compounded daily at 1%
    on a 30/360 calendar = 0.00555563
exp(1e-16)-1 = 0, but expm1(1e-16) = 1e-16
expm1(-0) = -0
expm1(-Inf) = -1
expm1(710) = inf
    errno == ERANGE: Result too large
    FE_OVERFLOW raised

[edit] Siehe auch

(C++11)(C++11)
gibt e hoch der gegebenen Potenz zurück (ex)
(Funktion) [bearbeiten]
(C++11)(C++11)(C++11)
gibt 2 hoch der gegebenen Potenz zurück (2x)
(Funktion) [bearbeiten]
(C++11)(C++11)(C++11)
natürlicher Logarithmus (Basis e) von 1 plus der gegebenen Zahl (ln(1+x))
(Funktion) [bearbeiten]
C-Dokumentation für expm1