std::extent

 

C++

Language

Standard Library Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms 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

 

Utilities library

Type support (basic types, RTTI, type traits)
Dynamic memory management
Error handling
Program utilities
Variadic functions
Library feature-test macros
Date and time
Function objects
initializer_list (C++11)
bitset
hash (C++11)
integer_sequence (C++14)
Relational operators (deprecated in C++20)
rel_ops::operator!=rel_ops::operator>rel_ops::operator<=rel_ops::operator>=
Comparisons (C++20)
strong_order weak_order partial_order strong_equal weak_equal	strong_ordering weak_ordering partial_ordering strong_equality weak_equality	is_eqis_neqis_ltis_lteqis_gtis_gteq
common_comparison_category
Common vocabulary types
pair tuple (C++11) apply (C++17) make_from_tuple (C++17)	optional (C++17) any (C++17) variant (C++17)
Swap, forward and move
swap
exchange (C++14)
forward (C++11)
move (C++11)
move_if_noexcept (C++11)
Elementary string conversions
to_chars (C++17)
from_chars (C++17)
chars_format (C++17)
Type operations
declval (C++11)
as_const (C++17)
launder (C++17)

 

Type support

Basic types
Fundamental types
Fixed width integer types (C++11)
ptrdiff_t size_t max_align_t (C++11) byte (C++17)	nullptr_t (C++11) offsetof NULL
Numeric limits
numeric_limits
C numeric limits interface
Runtime type information
type_info type_index (C++11)	bad_typeid bad_cast
Type traits
Type categories
is_void (C++11) is_null_pointer (C++14) is_array (C++11) is_pointer (C++11) is_enum (C++11) is_union (C++11) is_class (C++11) is_function (C++11)	is_object (C++11) is_scalar (C++11) is_compound (C++11) is_integral (C++11) is_floating_point (C++11) is_fundamental (C++11) is_arithmetic (C++11)
is_reference (C++11)
is_lvalue_reference (C++11)
is_rvalue_reference (C++11)
is_member_pointer (C++11)
is_member_object_pointer (C++11)
is_member_function_pointer (C++11)

Type properties
is_const (C++11) is_volatile (C++11) is_empty (C++11) is_polymorphic (C++11) is_final (C++14) is_abstract (C++11) is_aggregate (C++17) is_trivial (C++11)	is_trivially_copyable (C++11) is_standard_layout (C++11) is_literal_type (C++11)(until C++20) is_pod (C++11)(deprecated in C++20) is_signed (C++11) is_unsigned (C++11) is_bounded_array (C++20) is_unbounded_array (C++20)
has_unique_object_representations (C++17)
Type trait constants
integral_constantbool_constanttrue_typefalse_type (C++11)(C++17)(C++11)(C++11)
Metafunctions
conjunction (C++17)
disjunction (C++17)
negation (C++17)
Endian
endian (C++20)
Constant evaluation context
is_constant_evaluated (C++20)

Supported operations
is_constructibleis_trivially_constructibleis_nothrow_constructible (C++11)(C++11)(C++11)
is_default_constructibleis_trivially_default_constructibleis_nothrow_default_constructible (C++11)(C++11)(C++11)
is_copy_constructibleis_trivially_copy_constructibleis_nothrow_copy_constructible (C++11)(C++11)(C++11)
is_move_constructibleis_trivially_move_constructibleis_nothrow_move_constructible (C++11)(C++11)(C++11)
is_assignableis_trivially_assignableis_nothrow_assignable (C++11)(C++11)(C++11)
is_copy_assignableis_trivially_copy_assignableis_nothrow_copy_assignable (C++11)(C++11)(C++11)
is_move_assignableis_trivially_move_assignableis_nothrow_move_assignable (C++11)(C++11)(C++11)
is_destructibleis_trivially_destructibleis_nothrow_destructible (C++11)(C++11)(C++11)
has_virtual_destructor (C++11)
is_swappable_withis_swappableis_nothrow_swappable_withis_nothrow_swappable (C++17)(C++17)(C++17)(C++17)
Relationships and property queries
is_same (C++11) is_base_of (C++11) is_convertibleis_nothrow_convertible (C++11)(C++20)	alignment_of (C++11) rank (C++11) extent (C++11)
is_invocableis_invocable_ris_nothrow_invocableis_nothrow_invocable_r (C++17)(C++17)(C++17)(C++17)
Type modifications
remove_cvremove_constremove_volatile (C++11)(C++11)(C++11) add_cvadd_constadd_volatile (C++11)(C++11)(C++11) make_signed (C++11) make_unsigned (C++11)	remove_reference (C++11) add_lvalue_referenceadd_rvalue_reference (C++11)(C++11) remove_pointer (C++11) add_pointer (C++11) remove_extent (C++11) remove_all_extents (C++11)
Type transformations
aligned_storage (C++11) aligned_union (C++11) decay (C++11) remove_cvref (C++20) enable_if (C++11) void_t (C++17)	conditional (C++11) common_type (C++11) common_reference (C++20) underlying_type (C++11) result_ofinvoke_result (C++11)(until C++20)(C++17) type_identity (C++20)

 

Defined in header <type_traits>
template< class T, unsigned N = 0> struct extent;		(since C++11)

If T is an array type, provides the member constant value equal to the number of elements along the Nth dimension of the array, if N is in [0, std::rank<T>::value). For any other type, or if T is array of unknown bound along its first dimension and N is 0, value is 0.

Helper variable template

template< class T, unsigned N = 0 > inline constexpr std::size_t extent_v = extent<T, N>::value;		(since C++17)

Inherited from std::integral_constant

Member constants

value [static]

the number of elements along the Nth dimension of T (public static member constant)

Member functions

operator std::size_t	converts the object to std::size_t, returns value (public member function)
operator() (C++14)	returns value (public member function)

Member types

Type	Definition
value_type	std::size_t
type	std::integral_constant<std::size_t, value>

Possible implementation

template<class T, unsigned N = 0> struct extent : std::integral_constant<std::size_t, 0> {};   template<class T> struct extent<T[], 0> : std::integral_constant<std::size_t, 0> {};   template<class T, unsigned N> struct extent<T[], N> : std::extent<T, N-1> {};   template<class T, std::size_t I> struct extent<T[I], 0> : std::integral_constant<std::size_t, I> {};   template<class T, std::size_t I, unsigned N> struct extent<T[I], N> : std::extent<T, N-1> {};

Example

Run this code

#include <iostream>
#include <type_traits>
 
int main()
{
    std::cout << std::extent<int[3]>::value << '\n'; //< default dimension is 0
    std::cout << std::extent<int[3][4], 0>::value << '\n';
    std::cout << std::extent<int[3][4], 1>::value << '\n';
    std::cout << std::extent<int[3][4], 2>::value << '\n';
    std::cout << std::extent<int[]>::value << '\n';
 
    const auto ext = std::extent<int[9]>{};
    std::cout << ext << '\n'; //< implicit conversion to std::size_t
 
    const int ints[] = {1,2,3,4};
    std::cout << std::extent<decltype(ints)>::value << '\n'; //< array size 
}

Output:

3
3
4
0
0
9
4

See also

is_array (C++11)	checks if a type is an array type (class template)
rank (C++11)	obtains the number of dimensions of an array type (class template)
remove_extent (C++11)	removes one extent from the given array type (class template)
remove_all_extents (C++11)	removes all extents from the given array type (class template)