Public Types | Public Member Functions | Public Attributes | Friends | List of all members
magic_enum::containers::array< E, V, Index > Struct Template Reference

#include <magic_enum_containers.hpp>

Public Types

using const_iterator = typename container_type::const_iterator
 
using const_pointer = typename container_type::const_pointer
 
using const_reference = typename container_type::const_reference
 
using const_reverse_iterator = typename container_type::const_reverse_iterator
 
using container_type = std::array< V, enum_count< E >()>
 
using difference_type = typename container_type::difference_type
 
using index_type = Index
 
using iterator = typename container_type::iterator
 
using pointer = typename container_type::pointer
 
using reference = typename container_type::reference
 
using reverse_iterator = typename container_type::reverse_iterator
 
using size_type = typename container_type::size_type
 
using value_type = typename container_type::value_type
 

Public Member Functions

constexpr reference at (E pos)
 
constexpr const_reference at (E pos) const
 
constexpr const_reference back () const noexcept
 
constexpr reference back () noexcept
 
constexpr const_iterator begin () const noexcept
 
constexpr iterator begin () noexcept
 
constexpr const_iterator cbegin () const noexcept
 
constexpr const_iterator cend () const noexcept
 
constexpr const_iterator crbegin () const noexcept
 
constexpr const_iterator crend () const noexcept
 
constexpr const_pointer data () const noexcept
 
constexpr pointer data () noexcept
 
constexpr bool empty () const noexcept
 
constexpr const_iterator end () const noexcept
 
constexpr iterator end () noexcept
 
constexpr void fill (const V &value)
 
constexpr const_reference front () const noexcept
 
constexpr reference front () noexcept
 
constexpr size_type max_size () const noexcept
 
constexpr reference operator[] (E pos)
 
constexpr const_reference operator[] (E pos) const
 
constexpr const_iterator rbegin () const noexcept
 
constexpr iterator rbegin () noexcept
 
constexpr const_iterator rend () const noexcept
 
constexpr iterator rend () noexcept
 
constexpr size_type size () const noexcept
 
constexpr void swap (array &other) noexcept(std::is_nothrow_swappable_v< V >)
 

Public Attributes

container_type a
 

Friends

constexpr friend bool operator!= (const array &a1, const array &a2)
 
constexpr friend bool operator< (const array &a1, const array &a2)
 
constexpr friend bool operator<= (const array &a1, const array &a2)
 
constexpr friend bool operator== (const array &a1, const array &a2)
 
constexpr friend bool operator> (const array &a1, const array &a2)
 
constexpr friend bool operator>= (const array &a1, const array &a2)
 

Detailed Description

template<typename E, typename V, typename Index = default_indexing<E>>
struct magic_enum::containers::array< E, V, Index >

Definition at line 335 of file magic_enum_containers.hpp.

Member Typedef Documentation

◆ const_iterator

template<typename E , typename V , typename Index = default_indexing<E>>
using magic_enum::containers::array< E, V, Index >::const_iterator = typename container_type::const_iterator

Definition at line 351 of file magic_enum_containers.hpp.

◆ const_pointer

template<typename E , typename V , typename Index = default_indexing<E>>
using magic_enum::containers::array< E, V, Index >::const_pointer = typename container_type::const_pointer

Definition at line 349 of file magic_enum_containers.hpp.

◆ const_reference

template<typename E , typename V , typename Index = default_indexing<E>>
using magic_enum::containers::array< E, V, Index >::const_reference = typename container_type::const_reference

Definition at line 347 of file magic_enum_containers.hpp.

◆ const_reverse_iterator

template<typename E , typename V , typename Index = default_indexing<E>>
using magic_enum::containers::array< E, V, Index >::const_reverse_iterator = typename container_type::const_reverse_iterator

Definition at line 353 of file magic_enum_containers.hpp.

◆ container_type

template<typename E , typename V , typename Index = default_indexing<E>>
using magic_enum::containers::array< E, V, Index >::container_type = std::array<V, enum_count<E>()>

Definition at line 341 of file magic_enum_containers.hpp.

◆ difference_type

template<typename E , typename V , typename Index = default_indexing<E>>
using magic_enum::containers::array< E, V, Index >::difference_type = typename container_type::difference_type

Definition at line 345 of file magic_enum_containers.hpp.

◆ index_type

template<typename E , typename V , typename Index = default_indexing<E>>
using magic_enum::containers::array< E, V, Index >::index_type = Index

Definition at line 340 of file magic_enum_containers.hpp.

◆ iterator

template<typename E , typename V , typename Index = default_indexing<E>>
using magic_enum::containers::array< E, V, Index >::iterator = typename container_type::iterator

Definition at line 350 of file magic_enum_containers.hpp.

◆ pointer

template<typename E , typename V , typename Index = default_indexing<E>>
using magic_enum::containers::array< E, V, Index >::pointer = typename container_type::pointer

Definition at line 348 of file magic_enum_containers.hpp.

◆ reference

template<typename E , typename V , typename Index = default_indexing<E>>
using magic_enum::containers::array< E, V, Index >::reference = typename container_type::reference

Definition at line 346 of file magic_enum_containers.hpp.

◆ reverse_iterator

template<typename E , typename V , typename Index = default_indexing<E>>
using magic_enum::containers::array< E, V, Index >::reverse_iterator = typename container_type::reverse_iterator

Definition at line 352 of file magic_enum_containers.hpp.

◆ size_type

template<typename E , typename V , typename Index = default_indexing<E>>
using magic_enum::containers::array< E, V, Index >::size_type = typename container_type::size_type

Definition at line 344 of file magic_enum_containers.hpp.

◆ value_type

template<typename E , typename V , typename Index = default_indexing<E>>
using magic_enum::containers::array< E, V, Index >::value_type = typename container_type::value_type

Definition at line 343 of file magic_enum_containers.hpp.

Member Function Documentation

◆ at() [1/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr reference magic_enum::containers::array< E, V, Index >::at ( pos)
inlineconstexpr

Definition at line 355 of file magic_enum_containers.hpp.

◆ at() [2/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr const_reference magic_enum::containers::array< E, V, Index >::at ( pos) const
inlineconstexpr

Definition at line 362 of file magic_enum_containers.hpp.

◆ back() [1/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr const_reference magic_enum::containers::array< E, V, Index >::back ( ) const
inlineconstexprnoexcept

Definition at line 385 of file magic_enum_containers.hpp.

◆ back() [2/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr reference magic_enum::containers::array< E, V, Index >::back ( )
inlineconstexprnoexcept

Definition at line 383 of file magic_enum_containers.hpp.

◆ begin() [1/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr const_iterator magic_enum::containers::array< E, V, Index >::begin ( ) const
inlineconstexprnoexcept

Definition at line 393 of file magic_enum_containers.hpp.

◆ begin() [2/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr iterator magic_enum::containers::array< E, V, Index >::begin ( )
inlineconstexprnoexcept

Definition at line 391 of file magic_enum_containers.hpp.

◆ cbegin()

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr const_iterator magic_enum::containers::array< E, V, Index >::cbegin ( ) const
inlineconstexprnoexcept

Definition at line 395 of file magic_enum_containers.hpp.

◆ cend()

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr const_iterator magic_enum::containers::array< E, V, Index >::cend ( ) const
inlineconstexprnoexcept

Definition at line 401 of file magic_enum_containers.hpp.

◆ crbegin()

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr const_iterator magic_enum::containers::array< E, V, Index >::crbegin ( ) const
inlineconstexprnoexcept

Definition at line 407 of file magic_enum_containers.hpp.

◆ crend()

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr const_iterator magic_enum::containers::array< E, V, Index >::crend ( ) const
inlineconstexprnoexcept

Definition at line 413 of file magic_enum_containers.hpp.

◆ data() [1/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr const_pointer magic_enum::containers::array< E, V, Index >::data ( ) const
inlineconstexprnoexcept

Definition at line 389 of file magic_enum_containers.hpp.

◆ data() [2/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr pointer magic_enum::containers::array< E, V, Index >::data ( )
inlineconstexprnoexcept

Definition at line 387 of file magic_enum_containers.hpp.

◆ empty()

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr bool magic_enum::containers::array< E, V, Index >::empty ( ) const
inlineconstexprnoexcept

Definition at line 415 of file magic_enum_containers.hpp.

◆ end() [1/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr const_iterator magic_enum::containers::array< E, V, Index >::end ( ) const
inlineconstexprnoexcept

Definition at line 399 of file magic_enum_containers.hpp.

◆ end() [2/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr iterator magic_enum::containers::array< E, V, Index >::end ( )
inlineconstexprnoexcept

Definition at line 397 of file magic_enum_containers.hpp.

◆ fill()

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr void magic_enum::containers::array< E, V, Index >::fill ( const V &  value)
inlineconstexpr

Definition at line 421 of file magic_enum_containers.hpp.

◆ front() [1/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr const_reference magic_enum::containers::array< E, V, Index >::front ( ) const
inlineconstexprnoexcept

Definition at line 381 of file magic_enum_containers.hpp.

◆ front() [2/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr reference magic_enum::containers::array< E, V, Index >::front ( )
inlineconstexprnoexcept

Definition at line 379 of file magic_enum_containers.hpp.

◆ max_size()

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr size_type magic_enum::containers::array< E, V, Index >::max_size ( ) const
inlineconstexprnoexcept

Definition at line 419 of file magic_enum_containers.hpp.

◆ operator[]() [1/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr reference magic_enum::containers::array< E, V, Index >::operator[] ( pos)
inlineconstexpr

Definition at line 369 of file magic_enum_containers.hpp.

◆ operator[]() [2/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr const_reference magic_enum::containers::array< E, V, Index >::operator[] ( pos) const
inlineconstexpr

Definition at line 374 of file magic_enum_containers.hpp.

◆ rbegin() [1/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr const_iterator magic_enum::containers::array< E, V, Index >::rbegin ( ) const
inlineconstexprnoexcept

Definition at line 405 of file magic_enum_containers.hpp.

◆ rbegin() [2/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr iterator magic_enum::containers::array< E, V, Index >::rbegin ( )
inlineconstexprnoexcept

Definition at line 403 of file magic_enum_containers.hpp.

◆ rend() [1/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr const_iterator magic_enum::containers::array< E, V, Index >::rend ( ) const
inlineconstexprnoexcept

Definition at line 411 of file magic_enum_containers.hpp.

◆ rend() [2/2]

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr iterator magic_enum::containers::array< E, V, Index >::rend ( )
inlineconstexprnoexcept

Definition at line 409 of file magic_enum_containers.hpp.

◆ size()

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr size_type magic_enum::containers::array< E, V, Index >::size ( ) const
inlineconstexprnoexcept

Definition at line 417 of file magic_enum_containers.hpp.

◆ swap()

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr void magic_enum::containers::array< E, V, Index >::swap ( array< E, V, Index > &  other)
inlineconstexprnoexcept

Definition at line 427 of file magic_enum_containers.hpp.

Friends And Related Function Documentation

◆ operator!=

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr friend bool operator!= ( const array< E, V, Index > &  a1,
const array< E, V, Index > &  a2 
)
friend

Definition at line 437 of file magic_enum_containers.hpp.

◆ operator<

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr friend bool operator< ( const array< E, V, Index > &  a1,
const array< E, V, Index > &  a2 
)
friend

Definition at line 439 of file magic_enum_containers.hpp.

◆ operator<=

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr friend bool operator<= ( const array< E, V, Index > &  a1,
const array< E, V, Index > &  a2 
)
friend

Definition at line 441 of file magic_enum_containers.hpp.

◆ operator==

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr friend bool operator== ( const array< E, V, Index > &  a1,
const array< E, V, Index > &  a2 
)
friend

Definition at line 435 of file magic_enum_containers.hpp.

◆ operator>

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr friend bool operator> ( const array< E, V, Index > &  a1,
const array< E, V, Index > &  a2 
)
friend

Definition at line 443 of file magic_enum_containers.hpp.

◆ operator>=

template<typename E , typename V , typename Index = default_indexing<E>>
constexpr friend bool operator>= ( const array< E, V, Index > &  a1,
const array< E, V, Index > &  a2 
)
friend

Definition at line 445 of file magic_enum_containers.hpp.

Member Data Documentation

◆ a

template<typename E , typename V , typename Index = default_indexing<E>>
container_type magic_enum::containers::array< E, V, Index >::a

Definition at line 447 of file magic_enum_containers.hpp.


The documentation for this struct was generated from the following file:


magic_enum
Author(s):
autogenerated on Fri Feb 21 2025 03:20:19