WPILibC++ 2024.3.2
Public Types | Public Member Functions | List of all members
ordered_map< Key, T, IgnoredLess, Allocator > Struct Template Reference

a minimal map-like container that preserves insertion order More...

#include </home/runner/work/allwpilib/allwpilib/wpiutil/src/main/native/thirdparty/json/include/wpi/ordered_map.h>

Inheritance diagram for ordered_map< Key, T, IgnoredLess, Allocator >:

Public Types

using key_type = Key
 
using mapped_type = T
 
using Container = std::vector< std::pair< const Key, T >, Allocator >
 
using iterator = typename Container::iterator
 
using const_iterator = typename Container::const_iterator
 
using size_type = typename Container::size_type
 
using value_type = typename Container::value_type
 
using key_compare = std::equal_to< Key >
 
template<typename InputIt >
using require_input_iter = typename std::enable_if< std::is_convertible< typename std::iterator_traits< InputIt >::iterator_category, std::input_iterator_tag >::value >::type
 

Public Member Functions

 ordered_map () noexcept(noexcept(Container()))
 
 ordered_map (const Allocator &alloc) noexcept(noexcept(Container(alloc)))
 
template<class It >
 ordered_map (It first, It last, const Allocator &alloc=Allocator())
 
 ordered_map (std::initializer_list< value_type > init, const Allocator &alloc=Allocator())
 
std::pair< iterator, bool > emplace (const key_type &key, T &&t)
 
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
std::pair< iterator, bool > emplace (KeyType &&key, T &&t)
 
T & operator[] (const key_type &key)
 
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
T & operator[] (KeyType &&key)
 
const T & operator[] (const key_type &key) const
 
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
const T & operator[] (KeyType &&key) const
 
T & at (const key_type &key)
 
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
T & at (KeyType &&key)
 
const T & at (const key_type &key) const
 
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
const T & at (KeyType &&key) const
 
size_type erase (const key_type &key)
 
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
size_type erase (KeyType &&key)
 
iterator erase (iterator pos)
 
iterator erase (iterator first, iterator last)
 
size_type count (const key_type &key) const
 
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
size_type count (KeyType &&key) const
 
iterator find (const key_type &key)
 
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
iterator find (KeyType &&key)
 
const_iterator find (const key_type &key) const
 
std::pair< iterator, bool > insert (value_type &&value)
 
std::pair< iterator, bool > insert (const value_type &value)
 
template<typename InputIt , typename = require_input_iter<InputIt>>
void insert (InputIt first, InputIt last)
 

Detailed Description

template<class Key, class T, class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
struct ordered_map< Key, T, IgnoredLess, Allocator >

a minimal map-like container that preserves insertion order

ordered_map: a minimal map-like container that preserves insertion order for use within wpi::basic_json<ordered_map>

See also
https://json.nlohmann.me/api/ordered_map/

Member Typedef Documentation

◆ const_iterator

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
using ordered_map< Key, T, IgnoredLess, Allocator >::const_iterator = typename Container::const_iterator

◆ Container

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
using ordered_map< Key, T, IgnoredLess, Allocator >::Container = std::vector<std::pair<const Key, T>, Allocator>

◆ iterator

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
using ordered_map< Key, T, IgnoredLess, Allocator >::iterator = typename Container::iterator

◆ key_compare

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
using ordered_map< Key, T, IgnoredLess, Allocator >::key_compare = std::equal_to<Key>

◆ key_type

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
using ordered_map< Key, T, IgnoredLess, Allocator >::key_type = Key

◆ mapped_type

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
using ordered_map< Key, T, IgnoredLess, Allocator >::mapped_type = T

◆ require_input_iter

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
template<typename InputIt >
using ordered_map< Key, T, IgnoredLess, Allocator >::require_input_iter = typename std::enable_if<std::is_convertible<typename std::iterator_traits<InputIt>::iterator_category, std::input_iterator_tag>::value>::type

◆ size_type

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
using ordered_map< Key, T, IgnoredLess, Allocator >::size_type = typename Container::size_type

◆ value_type

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
using ordered_map< Key, T, IgnoredLess, Allocator >::value_type = typename Container::value_type

Constructor & Destructor Documentation

◆ ordered_map() [1/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
ordered_map< Key, T, IgnoredLess, Allocator >::ordered_map ( )
inlinenoexcept

◆ ordered_map() [2/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
ordered_map< Key, T, IgnoredLess, Allocator >::ordered_map ( const Allocator &  alloc)
inlineexplicitnoexcept

◆ ordered_map() [3/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
template<class It >
ordered_map< Key, T, IgnoredLess, Allocator >::ordered_map ( It  first,
It  last,
const Allocator &  alloc = Allocator() 
)
inline

◆ ordered_map() [4/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
ordered_map< Key, T, IgnoredLess, Allocator >::ordered_map ( std::initializer_list< value_type >  init,
const Allocator &  alloc = Allocator() 
)
inline

Member Function Documentation

◆ at() [1/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
T & ordered_map< Key, T, IgnoredLess, Allocator >::at ( const key_type &  key)
inline

◆ at() [2/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
const T & ordered_map< Key, T, IgnoredLess, Allocator >::at ( const key_type &  key) const
inline

◆ at() [3/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
T & ordered_map< Key, T, IgnoredLess, Allocator >::at ( KeyType &&  key)
inline

◆ at() [4/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
const T & ordered_map< Key, T, IgnoredLess, Allocator >::at ( KeyType &&  key) const
inline

◆ count() [1/2]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
size_type ordered_map< Key, T, IgnoredLess, Allocator >::count ( const key_type &  key) const
inline

◆ count() [2/2]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
size_type ordered_map< Key, T, IgnoredLess, Allocator >::count ( KeyType &&  key) const
inline

◆ emplace() [1/2]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
std::pair< iterator, bool > ordered_map< Key, T, IgnoredLess, Allocator >::emplace ( const key_type &  key,
T &&  t 
)
inline

◆ emplace() [2/2]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
std::pair< iterator, bool > ordered_map< Key, T, IgnoredLess, Allocator >::emplace ( KeyType &&  key,
T &&  t 
)
inline

◆ erase() [1/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
size_type ordered_map< Key, T, IgnoredLess, Allocator >::erase ( const key_type &  key)
inline

◆ erase() [2/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
iterator ordered_map< Key, T, IgnoredLess, Allocator >::erase ( iterator  first,
iterator  last 
)
inline

◆ erase() [3/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
iterator ordered_map< Key, T, IgnoredLess, Allocator >::erase ( iterator  pos)
inline

◆ erase() [4/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
size_type ordered_map< Key, T, IgnoredLess, Allocator >::erase ( KeyType &&  key)
inline

◆ find() [1/3]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
iterator ordered_map< Key, T, IgnoredLess, Allocator >::find ( const key_type &  key)
inline

◆ find() [2/3]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
const_iterator ordered_map< Key, T, IgnoredLess, Allocator >::find ( const key_type &  key) const
inline

◆ find() [3/3]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
iterator ordered_map< Key, T, IgnoredLess, Allocator >::find ( KeyType &&  key)
inline

◆ insert() [1/3]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
std::pair< iterator, bool > ordered_map< Key, T, IgnoredLess, Allocator >::insert ( const value_type &  value)
inline

◆ insert() [2/3]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
template<typename InputIt , typename = require_input_iter<InputIt>>
void ordered_map< Key, T, IgnoredLess, Allocator >::insert ( InputIt  first,
InputIt  last 
)
inline

◆ insert() [3/3]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
std::pair< iterator, bool > ordered_map< Key, T, IgnoredLess, Allocator >::insert ( value_type &&  value)
inline

◆ operator[]() [1/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
T & ordered_map< Key, T, IgnoredLess, Allocator >::operator[] ( const key_type &  key)
inline

◆ operator[]() [2/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
const T & ordered_map< Key, T, IgnoredLess, Allocator >::operator[] ( const key_type &  key) const
inline

◆ operator[]() [3/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
T & ordered_map< Key, T, IgnoredLess, Allocator >::operator[] ( KeyType &&  key)
inline

◆ operator[]() [4/4]

template<class Key , class T , class IgnoredLess = std::less<Key>, class Allocator = std::allocator<std::pair<const Key, T>>>
template<class KeyType , detail::enable_if_t< detail::is_usable_as_key_type< key_compare, key_type, KeyType >::value, int > = 0>
const T & ordered_map< Key, T, IgnoredLess, Allocator >::operator[] ( KeyType &&  key) const
inline
The documentation for this struct was generated from the following files: