xtd 1.0.0
Loading...
Searching...
No Matches
dictionary.hpp
Go to the documentation of this file.
1
4#pragma once
5#define __XTD_CORE_INTERNAL__
7#undef __XTD_CORE_INTERNAL__
8#include "list.hpp"
9#include "../../new_ptr.hpp"
10#include "../../ptr.hpp"
11#include <cmath>
12
14namespace xtd {
16 namespace collections {
18 namespace generic {
62 template<typename key_t, typename value_t, typename hasher_t, typename equator_t, typename allocator_t>
63 class dictionary : public xtd::object, public xtd::collections::generic::idictionary<key_t, value_t> {
64 public:
66
77 using base_value_type = std::pair < const key_t, value_t >;
79 using base_type = std::unordered_map < key_type, mapped_type, hasher_t, equator_t, allocator_t >;
85 using equator = equator_t;
87 using hasher = hasher_t;
89
91
123 dictionary() noexcept = default;
134 dictionary(const xtd::collections::generic::idictionary < key_t, value_t >& dictionary) {
136 for (const auto& item : dictionary)
137 add(item);
138 }
139
142 dictionary(const xtd::collections::generic::ienumerable < value_type >& collection) {
143 for (const auto& item : collection)
144 add(item);
145 }
146
163
176
186 dictionary(const xtd::collections::generic::idictionary < key_t, value_t >& dictionary, const xtd::collections::generic::iequality_comparer<key_type>& comparer) : data_(xtd::new_ptr < dictionary_data>(comparer)) {
188 for (const auto& item : dictionary)
189 add(item);
190 }
191
195 dictionary(const xtd::collections::generic::ienumerable < value_type >& collection, const xtd::collections::generic::iequality_comparer<key_type>& comparer) : data_(xtd::new_ptr < dictionary_data>(comparer)) {
196 for (const auto& item : collection)
197 add(item);
198 }
199
202 dictionary(dictionary&& other) noexcept = default;
206 dictionary(const dictionary & other) : data_(xtd::new_ptr < dictionary_data > (*other.data_->comparer, other.data_->items, other.data_->version)) {}
210 dictionary(std::unordered_map < key_t, value_t > && other) {
211 data_->items.reserve(other.size());
212 for (auto&& item : other) {
213 data_->items.insert(std::move(item));
214 ++data_->version;
215 }
216 }
217
221 dictionary(const std::unordered_map < key_t, value_t >& other) {
222 for (const auto& [key, value] : other)
223 add(key, value);
224 }
225
232 dictionary(std::initializer_list < base_value_type > init) {
233 for (const auto& [key, value] : init)
234 add(key, value);
235 }
236
244 template < class init_key_t, typename init_value_t >
245 explicit dictionary(std::initializer_list < key_value_pair < init_key_t, init_value_t>> init) {
246 for (const auto& [key, value] : init)
247 add(key, value);
248 }
249
255 template < class input_iterator_t >
256 explicit dictionary(input_iterator_t first, input_iterator_t last) {
257 for (auto iterator = first; iterator != last; ++iterator) {
258 const auto& [key, value] = *iterator;
259 add(key, value);
260 }
261 }
262
263
265
270 [[nodiscard]] auto capacity() const noexcept -> size_type {return items().bucket_count();}
271
275 [[nodiscard]] auto comparer() const noexcept -> const iequality_comparer < key_t >& {
276 if (!data_->comparer) return equality_comparer <key_type>::default_equality_comparer();
277 return *data_->comparer;
278 }
279
285 [[nodiscard]] auto count() const noexcept -> size_type override {return data_->items.size();}
286
289 [[nodiscard]] virtual auto items() const noexcept -> const base_type& {return data_->items;}
292 [[nodiscard]] virtual auto items() noexcept -> base_type& {return data_->items;}
293
298 [[nodiscard]] auto keys() const noexcept -> key_collection override {
299 auto keys = key_collection {};
300 for (const auto& [key, value] : data_->items)
301 keys.add(key);
302 return keys;
303 }
304
309 [[nodiscard]] auto values() const noexcept -> value_collection override {
310 auto values = value_collection {};
311 for (const auto& [key, value] : data_->items)
312 values.add(value);
313 return values;
314 }
315
316
318
326 auto add(const key_t & key, const value_t& value) -> void override {
328 }
329
333 auto add(const value_type & item) -> void override {
334 add(item.key(), item.value());
335 }
336
339 auto clear() noexcept -> void override {
340 data_->items.clear();
341 ++data_->version;
342 }
343
347 [[nodiscard]] auto contains(const value_type & item) const noexcept -> bool override {
348 auto iterator = items().find(item.key());
349 if (iterator == items().end()) return false;
350 return iterator->second == item.value();
351 }
352
357 [[nodiscard]] auto contains_key(const key_t & key) const noexcept -> bool override {
358 return data_->items.find(key) != data_->items.end();
359 }
360
365 [[nodiscard]] auto contains_value(const value_t& value) const noexcept -> bool {
366 for (const auto& [item_key, item_value] : self_)
367 if (item_value == value) return true;
368 return false;
369 }
370
375 auto copy_to(xtd::array < value_type >& array, xtd::usize array_index) const -> void override {
377 for (const auto& item : self_)
378 array[array_index++] = item;
379 }
380
385 data_->items.reserve(capacity);
386 return self_.capacity();
387 }
388
391 [[nodiscard]] enumerator<value_type> get_enumerator() const noexcept override {
392 struct dictionary_enumerator : public ienumerator < value_type > {
393 explicit dictionary_enumerator(const dictionary & items, size_type version) : items_(items), version_(version) {}
394
395 [[nodiscard]] const value_type& current() const override {
397 if (version_ != items_.data_->version) xtd::helpers::throw_helper::throws(xtd::helpers::exception_case::invalid_operation, "Collection was modified; enumeration operation may not execute.");
398 return (value_ = value_type {*iterator_});
399 }
400
401 [[nodiscard]] bool move_next() override {
402 if (version_ != items_.data_->version) xtd::helpers::throw_helper::throws(xtd::helpers::exception_case::invalid_operation, "Collection was modified; enumeration operation may not execute.");
403 if (index_++ && iterator_ != items_.data_->items.cend()) ++iterator_;
404 else iterator_ = items_.items().cbegin();
405 return iterator_ != items_.data_->items.cend();
406 }
407
408 void reset() override {
409 index_ = 0;
410 version_ = items_.data_->version;
411 iterator_ = items_.items().cend();
412 }
413
414 private:
415 size_type index_ = 0;
416 const dictionary& items_;
417 typename dictionary::base_type::const_iterator iterator_ = items_.data_->items.cend();
418 mutable value_type value_;
419 size_type version_ = 0;
420 };
421 return {new_ptr < dictionary_enumerator > (self_, data_->version)};
422 }
423
428 auto remove(const key_t & key) noexcept -> bool override {
429 return items().erase(key) == 1;
430 }
431
435 auto remove(const value_type & item) noexcept -> bool override {
436 if (!contains_value(item.value())) return false;
437 return items().erase(item.key()) == 1;
438 }
439
443 auto remove(const key_t & key, value_t& value) noexcept -> bool {
444 auto iterator = items().find(key);
445 if (iterator == items().end()) return false;
446 value = iterator->value();
447 return items().erase(iterator) != items().end();
448 }
449
452 [[nodiscard]] auto to_string() const noexcept -> xtd::string override {return xtd::string::format("{{{}}}", xtd::string::join(", ", self_));}
453
462
469 auto trim_excess() -> void {
470 rehash(count());
471 }
472
478 [[nodiscard]] auto try_add(const key_t & key, const value_t value) noexcept -> bool {
479 const auto& [iterator, succeeded] = data_->items.insert(std::forward < base_value_type > ({key, value}));
480 if (succeeded) ++data_->version;
481 return succeeded;
482 }
483
488 [[nodiscard]] auto try_get_value(const key_t & key, value_t& value) const -> bool override {
489 auto iterator = items().find(key);
490 if (iterator != items().end()) {
491 value = iterator->second;
492 return true;
493 }
494 value = value_t {};
495 return false;
496 }
497
498
500
505 auto operator =(dictionary&& other) noexcept -> dictionary& {
506 data_->comparer = std::move(other.data_->comparer);
507 data_->items = std::move(other.data_->items);
508 data_->version = std::move(other.data_->version);
509 return self_;
510 }
511
514 auto operator =(std::unordered_map < key_t, value_t > && other) noexcept -> dictionary& {
515 data_->items = std::move(other);
516 ++data_->version;
517 return self_;
518 }
519
522 auto operator =(const dictionary & other) noexcept -> dictionary& = default;
526 auto operator =(const std::unordered_map < key_t, value_t >& other) noexcept -> dictionary& {
527 data_->items.clear();
528 for (const auto& [key, value] : other)
529 add(key, value);
530 }
531
534 auto operator =(std::initializer_list < base_value_type > ilist) -> dictionary& {
535 data_->items.clear();
536 for (const auto& [key, value] : ilist)
537 add(key, value);
538 }
539
542 template < class init_key_t, typename init_value_t >
543 auto operator =(std::initializer_list < key_value_pair < init_key_t, init_value_t>> ilist) -> dictionary& {
544 data_->items.clear();
545 for (const auto& [key, value] : ilist)
546 add(key, value);
547 }
548
556 [[nodiscard]] const value_t& operator [](const key_t & key) const override {
557 auto iterator = data_->items.find(key);
559 return iterator->second;
560 }
561
567 [[nodiscard]] value_t& operator [](const key_t & key) override {
568 ++data_->version;
569 return data_->items[key];
570 }
571
574 operator const base_type& () const noexcept {return data_->items;}
577 operator base_type& () noexcept {return data_->items;}
580 operator std::unordered_map<key_t, value_t>() const noexcept {
581 std::unordered_map<key_t, value_t> result;
582 for (auto& [key, value] : data_->items)
583 result[key] = value;
584 return result;
585 }
586
587
588 private:
589 auto is_read_only() const noexcept -> bool override {return false;}
590 auto is_synchronized() const noexcept -> bool override {return false;}
591 const xtd::object& sync_root() const noexcept override {return data_->sync_root;}
592
593 struct dictionary_data {
594 dictionary_data() = default;
595 dictionary_data(const xtd::collections::generic::iequality_comparer<key_type>& comparer) : comparer {&comparer}, items {size_type {}, hasher_t {comparer}, equator_t {comparer}} {}
596 dictionary_data(const xtd::collections::generic::iequality_comparer<key_type>& comparer, const base_type & items, size_type version) noexcept : comparer {&comparer}, items {size_type {}, hasher_t {comparer}, equator_t {comparer}}, version {version} {
597 for (const auto& item : items)
598 self_.items.insert(item);
599 }
600 dictionary_data(base_type&& items, size_type version) noexcept : version {version} {
601 for (auto&& item : items)
602 self_.items.insert(item);
603 }
604
605 const xtd::collections::generic::iequality_comparer<key_type>* comparer = null;
606 base_type items;
607 size_type version = 0;
608 xtd::object sync_root;
609 };
611 };
612
614 // Deduction guides for xtd::collections::generic::dictionary
615 // {
616 template < class key_t, typename value_t >
618
619 template < class key_t, typename value_t >
620 dictionary(ienumerable < key_value_pair < key_t, value_t>>) -> dictionary<key_t, value_t>;
621
622 template < class key_t, typename value_t >
623 dictionary(std::initializer_list < key_value_pair < key_t, value_t>>) -> dictionary<key_t, value_t>;
624
625 template < class key_t, typename value_t >
626 dictionary(std::initializer_list < std::pair < key_t, value_t>>) -> dictionary<key_t, value_t>;
627
628 template < class input_iterator_t >
630 // }
632 }
633 }
634}
Provides methods for creating, manipulating, searching, and sorting arrays, thereby serving as the ba...
Definition array.hpp:64
virtual auto length() const noexcept -> size_type
Gets a size that represents the total number of elements in all the dimensions of the array.
Definition basic_array.hpp:122
static auto join(const basic_string &separator, const collection_t &values) noexcept -> basic_string
Definition basic_string.hpp:1258
Represents a collection of keys and values.
Definition dictionary.hpp:63
typename xtd::collections::generic::idictionary< xtd::intptr, xtd::ptr< collection_type > >::key_type key_type
Definition dictionary.hpp:69
auto try_get_value(const key_t &key, value_t &value) const -> bool override
Gets the value associated with the specified key.
Definition dictionary.hpp:488
dictionary(const xtd::collections::generic::ienumerable< value_type > &collection)
Initializes a new instance of the xtd::collections::generic::dictionary <key_t, value_t> class that c...
Definition dictionary.hpp:142
dictionary(dictionary &&other) noexcept=default
Initializes instance of the xtd::collections::generic::dictionary <key_t, value_t> class from a varie...
dictionary(const dictionary &other)
Initializes instance of the xtd::collections::generic::dictionary <key_t, value_t> class from a varie...
Definition dictionary.hpp:206
typename xtd::collections::generic::idictionary< key_type, mapped_type >::value_collection value_collection
Definition dictionary.hpp:83
const value_t & operator[](const key_t &key) const override
Gets the element with the specified key.
Definition dictionary.hpp:556
auto comparer() const noexcept -> const iequality_comparer< xtd::intptr > &
Definition dictionary.hpp:275
auto values() const noexcept -> value_collection override
Gets a collection containing the values in the xtd::collections::generic::dictionary <key_t,...
Definition dictionary.hpp:309
auto remove(const value_type &item) noexcept -> bool override
Removes the first occurrence of a specific object from the xtd::collections::generic::dictionary <key...
Definition dictionary.hpp:435
auto trim_excess() -> void
Sets the capacity of this dictionary to what it would be if it had been originally initialized with a...
Definition dictionary.hpp:469
auto to_string() const noexcept -> xtd::string override
Gets a string that represents the current object.
Definition dictionary.hpp:452
auto contains_value(const value_t &value) const noexcept -> bool
Determines whether the xtd::collections::generic::dictionary <key_t, value_t> contains the specified ...
Definition dictionary.hpp:365
dictionary(const xtd::collections::generic::ienumerable< value_type > &collection, const xtd::collections::generic::iequality_comparer< key_type > &comparer)
Initializes a new instance of the xtd::collections::generic::dictionary <key_t, value_t> class that c...
Definition dictionary.hpp:195
dictionary(const std::unordered_map< key_t, value_t > &other)
Initializes instance of the xtd::collections::generic::dictionary <key_t, value_t> class from a varie...
Definition dictionary.hpp:221
dictionary(std::initializer_list< base_value_type > init)
Initializes instance of the xtd::collections::generic::dictionary <key_t, value_t> class from a varie...
Definition dictionary.hpp:232
dictionary(input_iterator_t first, input_iterator_t last)
Initializes instance of the xtd::collections::generic::dictionary <key_t, value_t> class from a varie...
Definition dictionary.hpp:256
dictionary() noexcept=default
Initializes a new instance of the xtd::collections::generic::dictionary <key_t, value_t> class that i...
virtual auto items() const noexcept -> const base_type &
Definition dictionary.hpp:289
auto contains(const value_type &item) const noexcept -> bool override
Determines whether an element is in the xtd::collections::generic::dictionary <key_t,...
Definition dictionary.hpp:347
dictionary(xtd::usize capacity, const xtd::collections::generic::iequality_comparer< key_type > &comparer)
Initializes a new instance of the xtd::collections::generic::dictionary <key_t, value_t> class that i...
Definition dictionary.hpp:173
std::unordered_map< key_type, mapped_type, hasher_t, equator_t, allocator_t > base_type
Definition dictionary.hpp:79
auto capacity() const noexcept -> size_type
Definition dictionary.hpp:270
auto operator=(dictionary &&other) noexcept -> dictionary &
Move assignment operator. Replaces the contents with a copy of the contents of other.
Definition dictionary.hpp:505
auto keys() const noexcept -> key_collection override
Gets a collection containing the keys in the xtd::collections::generic::dictionary <key_t,...
Definition dictionary.hpp:298
auto trim_excess(size_type capacity) -> void
Sets the capacity of this dictionary to hold up a specified number of entries without any further exp...
Definition dictionary.hpp:458
auto try_add(const key_t &key, const value_t value) noexcept -> bool
Attempts to add the specified key and value to the dictionary.
Definition dictionary.hpp:478
auto contains_key(const key_t &key) const noexcept -> bool override
Determines whether the xtd::collections::generic::dictionary <key_t, value_t> contains the specified ...
Definition dictionary.hpp:357
std::pair< const xtd::intptr, xtd::ptr< collection_type > > base_value_type
Definition dictionary.hpp:77
virtual auto items() noexcept -> base_type &
Returns the underlying base type items.
Definition dictionary.hpp:292
auto add(const value_type &item) -> void override
Adds an item to the xtd::collections::generic::icollection <type_t>.
Definition dictionary.hpp:333
auto add(const key_t &key, const value_t &value) -> void override
Adds an element with the provided key and value to the xtd::collections::generic::dictionary <key_t,...
Definition dictionary.hpp:326
dictionary(std::initializer_list< key_value_pair< init_key_t, init_value_t > > init)
Initializes instance of the xtd::collections::generic::dictionary <key_t, value_t> class from a varie...
Definition dictionary.hpp:245
dictionary(const xtd::collections::generic::idictionary< key_t, value_t > &dictionary, const xtd::collections::generic::iequality_comparer< key_type > &comparer)
Initializes a new instance of the xtd::collections::generic::dictionary <key_t, value_t> class that c...
Definition dictionary.hpp:186
enumerator< value_type > get_enumerator() const noexcept override
Returns an enumerator that iterates through the xtd::collections::generic::dictionary <key_t,...
Definition dictionary.hpp:391
auto count() const noexcept -> size_type override
Gets the number of key/value pairs contained in the xtd::collections::generic::dictionary <key_t,...
Definition dictionary.hpp:285
auto copy_to(xtd::array< value_type > &array, xtd::usize array_index) const -> void override
Copies the elements of the xtd::collections::generic::icollection <type_t> to an xtd::array,...
Definition dictionary.hpp:375
auto remove(const key_t &key) noexcept -> bool override
Removes the value with the specified key from the xtd::collections::generic::dictionary <key_t,...
Definition dictionary.hpp:428
auto remove(const key_t &key, value_t &value) noexcept -> bool
Removes the value with the specified key from the xtd::collections::generic::dictionary <key_t,...
Definition dictionary.hpp:443
typename xtd::collections::generic::idictionary< key_type, mapped_type >::key_collection key_collection
Definition dictionary.hpp:81
auto clear() noexcept -> void override
Removes all keys and values from the xtd::collections::generic::dictionary <key_t,...
Definition dictionary.hpp:339
typename xtd::collections::generic::idictionary< xtd::intptr, xtd::ptr< collection_type > >::mapped_type mapped_type
Definition dictionary.hpp:71
typename xtd::collections::generic::idictionary< key_type, mapped_type >::value_type value_type
Definition dictionary.hpp:73
dictionary(std::unordered_map< key_t, value_t > &&other)
Initializes instance of the xtd::collections::generic::dictionary <key_t, value_t> class from a varie...
Definition dictionary.hpp:210
auto ensure_capacity(xtd::usize capacity) noexcept -> size_type
Ensures that the dictionary can hold up to a specified number of entries without any further expansio...
Definition dictionary.hpp:384
dictionary(xtd::usize capacity)
Initializes a new instance of the xtd::collections::generic::dictionary <key_t, value_t> class that i...
Definition dictionary.hpp:160
dictionary(const xtd::collections::generic::iequality_comparer< key_type > &comparer)
Initializes a new instance of the xtd::collections::generic::dictionary <key_t, value_t> class that i...
Definition dictionary.hpp:151
static auto default_equality_comparer() -> const equality_comparer &
Gets the default equality comparer for the type specified by the generic argument.
Definition equality_comparer.hpp:42
Represents a generic collection of key/value pairs.
Definition idictionary.hpp:47
xtd::collections::generic::list< mapped_type > value_collection
Definition idictionary.hpp:65
xtd::collections::generic::list< key_type > key_collection
Definition idictionary.hpp:63
virtual auto sync_root() const noexcept -> const xtd::object &=0
Gets an object that can be used to synchronize access to the the xtd::collections::generic::icollecti...
virtual auto count() const noexcept -> xtd::usize=0
Gets the number of elements contained in the xtd::collections::generic::icollection <type_t>.
typename xtd::collections::generic::icollection< value_type >::iterator iterator
Represents the iterator of xtd::collections::generic::ienumerable value type.
Definition idictionary.hpp:59
virtual auto is_read_only() const noexcept -> bool=0
Gets a value indicating whether the xtd::collections::generic::icollection <type_t> is read-only.
virtual auto is_synchronized() const noexcept -> bool=0
Gets a value indicating whether access to the xtd::collections::generic::icollection <type_t> is sync...
typename xtd::collections::generic::icollection< xtd::collections::generic::key_value_pair< xtd::any_object, xtd::any_object > >::value_type value_type
Definition idictionary.hpp:57
Exposes the enumerator, which supports a simple iteration over a collection of a specified type.
Definition ienumerable.hpp:40
Supports a simple iteration over a generic collection.
Definition ienumerator.hpp:58
Defines methods to support the comparison of objects for equality.
Definition iequality_comparer.hpp:34
static auto throws(xtd::helpers::exception_case exception_case, const source_location &location=source_location::current()) -> void
Throws an exption with specified exception case.
Supports all classes in the xtd class hierarchy and provides low-level services to derived classes....
Definition object.hpp:45
Represents the version number of an assembly, operating system, or the xtd. This class cannot be inhe...
Definition version.hpp:115
xtd::collections::generic::comparer< xtd::any_object > comparer
Exposes a method that compares two objects.
Definition comparer.hpp:25
generic::idictionary< xtd::any_object, xtd::any_object > idictionary
interface IComparer exposes a method that compares two objects.
Definition idictionary.hpp:27
static auto format(const basic_string< char > &fmt, args_t &&... args) -> basic_string
std::tuple_element_t< 1, iterator_value_t< input_iterator_t > > iterator_mapped_t
Represents the mapped iterator type.
Definition iterator.hpp:57
@ argument
The argument is not valid.
Definition exception_case.hpp:31
@ argument_out_of_range
The argument is out of range.
Definition exception_case.hpp:35
@ invalid_operation
The operation is not valid.
Definition exception_case.hpp:65
@ key_not_found
The key is not found.
Definition exception_case.hpp:71
#define self_
The self_ expression is a reference value expression whose value is the reference of the implicit obj...
Definition self.hpp:20
null_ptr null
Represents a null pointer value.
xtd::sptr< type_t > ptr
The xtd::ptr object is a shared pointer.
Definition ptr.hpp:27
std::size_t usize
Represents an unsigned size of any object in bytes.
Definition usize.hpp:22
auto new_ptr(args_t &&... args) -> xtd::ptr< type_t >
The xtd::new_ptr operator creates a xtd::ptr object.
Definition new_ptr.hpp:24
@ other
The operating system is other.
Definition platform_id.hpp:60
Contains xtd::collections::generic::list <type_t> class.
The xtd::collections::generic namespace contains interfaces and classes that define generic collectio...
Definition comparer.hpp:16
The xtd::collections namespace contains interfaces and classes that define various collections of obj...
Definition any_pair.hpp:10
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition abstract_object.hpp:8
auto first() const -> read_only_span< type_t, count >
Obtains a subspan consisting of the first count elements of the sequence.
Definition read_only_span.hpp:249
auto last() const -> read_only_span< type_t, count >
Obtains a subspan consisting of the last N elements of the sequence.
Definition read_only_span.hpp:274
auto end() const -> const_iterator
Returns an iterator to the end.
Definition read_only_span.hpp:205
Contains xtd::new_ptr method.
Contains xtd::ptr type.
Supports a simple iteration over a generic collection.
Definition enumerator.hpp:39