arene::base::const_inline_map_reference< Key, Value, Compare > Class Template Reference

A const reference class to an inline_map object, with size-erased type. More...

Inheritance diagram for arene::base::const_inline_map_reference< Key, Value, Compare >:

Public Types
using	compare_type = Compare
	compare type of the map
using	const_iterator = iterator
	const iterator type of the underlying map
using	const_ops_type = inline_map_reference_detail::const_operations<map_base_type>
	alias to const operations type
using	const_reverse_iterator = ::arene::base::reverse_iterator<const_iterator>
	The type of an iterator that provides const access to the elements and iterates in reverse through the elements.
using	iterator = inline_map_reference_iterator<map_base_type, true>
	iterator type of a const reference to the map
using	key_type = Key
	key type of the map
using	map_base_type = inline_map_detail::inline_map_base<Key, Value, Compare>
	alias to the capacity-erased map base class
using	mapped_type = Value
	mapped type of the map
using	reverse_iterator = ::arene::base::reverse_iterator<iterator>
	The type of an iterator that provides non- const access to the elements and iterates in reverse through the elements.
using	size_type = typename map_base_type::size_type
	size type of the map
using	value_type = std::pair<Key const, Value>
	value type of the map

Public Member Functions
template<std::size_t Capacity>
	const_inline_map_reference (inline_map< Key, Value, Capacity, Compare > const &&)=delete
	construct a const_inline_map_reference of a map
template<std::size_t Capacity, bool AreExceptionsEnabled = detail::are_exceptions_enabled::value, constraints< std::enable_if_t< AreExceptionsEnabled > > = nullptr>
	const_inline_map_reference (inline_map< Key, Value, Capacity, Compare > const &map) noexcept
	construct a const_inline_map_reference of a map
template<std::size_t Capacity, bool AreExceptionsEnabled = detail::are_exceptions_enabled::value, constraints< std::enable_if_t<!AreExceptionsEnabled > > = nullptr>
	const_inline_map_reference (inline_map< Key, Value, Capacity, Compare > const &map) noexcept
	construct a const_inline_map_reference of a map
	const_inline_map_reference (inline_map_reference< Key, Value, Compare > other) noexcept
	construct a const_inline_map_reference from an inline_map_reference
auto	const_ops_ptr () const noexcept -> const_ops_type const *
	obtain a pointer to the const operations
auto	map_ptr () const noexcept -> map_base_type const *
	obtain a pointer to the map base

Detailed Description

template<class Key, class Value, class Compare>
class arene::base::const_inline_map_reference< Key, Value, Compare >

A const reference class to an inline_map object, with size-erased type.

Template Parameters

Key	The key type for the map
Value	The mapped type for the map
Compare	The comparison function

Precondition

The comparison must provide a strict ordering over the values of Key

Member Typedef Documentation

compare_type

template<class Key, class Value, class Compare>

using arene::base::const_inline_map_reference< Key, Value, Compare >::compare_type = Compare

compare type of the map

const_iterator

template<class Key, class Value, class Compare>

using arene::base::const_inline_map_reference< Key, Value, Compare >::const_iterator = iterator

const iterator type of the underlying map

const_ops_type

template<class Key, class Value, class Compare>

using arene::base::const_inline_map_reference< Key, Value, Compare >::const_ops_type = inline_map_reference_detail::const_operations<map_base_type>

alias to const operations type

const_reverse_iterator

template<class Key, class Value, class Compare>

using arene::base::const_inline_map_reference< Key, Value, Compare >::const_reverse_iterator = ::arene::base::reverse_iterator<const_iterator>

The type of an iterator that provides const access to the elements and iterates in reverse through the elements.

iterator

template<class Key, class Value, class Compare>

using arene::base::const_inline_map_reference< Key, Value, Compare >::iterator = inline_map_reference_iterator<map_base_type, true>

iterator type of a const reference to the map

key_type

template<class Key, class Value, class Compare>

using arene::base::const_inline_map_reference< Key, Value, Compare >::key_type = Key

key type of the map

map_base_type

template<class Key, class Value, class Compare>

using arene::base::const_inline_map_reference< Key, Value, Compare >::map_base_type = inline_map_detail::inline_map_base<Key, Value, Compare>

alias to the capacity-erased map base class

mapped_type

template<class Key, class Value, class Compare>

using arene::base::const_inline_map_reference< Key, Value, Compare >::mapped_type = Value

mapped type of the map

reverse_iterator

template<class Key, class Value, class Compare>

using arene::base::const_inline_map_reference< Key, Value, Compare >::reverse_iterator = ::arene::base::reverse_iterator<iterator>

The type of an iterator that provides non- const access to the elements and iterates in reverse through the elements.

size_type

template<class Key, class Value, class Compare>

using arene::base::const_inline_map_reference< Key, Value, Compare >::size_type = typename map_base_type::size_type

size type of the map

value_type

template<class Key, class Value, class Compare>

using arene::base::const_inline_map_reference< Key, Value, Compare >::value_type = std::pair<Key const, Value>

value type of the map

Constructor & Destructor Documentation

const_inline_map_reference() [1/4]

template<class Key, class Value, class Compare>

template<std::size_t Capacity, bool AreExceptionsEnabled = detail::are_exceptions_enabled::value, constraints< std::enable_if_t< AreExceptionsEnabled > > = nullptr>

arene::base::const_inline_map_reference< Key, Value, Compare >::const_inline_map_reference ( inline_map< Key, Value, Capacity, Compare > const & map )

inlineexplicitnoexcept

construct a const_inline_map_reference of a map

Template Parameters

Capacity

capacity of the inline_map

Parameters

map	inline_map to reference

const_inline_map_reference() [2/4]

template<class Key, class Value, class Compare>

template<std::size_t Capacity, bool AreExceptionsEnabled = detail::are_exceptions_enabled::value, constraints< std::enable_if_t<!AreExceptionsEnabled > > = nullptr>

arene::base::const_inline_map_reference< Key, Value, Compare >::const_inline_map_reference ( inline_map< Key, Value, Capacity, Compare > const & map )

inlineexplicitnoexcept

construct a const_inline_map_reference of a map

Template Parameters

Capacity

capacity of the inline_map

Parameters

map	inline_map to reference

const_inline_map_reference() [3/4]

template<class Key, class Value, class Compare>

template<std::size_t Capacity>

arene::base::const_inline_map_reference< Key, Value, Compare >::const_inline_map_reference ( inline_map< Key, Value, Capacity, Compare > const && )

explicitdelete

construct a const_inline_map_reference of a map

Template Parameters

Capacity

capacity of the inline_map

Deleted overload for rvalue references.

const_inline_map_reference() [4/4]

template<class Key, class Value, class Compare>

arene::base::const_inline_map_reference< Key, Value, Compare >::const_inline_map_reference ( inline_map_reference< Key, Value, Compare > other )

inlineexplicitnoexcept

construct a const_inline_map_reference from an inline_map_reference

Parameters

other

inline_map_reference value

Member Function Documentation

const_ops_ptr()

template<class Key, class Value, class Compare>

auto arene::base::const_inline_map_reference< Key, Value, Compare >::const_ops_ptr ( ) const -> const_ops_type const*

inlinenoexcept

obtain a pointer to the const operations

Returns

pointer to the const operations

map_ptr()

template<class Key, class Value, class Compare>

auto arene::base::const_inline_map_reference< Key, Value, Compare >::map_ptr ( ) const -> map_base_type const*

inlinenoexcept

obtain a pointer to the map base

Returns

pointer to the map base

---

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

• arene/base/inline_container/map_reference.hpp