Boost.MultiIndex Documentation - Hashed indices reference

Boost , , Boost.MultiIndex Documentation - Reference

Boost.MultiIndex Hashed indices reference

Ranked indices

Boost.MultiIndex reference

Sequenced indices

Contents

• Заголовок"boost/multi_index/hashed_index_fwd.hpp"синопсис
• Заголовок"boost/multi_index/hashed_index.hpp"Синопсис
  • Указатели индексовhashed_uniqueиhashed_non_unique
  • Штриховые индексы
    • Сложная подпись
    • Типы обоснований
    • Вложенные типы
    • Конструкторы, копия и назначение
    • Итераторы
    • Модификаторы
    • Наблюдатели
    • Поиск
    • Интерфейс ведра
    • Хаш-политика
    • Сравнение
    • Сериализация

Header "boost/multi_index/hashed_index_fwd.hpp" synopsis

namespace boost{
namespace multi_index{
// index specifiers hashed_unique and hashed_non_unique
template<consult hashed_unique reference for arguments>
struct hashed_unique;
template<consult hashed_non_unique reference for arguments>
struct hashed_non_unique;
// indices
namespace detail{
template<implementation defined> class index name is implementation defined;
} // namespace boost::multi_index::detail
} // namespace boost::multi_index 
} // namespace boost

<hashed_index_fwd.hpp>представляет форвардные декларации для указателей индексов<hashed_unique>и<hashed_non_unique>и связанные с нимихешированные индексыклассов.

Header "boost/multi_index/hashed_index.hpp" synopsis

#include <initializer_list>
namespace boost{
namespace multi_index{
// index specifiers hashed_unique and hashed_non_unique
template<consult hashed_unique reference for arguments>
struct hashed_unique;
template<consult hashed_non_unique reference for arguments>
struct hashed_non_unique;
// indices
namespace detail{
template<implementation defined> class index class name implementation defined;
// index comparison:
// OP is any of ==,!=
template<implementation defined>
bool operator OP(const index class name& x,const index class name& y);
// index specialized algorithms:
template<implementation defined>
void swap(index class name& x,index class name& y);
} // namespace boost::multi_index::detail
} // namespace boost::multi_index 
} // namespace boost

Index specifiers hashed_unique and hashed_non_unique

Этиуказатели индексовпозволяют вставлятьхешированные индексыбез и с учетом дублирующих элементов, соответственно. Синтаксис<hashed_unique>и<hashed_non_unique>совпадают, поэтому мы описываем их сгруппированным образом.<hashed_unique>и<hashed_non_unique>могут быть представлены в двух различных формах, в зависимости от того, предоставляется ли список тегов для индекса:

template<
  typename KeyFromValue,
  typename Hash=boost::hash<KeyFromValue::result_type>,
  typename Pred=std::equal_to<KeyFromValue::result_type>
>
struct (hashed_unique | hashed_non_unique);
template<
  typename TagList,
  typename KeyFromValue,
  typename Hash=boost::hash<KeyFromValue::result_type>,
  typename Pred=std::equal_to<KeyFromValue::result_type>
>
struct (hashed_unique | hashed_non_unique);

Если это так, то<TagList>должно быть преобразовано в<tag>. Аргументы шаблона используются соответствующей реализацией индекса, ссылаясь на раздел ссылкихешированных индексовдля дальнейших объяснений их приемлемых значений типа.

Hashed indices

Хешированный индекс обеспечивает быстрое извлечение элементов<multi_index_container>с помощью методов хеширования. Указатель хеширования конкретизируется в соответствии с данным<Key Extractor>, который извлекает ключи из элементов<multi_index_container>, объектом функции<Hash>, который возвращает хеш-значения для ключей и двоичным предикатом<Pred>, действующим как отношение эквивалентности на значениях<Key>.

Существует два варианта хешированных индексов:уникальный, которые не допускают дублирования элементов (по отношению к связанному с ним предикату равенства) инеуникальный, которые принимают эти дубликаты. Интерфейс этих двух вариантов одинаков, поэтому они документируются вместе с небольшими различиями, явно выраженными при их существовании.

За исключением случаев, когда отмечен или если соответствующий интерфейс не существует, хешированные индексы (как уникальные, так и неуникальные) удовлетворяют требованиям C++ для неупорядоченных ассоциативных контейнеров[unord.req](поддержка уникальных и эквивалентных ключей, соответственно). Действительность итераторов и отсылок к элементам сохраняется во всех случаях. Иногда предоставленные гарантии безопасности исключения на самом деле сильнее, чем требуется стандартом. Мы предоставляем только описания тех типов и операций, которые не соответствуют или не соответствуют стандартным требованиям.

namespace boost{
namespace multi_index{
namespace detail{
template<implementation defined: dependent on types Value, Allocator,
  TagList, KeyFromValue, Hash, Pred>
class name is implementation defined
{ 
public:
  // types:
  typedef typename KeyFromValue::result_type         key_type;
  typedef Value                                      value_type;
  typedef KeyFromValue                               key_from_value;
  typedef Hash                                       hasher;
  typedef Pred                                       key_equal;
  typedef boost::tuple<
    size_type,key_from_value,hasher,key_equal>       ctor_args;
  typedef TagList                                    tag_list;
  typedef Allocator                                  allocator_type;
  typedef typename Allocator::pointer                pointer;
  typedef typename Allocator::const_pointer          const_pointer;
  typedef typename Allocator::reference              reference;
  typedef typename Allocator::const_reference        const_reference;
  typedef implementation defined                     size_type;      
  typedef implementation defined                     difference_type;
  typedef implementation defined                     iterator;
  typedef implementation defined                     const_iterator;
  typedef implementation defined                     local_iterator;
  typedef implementation defined                     const_local_iterator;
  // construct/destroy/copy:
  index class name& operator=(const index class name& x);
  index class name& operator=(std::initializer_list<value_type> list);
  allocator_type get_allocator()const noexcept;
  // size and capacity:
  bool      empty()const noexcept;
  size_type size()const noexcept;
  size_type max_size()const noexcept;
  // iterators:
  iterator       begin()noexcept;
  const_iterator begin()const noexcept;
  iterator       end()noexcept;
  const_iterator end()const noexcept;
  const_iterator cbegin()const;
  const_iterator cend()const;
 
  iterator       iterator_to(const value_type& x);
  const_iterator iterator_to(const value_type& x)const;
  // modifiers:
  template<typename... Args>
  std::pair<iterator,bool> emplace(Args&&... args);
  template<typename... Args>
  iterator emplace_hint(iterator position,Args&&... args);
  std::pair<iterator,bool> insert(const value_type& x);
  std::pair<iterator,bool> insert(value_type&& x);
  iterator insert(iterator position,const value_type& x);
  iterator insert(iterator position,value_type&& x);
  template<typename InputIterator>
  void insert(InputIterator first,InputIterator last);
  void insert(std::initializer_list<value_type> list);
  iterator  erase(iterator position);
  size_type erase(const key_type& x);
  iterator  erase(iterator first,iterator last);
  bool replace(iterator position,const value_type& x);
  bool replace(iterator position,value_type&& x);
  template<typename Modifier> bool modify(iterator position,Modifier mod);
  template<typename Modifier,typename Rollback>
  bool modify(iterator position,Modifier mod,Rollback back);
  template<typename Modifier> bool modify_key(iterator position,Modifier mod);
  template<typename Modifier,typename Rollback>
  bool modify_key(iterator position,Modifier mod,Rollback back);
  
  void clear()noexcept;
  void swap(index class name& x);
  // observers:
  key_from_value key_extractor()const;
  hasher         hash_function()const;
  key_equal      key_eq()const;
  // lookup:
  template<typename CompatibleKey>
  iterator find(const CompatibleKey& x)const;
  template<
    typename CompatibleKey,typename CompatibleHash, typename CompatiblePred
  >
  iterator find(
    const CompatibleKey& x,
    const CompatibleHash& hash,const CompatiblePred& eq)const; 
  template<typename CompatibleKey>
  size_type count(const CompatibleKey& x)const;
  template<
    typename CompatibleKey,typename CompatibleHash, typename CompatiblePred
  >
  size_type count(
    const CompatibleKey& x,
    const CompatibleHash& hash,const CompatiblePred& eq)const;
  template<typename CompatibleKey>
  std::pair<iterator,iterator> equal_range(const CompatibleKey& x)const;
  template<
    typename CompatibleKey,typename CompatibleHash, typename CompatiblePred
  >
  std::pair<iterator,iterator> equal_range(
    const CompatibleKey& x,
    const CompatibleHash& hash,const CompatiblePred& eq)const;
  // bucket interface:
  size_type bucket_count()const noexcept;
  size_type max_bucket_count()const noexcept;
  size_type bucket_size(size_type n)const;
  size_type bucket(const key_type& k)const;
  local_iterator       begin(size_type n);
  const_local_iterator begin(size_type n)const;
  local_iterator       end(size_type n);
  const_local_iterator end(size_type n)const;
  const_local_iterator cbegin(size_type n)const;
  const_local_iterator cend(size_type n)const;
  local_iterator       local_iterator_to(const value_type& x);
  const_local_iterator local_iterator_to(const value_type& x)const;
  // hash policy:
  float load_factor()const noexcept;
  float max_load_factor()const noexcept;
  void  max_load_factor(float z);
  void  rehash(size_type n);
  void  reserve(size_type n);
};
// index comparison:
template<implementation defined>
bool operator==(const index class name& x,const index class name& y);
template<implementation defined>
bool operator!=(const index class name& x,const index class name& y)
{
  return !(x==y);
}
// index specialized algorithms:
template<implementation defined>
void swap(index class name& x,index class name& y);
} // namespace boost::multi_index::detail
} // namespace boost::multi_index 
} // namespace boost

Complexity signature

Здесь и в описаниях операций хешированных индексов мы принимаем схему, изложенную в разделеподписи сложности. Подпись сложности хешированных индексов:

• Приступ:< [40] >
• < [42] >[< [42] >] [< [43] >] [< [43] >] [< [42] >]] [[< [43] >]]] [[[< [43] >]] [[[[]]]]] [[[[]]]]] [[[[[[]]]]]]] [[[[[[]]]]]] [[[[[]]]]]]] [[[[[[]]]]][[[[[[]]]]]][[[[[[]]]]]]][[[[[]]]]][[[[[[]]]]]]]][[[[[[]]]]][[[[[]]]]]][[[[[[]]]]]]][[[[[]]]]]][[[[[[]]]]]]]][[[[[[[]]]]]]][[[[[[]]]]]]][[[[[[[]]]]]]]
• < [46] >,< [47] >,< [47] >,< [46] >,< [47] >,< [47] >,< [47] >.
• < [50] >[[[[[]]]] [[[[[]]]]][[[[[]]]]][[[[[]]]]]][[[[[[]]]]]][[[[[[]]]]]][[[[[]]]]]][[[[[]]]]]][[[[[]]]]]][[[[[]]]]]][[[[[[]]]]]][[[[[]]]]]][[[[[[]]]]]]][[[[[]]]]]][[[[[[]]]]]][[[[[[]]]]]]][[[[[[[]]]]]]][[[[[[]]]]]][[[[[]]]]][[[[[]]]]]][[[[[]]]]][[[[[]]]]]][[[[[
• • ,< [52] >,< [52] >< [52] >,< [52] >,< [52] >,< [52] >
  • < [56] >< [56] >[< [57] >] [[< [57] >]] [[[[[[]]]]] [[[[[[[]]]]]]]] [[[[[[[[[]]]]]]][[[[[[]]]]]]]][[[[[[[[[[]]]]]]]][[[[[[[[]]]]]]]][[[[[[[[[]]]]]]]]]]]][[[[[[[[]]]]]]]]][[[[[[[[[]]]]]]]]][[[[[[[[[[]]]]]]]]][[[[[[[[]]]]]]]]]]][[[[[[[[[[]]]]]]]]]]]]][[[[[[[[[]]]]]]]]]][[[[[[[[[[[[
• < [60] >,< [61] >,< [61] >,< [61] >,< [60] >,< [61] >, [скрыто].

Instantiation types

Индексы хеширования инстанцируются внутри<multi_index_container>и определяются с помощью<indexed_by>суказателями индексов<hashed_unique>и<hashed_non_unique>. Обоснования зависят от следующих типов:

• < [77] >< [78] >,
• < [81] >< [82] >,
• < [85] >,< [85] >,< [86] >,< [86] >,< [86] >,< [86] >,< [86] >,< [86] >,< [86] >,< [86] >,< [86] >,< [86] >,< [86] >,< [86] >,< [86] >,< [86] >,< [86] >,< [86] >,< [86] >,< [86] >,
  ,
  ,
  ,
  .
  • < [89] >Щелчок,
  • < [91] >Северо-Западный,
  • < [93] >Щедрость Севера.
  <TagList>должно быть инстанциацией<tag>. Тип<KeyFromValue>, определяющий механизм извлечения ключа из<Value>, должен быть образцом<Key Extractor>из<Value>.<Hash>является<CopyConstructible>унарным функциональным объектом, принимающим один аргумент типа<KeyFromValue::result_type>и возвращающим значение типа<std::size_t>в диапазоне<[0, std::numeric_limits<std::size_t>::max())>.<Pred>является<CopyConstructible>двоичным предикатом, индуцирующим отношение эквивалентности на элементах<KeyFromValue::result_type>. Требуется, чтобы<Hash>объект возвращал то же значение для ключей, эквивалентное<Pred>.Valueизmulti_index_container,
  • Allocatorизmulti_index_container,
  • TagListиз указателя индекса (если предусмотрено, в противном случае предполагаетсяtag<>),
  • KeyFromValueиз указателя индекса,
  • Hashиз указателя индекса,
  • Predиз указателя индекса.
  TagList must be an instantiation of tag. The type KeyFromValue, which determines the mechanism for extracting a key from Value, must be a model of Key Extractor from Value. Hash is a CopyConstructibleunary function object taking a single argument of type KeyFromValue::result_type and returning a value of type std::size_t in the range [0, std::numeric_limits<std::size_t>::max()). Pred is a CopyConstructible binary predicate inducing an equivalence relation on elements of KeyFromValue::result_type. It is required that the Hash object return the same value for keys equivalent under Pred. [ORIG_END] -->

  Nested types

  ctor_args

  The first element of this tuple indicates the minimum number of buckets set up by the index on construction time. If the default value 0 is used, an implementation defined number is used instead.

  iterator
const_iterator
local_iterator
const_local_iterator

  These types are forward iterators.

  Constructors, copy and assignment

  Как поясняется в разделе 122 концепции индексов, индексы не имеют публичных конструкторов или деструкторов. Присвоение, с другой стороны, предусмотрено. При строительстве<max_load_factor()>составляет 1,0.

  index class name& operator=(const index class name& x);

  Effects:

  a=b;
  

  where a and b are the multi_index_container objects to which *this and x belong, respectively.
  Returns: *this.
  

  index class name& operator=(std::initializer_list<value_type> list);

  Effects:

  a=list;
  

  where a is the multi_index_container object to which *this belongs.
  Returns: *this.
  

  Iterators

  iterator       iterator_to(const value_type& x);
const_iterator iterator_to(const value_type& x)const;

  Requires: x is a reference to an element of the container.
  Returns: An iterator to x.
  Complexity: Constant.
  Exception safety: nothrow.
  

  Modifiers

  template<typename... Args>
std::pair<iterator,bool> emplace(Args&&... args);

  Requires: value_type is EmplaceConstructible into multi_index_container from args.
  Effects: Inserts a value_type object constructed with std::forward<Args>(args)... into the multi_index_container to which the index belongs if

  • индекс не является уникальным или не существует другого элемента с эквивалентным ключом;
  • И вставка допускается всеми другими индексамиmulti_index_container.

  Returns: The return value is a pair p. p.second is true if and only if insertion took place. On successful insertion, p.first points to the element inserted; otherwise, p.first points to an element that caused the insertion to be banned. Note that more than one element can be causing insertion not to be allowed.
  Complexity: O(I(n)).
  Exception safety: Strong, except that rehashing may occur even if the operation fails.
  

  template<typename... Args>
iterator emplace_hint(iterator position, Args&&... args);

  Requires: value_type is EmplaceConstructible into multi_index_container from args. position is a valid iterator of the index.
  Effects: Inserts a value_type object constructed with std::forward<Args>(args)... into the multi_index_container to which the index belongs if

  • индекс не является уникальным или не существует другого элемента с эквивалентным ключом;
  • И вставка допускается всеми другими индексамиmulti_index_container.

  position is used as a hint to improve the efficiency of the operation.
  Returns: On successful insertion, an iterator to the newly inserted element. Otherwise, an iterator to an element that caused the insertion to be banned. Note that more than one element can be causing insertion not to be allowed.
  Complexity: O(H(n)).
  Exception safety: Strong, except that rehashing may occur even if the operation fails.
  

  std::pair<iterator,bool> insert(const value_type& x);
std::pair<iterator,bool> insert(value_type&& x);

  Requires (first version): value_type is CopyInsertable into multi_index_container.
  Requires (second version): value_type is MoveInsertable into multi_index_container.
  Effects: Inserts x into the multi_index_container to which the index belongs if

  • индекс не является уникальным или не существует другого элемента с эквивалентным ключом;
  • И вставка допускается всеми другими индексамиmulti_index_container.

  Returns: The return value is a pair p. p.second is true if and only if insertion took place. On successful insertion, p.first points to the element inserted; otherwise, p.first points to an element that caused the insertion to be banned. Note that more than one element can be causing insertion not to be allowed.
  Complexity: O(I(n)).
  Exception safety: Strong, except that rehashing may occur even if the operation fails.
  

  iterator insert(iterator position,const value_type& x);
iterator insert(iterator position,value_type&& x);

  Requires (first version): value_type is CopyInsertable into multi_index_container. position is a valid iterator of the index.
  Requires (second version): value_type is MoveInsertable into multi_index_container. position is a valid iterator of the index.
  Effects: Inserts x into the multi_index_container to which the index belongs if

  • индекс не является уникальным или не существует другого элемента с эквивалентным ключом;
  • И вставка допускается всеми другими индексамиmulti_index_container.

  position is used as a hint to improve the efficiency of the operation.
  Returns: On successful insertion, an iterator to the newly inserted element. Otherwise, an iterator to an element that caused the insertion to be banned. Note that more than one element can be causing insertion not to be allowed.
  Complexity: O(H(n)).
  Exception safety: Strong, except that rehashing may occur even if the operation fails.
  

  template<typename InputIterator>
void insert(InputIterator first,InputIterator last);

  Requires: InputIterator is an input iterator. value_type is EmplaceConstructible into multi_index_container from *first. first and last are not iterators into any index of the multi_index_container to which this index belongs. last is reachable from first.
  Effects: For each element of [first, last), in this order, inserts it into the multi_index_container to which this index belongs if

  • индекс не является уникальным или не существует другого элемента с эквивалентным ключом;
  • И вставка допускается всеми другими индексамиmulti_index_container.

  Complexity: O(m*I(n+m)), where m is the number of elements in [first, last).
  Exception safety: Basic.
  

  void insert(std::initializer_list<value_type> list);

  Effects:

  insert(list.begin(),list.end());
  

  iterator erase(iterator position);

  Requires: position is a valid dereferenceable iterator of the index.
  Effects: Deletes the element pointed to by position.
  Returns: An iterator pointing to the element immediately following the one that was deleted, or end() if no such element exists.
  Complexity: O(D(n)).
  Exception safety: nothrow.
  

  size_type erase(const key_type& x);

  Effects: Deletes the elements with key equivalent to x.
  Returns: Number of elements deleted.
  Complexity: Average case, O(1 + m*D(n)), worst case O(ndist + m*D(n)), where m is the number of elements deleted.
  Exception safety: Basic.
  

  iterator erase(iterator first,iterator last);

  Requires: [first,last) is a valid range of the index.
  Effects: Deletes the elements in [first,last).
  Returns: last.
  Complexity: O(m*D(n)), where m is the number of elements in [first,last).
  Exception safety: nothrow.
  

  bool replace(iterator position,const value_type& x);
bool replace(iterator position,value_type&& x);

  Requires (first version): value_type is CopyAssignable. position is a valid dereferenceable iterator of the index.
  Requires (second version): value_type is MoveAssignable. position is a valid dereferenceable iterator of the index.
  Effects: Assigns the value x to the element pointed to by position into the multi_index_container to which the index belongs if, for the value x

  • индекс не является уникальным или не существует другого элемента (за исключением, возможно,*position) с эквивалентным ключом;
  • И замена допускается всеми другими индексамиmulti_index_container.

  Postconditions: Validity of position is preserved in all cases. If the key of the new value is equivalent to that of the replaced value, the position of the element does not change.
  Returns: true if the replacement took place, false otherwise.
  Complexity: O(R(n)).
  Exception safety: Strong. If an exception is thrown by some user-provided operation the multi_index_container to which the index belongs remains in its original state.

  template<typename Modifier> bool modify(iterator position,Modifier mod);

  Requires: mod is a unary function object accepting arguments of type value_type&. position is a valid dereferenceable iterator of the index. The execution of mod(e), where e is the element pointed to by position, does not invoke any operation of the multi_index_container after e is directly modified or, before modification, if the operation would invalidate position.
  Effects: Calls mod(e) where e is the element pointed to by position and rearranges *position into all the indices of the multi_index_container. Rearrangement is successful if

  • индекс не является уникальным или не существует другого элемента с эквивалентным ключом;
  • Перестройка допускается всеми другими индексамиmulti_index_container.

  If the rearrangement fails, the element is erased.
  Postconditions: Validity of position is preserved if the operation succeeds. If the key of the modified value is equivalent to that of the original value, the position of the element does not change.
  Returns: true if the operation succeeded, false otherwise.
  Complexity: O(M(n)).
  Exception safety: Basic. If an exception is thrown by some user-provided operation (except possibly mod), then the element pointed to by position is erased.

  template<typename Modifier,typename Rollback>
bool modify(iterator position,Modifier mod,Rollback back);

  Requires: mod and back are unary function objects accepting arguments of type value_type&. position is a valid dereferenceable iterator of the index. The execution of mod(e), where e is the element pointed to by position, does not invoke any operation of the multi_index_container after e is directly modified or, before modification, if the operation would invalidate position. back(e) does not invoke any operation of the multi_index_container. The sequence of operations mod(e), back(e) restores all keys of the element to their original state.
  Effects: Calls mod(e) where e is the element pointed to by position and tries to rearrange *position into all the indices of the multi_index_container. Rearrangement is successful if

  • индекс не является уникальным или не существует другого элемента с эквивалентным ключом;
  • Перестройка допускается всеми другими индексамиmulti_index_container.

  If the rearrangement fails, back(e) is invoked and the element is kept at its original position in all indices.
  Postconditions: Validity of position is preserved except if the element is erased under the conditions described below. If the key of the modified value is equivalent to that of the original value, the position of the element does not change.
  Returns: true if the operation succeeded, false otherwise.
  Complexity: O(M(n)).
  Exception safety: Strong, except if back throws an exception, in which case the modified element is erased. If back throws inside the handling code executing after some other user-provided operation has thrown, it is the exception generated by back that is rethrown.

  template<typename Modifier> bool modify_key(iterator position,Modifier mod);

  Requires: key_from_value is a read/write Key Extractor from value_type. mod is a unary function object accepting arguments of type key_type&. position is a valid dereferenceable iterator of the index. The execution of mod(k), where k is the key of the element pointed to by position, does not invoke any operation of the multi_index_container after k is directly modified or, before modification, if the operation would invalidate position.
  Effects: Equivalent to modify(position,mod'), with mod' defined in such a way that mod'(x) is the same as mod(key(x)), where key is the internal KeyFromValue object of the index.

  template<typename Modifier,typename Rollback>
bool modify_key(iterator position,Modifier mod,Rollback back);

  Requires: key_from_value is a read/write Key Extractor from value_type. mod and back are unary function objects accepting arguments of type key_type&. position is a valid dereferenceable iterator of the index. The execution of mod(k), where k is the key of the element pointed to by position, does not invoke any operation of the multi_index_container after k is directly modified or, before modification, if the operation would invalidate position. back(k) does not invoke any operation of the multi_index_container. The sequence of operations mod(k), back(k) restores k to its original state.
  Effects: Equivalent to modify(position,mod',back'), with mod' and back defined in such a way that mod'(x) is the same as mod(key(x)) and back'(x) is the same as back(key(x)), where key is the internal KeyFromValue object of the index.

  Observers

  Помимо стандартных<hash_function>и<key_eq>, хешированные индексы имеют функцию члена для извлечения используемого внутреннего экстрактора ключа.

  key_from_value key_extractor()const;

  Returns a copy of the key_from_value object used to construct the index.
  Complexity: Constant.

  Lookup

  Индексы хеширования обеспечивают полную функциональность поиска, требуемую[unord.req], а именно<find>,<count>и<equal_range>. Кроме того, эти функции членов шаблонизированы, чтобы обеспечить нестандартные аргументы, таким образом расширяя типы разрешенных поисковых операций. Вид аргументов, допустимых при вызове функций поиска, определяется следующей концепцией.

  Рассмотрим пару<Hash>,<Pred>, где<Hash>является хеш-функтором над значениями типа<Key>и<Pred>является двоичным предикатом, индуцирующим отношение эквивалентности на<Key>, с дополнительным ограничением, что эквивалентные ключи имеют одинаковое хеш-значение. Триплет типов [<CompatibleKey>,<CompatibleHash>,<CompatiblePred>] называетсясовместимым расширением[<Hash>,<Pred>], если

  1. < [113] >хеш-функциональный шах х типа< [114] >,
  2. < [117] >[< [118] >]< [118] >< [117] >[< [121] >] [< [117] >] [< [121] >] [< [117] >]] [< [117] >]] [< [121] >] [< [117] >]] [< [117] >]] [< [121] >] [< [117] >]
  3. < [129] >,
  4. < [131] >и< [132] >,
  5. < [135] >и< [136] >,< [137] >,
  6. < [141] >,< [142] >,
  для каждого<c_hash>типа<CompatibleHash>,<c_eq>типа<Hash>,<eq>типа<Pred>,<ck>типаCompatibleHashявляется хеш-функтором на значениях типаCompatibleKey,
  • CompatiblePred— двоичный предикат надKey,CompatibleKey,
  • CompatiblePred— двоичный предикат надCompatibleKey,Key,
  • Еслиc_eq(ck,k1), тоc_eq(k1,ck)
  • Еслиc_eq(ck,k1)иeq(k1,k2), тоc_eq(ck,k2)
  • Еслиc_eq(ck,k1)иc_eq(ck,k2), тоeq(k1,k2),
  • Еслиc_eq(ck,k1), тоc_hash(ck)==hash(k1)
  for every c_hash of type CompatibleHash, c_eq of type CompatiblePred, hash of type Hash, eq of type Pred, ck of type CompatibleKey and k1, k2 of type Key. [ORIG_END] -->

  Кроме того, тип<CompatibleKey>называетсясовместимым ключом<Hash>,<Pred>, если<CompatibleKey>,<Hash>,<Pred>является совместимым расширением<Hash>,<Pred>. Это означает, что<Hash>и<Pred>принимают аргументы типа<CompatibleKey>, что обычно означает, что они имеют несколько перегрузок своих соответствующих<operator()>функций-членов.

  В контексте совместимого расширения или совместимого ключа выражение «эквивалентный ключ» принимает свою очевидную интерпретацию.

  template<typename CompatibleKey> iterator find(const CompatibleKey& x)const;

  Requires: CompatibleKey is a compatible key of (hasher, key_equal).
  Effects: Returns a pointer to an element whose key is equivalent to x, or end() if such an element does not exist.
  Complexity: Average case O(1) (constant), worst case O(ndist).
  

  template<
  typename CompatibleKey,typename CompatibleHash, typename CompatiblePred
>
iterator find(
  const CompatibleKey& x,
  const CompatibleHash& hash,const CompatiblePred& eq)const;

  Requires: (CompatibleKey, CompatibleHash, CompatiblePred) is a compatible extension of (hasher, key_equal).
  Effects: Returns a pointer to an element whose key is equivalent to x, or end() if such an element does not exist.
  Complexity: Average case O(1) (constant), worst case O(ndist).
  

  template<typename CompatibleKey>
size_type count(const CompatibleKey& x)const;

  Requires: CompatibleKey is a compatible key of (hasher, key_equal).
  Effects: Returns the number of elements with key equivalent to x.
  Complexity: Average case O(count(x)), worst case O(count(x)+ndist).
  

  template<
  typename CompatibleKey,typename CompatibleHash, typename CompatiblePred
>
size_type count(
  const CompatibleKey& x,
  const CompatibleHash& hash,const CompatiblePred& eq)const;

  Requires: (CompatibleKey, CompatibleHash, CompatiblePred) is a compatible extension of (hasher, key_equal).
  Effects: Returns the number of elements with key equivalent to x.
  Complexity: Average case O(count(x,hash,eq)), worst case O(count(x,hash,eq)+ndist).
  

  template<typename CompatibleKey>
std::pair<iterator,iterator> equal_range(const CompatibleKey& x)const;

  Requires: CompatibleKey is a compatible key of (hasher, key_equal).
  Effects: Returns a range containing all elements with keys equivalent to x (and only those), or (end(),end()) if no such elements exist.
  Complexity: Average case O(1) (constant), worst case O(ndist).
  

  template<
  typename CompatibleKey,typename CompatibleHash, typename CompatiblePred
>
std::pair<iterator,iterator> equal_range(
  const CompatibleKey& x,
  const CompatibleHash& hash,const CompatiblePred& eq)const;

  Requires: (CompatibleKey, CompatibleHash, CompatiblePred) is a compatible extension of (hasher, key_equal).
  Effects: Returns a range containing all elements with keys equivalent to x (and only those), or (end(),end()) if no such elements exist.
  Complexity: Average case O(1) (constant), worst case O(ndist).
  

  Bucket interface

  local_iterator       local_iterator_to(const value_type& x);
const_local_iterator local_iterator_to(const value_type& x)const;

  Requires: x is a reference to an element of the container.
  Returns: An iterator to x.
  Complexity: Constant.
  Exception safety: nothrow.
  

  Hash policy

  void rehash(size_type n);

  Effects: Increases if necessary the number of internal buckets so that size()/bucket_count() does not exceed the maximum load factor, and bucket_count()>=n.
  Postconditions: Validity of iterators and references to the elements contained is preserved.
  Complexity: O(m), where m is the number of non-equivalent elements in the index.
  Exception safety: Strong.

  void reserve(size_type n);

  Effects:

  rehash(std::ceil(n/max_load_factor()));
  

  Comparison

  template<implementation defined>
bool operator==(const index class name& x,const index class name& y);

  Requires: x.key_extractor(), x.hash_function() and x.key_eq() have the same behavior as the corresponding objects in y. For any two elements e1, e2 in x or y, if e1==e2 then their keys are equivalent.
  Returns: true iff x and y have the same size and for each key k present in x the range x.equal_range(k) is equal (considering the == operator of value_type) to y.equal_range(k) under permutations of the elements.
  Complexity: Let k1,...,km be the different keys present in x:
  

  • Если для каждогоkix.equal_range(ki)устроено в том же порядке, что иy.equal_range(ki), средний случайO(x.size()), наихудший случайO(x.size()2).
  • В противном случае средний случайO(Σ(x.count(ki)2)), худший случайO(x.size()2).

  (For unique indices, the formulas above reduce to average case O(x.size()), worst case O(x.size()2).)

  Serialization

  Индексы не могут быть сериализованы сами по себе, но только как часть<multi_index_container>, в которую они встроены. При описании дополнительных предварительных условий и гарантий, связанных с хешированными индексами в отношении сериализации их встраиваемых контейнеров, мы используем понятия, определенные в<multi_index_container>.Раздел сериализации.

  Operation: saving of a multi_index_container m to an output archive (XML archive) ar.

  Requires: No additional requirements to those imposed by the container.

  Operation: loading of a multi_index_container m' from an input archive (XML archive) ar.

  Requires: Additionally to the general requirements, key_eq() must be serialization-compatible with m.get<i>().key_eq(), where i is the position of the hashed index in the container.
  Postconditions: On successful loading, the range [begin(), end()) contains restored copies of every element in [m.get<i>().begin(), m.get<i>().end()), though not necessarily in the same order.

  Operation: saving of an iterator or const_iterator it to an output archive (XML archive) ar.

  Requires: it is a valid iterator of the index. The associated multi_index_container has been previously saved.

  Operation: loading of an iterator or const_iterator it' from an input archive (XML archive) ar.

  Postconditions: On successful loading, if it was dereferenceable then *it' is the restored copy of *it, otherwise it'==end().
  Note: It is allowed that it be a const_iterator and the restored it' an iterator, or vice versa.

  Operation: saving of a local_iterator or const_local_iterator it to an output archive (XML archive) ar.

  Requires: it is a valid local iterator of the index. The associated multi_index_container has been previously saved.

  Operation: loading of a local_iterator or const_local_iterator it' from an input archive (XML archive) ar.

  Postconditions: On successful loading, if it was dereferenceable then *it' is the restored copy of *it; if it was m.get<i>().end(n) for some n, then it'==m'.get<i>().end(n) (where m is the original multi_index_container, m' its restored copy and i is the ordinal of the index.)
  Note: It is allowed that it be a const_local_iterator and the restored it' a local_iterator, or vice versa.

  ---

  
  Ranked indices
  
  Boost.MultiIndex reference
  
  Sequenced indices
  
  
  

  Пересмотрено 26 ноября 2015 года

  © Copyright 2003-2015 Joaquín M López Muñoz. Распространяется под лицензией Boost Software License, версия 1.0. (См. сопроводительный файлLICENSE_1_0.txtили копию на) http://www.boost.org/LICENSE_1_0.txt

  Статья Boost.MultiIndex Documentation - Hashed indices reference раздела Boost.MultiIndex Documentation - Reference может быть полезна для разработчиков на c++ и boost.

  
  
  
  

  Материалы статей собраны из открытых источников, владелец сайта не претендует на авторство. Там где авторство установить не удалось, материал подаётся без имени автора. В случае если Вы считаете, что Ваши права нарушены, пожалуйста, свяжитесь с владельцем сайта.

  
  

  ---

  :: Главная :: Boost.MultiIndex Documentation - Reference ::

  ---

  реклама

  ---