Skip to content

Search topics & cppreference

Search all study topics, concept maps, and 6,587 C++ and C reference pages.

std::holds_alternative

Checks if the variant v holds the alternative T. The call is ill-formed if T does not appear exactly once in Types...

NotebookLM
Defined in header <variant>
template< class T, class... Types >
constexpr bool holds_alternative( const std::variant<Types...>& v ) noexcept;
(since C++17)

Checks if the variant v holds the alternative T. The call is ill-formed if T does not appear exactly once in Types...

Parameters

v - variant to examine

Return value

true if the variant currently holds the alternative T, false otherwise.

Example

example.cpp
#include <cassert>
#include <string>
#include <variant>
 
int main()
{
    std::variant<int, std::string> v = "abc";
    assert(not std::holds_alternative<int>(v));
    assert(std::holds_alternative<std::string>(v));
}

See also

returns the zero-based index of the alternative held by the variant
(public member function)
reads the value of the variant given the index or the type (if the type is unique), throws on error
(function template)

Content from this page on cppreference.com, licensed under CC-BY-SA 3.0 and GFDL. Modified: restyled, site navigation removed, code windows added. Offline snapshot of 9 February 2025.