Namensräume
Varianten
Aktionen

std::enable_if

Von cppreference.com
< cpp‎ | types
 
 
Metaprogrammierungsbibliothek
Typmerkmale
Typkategorien
(C++11)
(C++11)(DR*)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11) 
(C++11)
(C++11)
Typeneigenschaften
(C++11)
(C++11)
(C++14)
(C++11)(deprecated in C++26)
(C++11)(bis C++20*)
(C++11)(veraltet in C++20)
(C++11)
Typmerkmalskonstanten
Metafunktionen
(C++17)
Unterstützte Operationen
Beziehungen und Eigenschaftsabfragen
Typmodifikationen
(C++11)(C++11)(C++11)
Typentransformationen
(C++11)(veraltet in C++23)
(C++11)(veraltet in C++23)
(C++11)
(C++11)(bis C++20*)(C++17)

(C++11)
enable_if
(C++11)
(C++17)
Rationale Arithmetik zur Compilezeit
Ganzzahlsequenzen zur Compilezeit
 
Definiert in der Kopfdatei <type_traits>
template< bool B, class T = void >
struct enable_if;
(seit C++11)

Wenn B true ist, hat std::enable_if einen öffentlichen Member-Typalias type, der gleich T ist; andernfalls gibt es keinen Member-Typalias.

Diese Metafunktion ist eine bequeme Möglichkeit, SFINAE vor C++20's Concepts zu nutzen, insbesondere um Funktionen bedingt aus dem Kandidaten-Set basierend auf Typ-Traits zu entfernen, was separate Funktionsüberladungen oder Spezialisierungen basierend auf diesen unterschiedlichen Typ-Traits ermöglicht.

std::enable_if kann in vielen Formen verwendet werden, einschließlich

  • als zusätzlicher Funktionsparameter (nicht anwendbar auf die meisten Operatorüberladungen),
  • als Rückgabetyp (nicht anwendbar auf Konstruktoren und Destruktoren),
  • als Klassen-Template- oder Funktions-Template-Parameter.

Wenn das Programm Spezialisierungen für std::enable_if hinzufügt, ist das Verhalten undefiniert.

Inhalt

[bearbeiten] Member-Typen

Typ Definition
type entweder T oder kein solches Mitglied, abhängig vom Wert von B

[bearbeiten] Hilfstypen

template< bool B, class T = void >
using enable_if_t = typename enable_if<B,T>::type;
(seit C++14)

[bearbeiten] Mögliche Implementierung

template<bool B, class T = void>
struct enable_if {};
 
template<class T>
struct enable_if<true, T> { typedef T type; };

[bearbeiten] Hinweise

Ein häufiger Fehler ist es, zwei Funktions-Templates zu deklarieren, die sich nur in ihren Standard-Template-Argumenten unterscheiden. Dies funktioniert nicht, da die Deklarationen als Neuerklärungen desselben Funktions-Templates behandelt werden (Standard-Template-Argumente werden bei der Äquivalenz von Funktions-Templates nicht berücksichtigt).

/* WRONG */
 
struct T
{
    enum { int_t, float_t } type;
 
    template<typename Integer,
             typename = std::enable_if_t<std::is_integral<Integer>::value>>
    T(Integer) : type(int_t) {}
 
    template<typename Floating,
             typename = std::enable_if_t<std::is_floating_point<Floating>::value>>
    T(Floating) : type(float_t) {} // error: treated as redefinition
};
 
/* RIGHT */
 
struct T
{
    enum { int_t, float_t } type;
 
    template<typename Integer,
             std::enable_if_t<std::is_integral<Integer>::value, bool> = true>
    T(Integer) : type(int_t) {}
 
    template<typename Floating,
             std::enable_if_t<std::is_floating_point<Floating>::value, bool> = true>
    T(Floating) : type(float_t) {} // OK
};

Es ist Vorsicht geboten, wenn enable_if im Typ eines nicht-Typ-Template-Parameters eines Funktions-Templates auf Namespace-Ebene verwendet wird. Einige ABI-Spezifikationen wie die Itanium ABI beinhalten nicht die instantiierungsabhängigen Teile von nicht-Typ-Template-Parametern im Mangling, was bedeutet, dass Spezialisierungen zweier unterschiedlicher Funktions-Templates denselben mangled-Namen haben und fälschlicherweise miteinander verknüpft werden könnten. Zum Beispiel

// first translation unit
 
struct X
{
    enum { value1 = true, value2 = true };
};
 
template<class T, std::enable_if_t<T::value1, int> = 0>
void func() {} // #1
 
template void func<X>(); // #2
 
// second translation unit
 
struct X
{
    enum { value1 = true, value2 = true };
};
 
template<class T, std::enable_if_t<T::value2, int> = 0>
void func() {} // #3
 
template void func<X>(); // #4

Die Funktions-Templates #1 und #3 haben unterschiedliche Signaturen und sind unterschiedliche Templates. Dennoch haben #2 und #4, obwohl sie Instanziierungen unterschiedlicher Funktions-Templates sind, denselben mangled-Namen in der Itanium C++ ABI (_Z4funcI1XLi0EEvv), was bedeutet, dass der Linker sie fälschlicherweise als dieselbe Entität betrachten wird.

[bearbeiten] Beispiel

#include <iostream>
#include <new>
#include <string>
#include <type_traits>
 
namespace detail
{ 
    void* voidify(const volatile void* ptr) noexcept { return const_cast<void*>(ptr); } 
}
 
// #1, enabled via the return type
template<class T>
typename std::enable_if<std::is_trivially_default_constructible<T>::value>::type 
    construct(T*) 
{
    std::cout << "default constructing trivially default constructible T\n";
}
 
// same as above
template<class T>
typename std::enable_if<!std::is_trivially_default_constructible<T>::value>::type 
    construct(T* p) 
{
    std::cout << "default constructing non-trivially default constructible T\n";
    ::new(detail::voidify(p)) T;
}
 
// #2
template<class T, class... Args>
std::enable_if_t<std::is_constructible<T, Args&&...>::value> // Using helper type
    construct(T* p, Args&&... args) 
{
    std::cout << "constructing T with operation\n";
    ::new(detail::voidify(p)) T(static_cast<Args&&>(args)...);
}
 
// #3, enabled via a parameter
template<class T>
void destroy(
    T*, 
    typename std::enable_if<
        std::is_trivially_destructible<T>::value
    >::type* = 0)
{
    std::cout << "destroying trivially destructible T\n";
}
 
// #4, enabled via a non-type template parameter
template<class T,
         typename std::enable_if<
             !std::is_trivially_destructible<T>{} &&
             (std::is_class<T>{} || std::is_union<T>{}),
             bool>::type = true>
void destroy(T* t)
{
    std::cout << "destroying non-trivially destructible T\n";
    t->~T();
}
 
// #5, enabled via a type template parameter
template<class T,
	 typename = std::enable_if_t<std::is_array<T>::value>>
void destroy(T* t) // note: function signature is unmodified
{
    for (std::size_t i = 0; i < std::extent<T>::value; ++i)
        destroy((*t)[i]);
}
 
/*
template<class T,
	 typename = std::enable_if_t<std::is_void<T>::value>>
void destroy(T* t) {} // error: has the same signature with #5
*/
 
// the partial specialization of A is enabled via a template parameter
template<class T, class Enable = void>
class A {}; // primary template
 
template<class T>
class A<T, typename std::enable_if<std::is_floating_point<T>::value>::type>
{}; // specialization for floating point types
 
int main()
{
    union { int i; char s[sizeof(std::string)]; } u;
 
    construct(reinterpret_cast<int*>(&u));
    destroy(reinterpret_cast<int*>(&u));
 
    construct(reinterpret_cast<std::string*>(&u), "Hello");
    destroy(reinterpret_cast<std::string*>(&u));
 
    A<int>{}; // OK: matches the primary template
    A<double>{}; // OK: matches the partial specialization
}

Ausgabe

default constructing trivially default constructible T
destroying trivially destructible T
constructing T with operation
destroying non-trivially destructible T

[bearbeiten] Siehe auch

(C++17)
void variadische Alias-Vorlage
(Alias-Vorlage)[bearbeiten]