xtd::collections::generic::helpers::comparer< type_t > Struct Template Reference

Definition

template<typename type_t = void>
struct xtd::collections::generic::helpers::comparer< type_t >

Implements a function object for compare data.

class comparer

Header

#include <xtd/collections/comparer

Namespace

xtd::collections::generic

Library

xtd.core

Remarks

The associative containers xtd::collections::generic::sorted_set, xtd::collections::generic::sorted_multi_set, xtd::collections::generic::sorted_dictionary, xtd::collections::generic::sorted_multi_dictionary use specializations of the template xtd::collections::generic::helpers::comparer as the defaultcompare function.

Examples

The following example show how to use xtd::collections::generic::helpers::comparer with std::unordered_map.

auto key_values = std::map<xtd::date_time, xtd::string, xtd::collections::generic::helpers::comparer<xtd::date_time>, xtd::collections::generic::helpers::allocator<xtd::collections::generic::key_value_pair<const xtd::date_time, xtd::string>>> {};
key_values.insert({{1971, 1, 5}, "Birth date"});

Public Operators
constexpr bool	operator() (const type_t &lhs, const type_t &rhs) const
	Serves as a hash function for a specified key with a particular type (type_t).

Member Function Documentation

operator()()

template<typename type_t = void>

constexpr bool xtd::collections::generic::helpers::comparer< type_t >::operator() ( const type_t &  lhs, const type_t &  rhs  ) const

inlineconstexpr

Serves as a hash function for a specified key with a particular type (type_t).

Parameters

key	The key to hash.

Returns

A hash code for the spesified key.

Remarks

If key_t inherits from xtd::object, the xtd::object::get_hash_code method will be used; otherwise, the std::hash object function will be used.

---

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

• xtd.core/include/xtd/collections/generic/helpers/comparer.h