| 1 |
.. title:: clang-tidy - readability-container-contains |
| 2 |
|
| 3 |
readability-container-contains |
| 4 |
============================== |
| 5 |
|
| 6 |
Finds usages of ``container.count()`` and ``container.find() == container.end()`` which should be replaced by a call to the ``container.contains()`` method introduced in C++20. |
| 7 |
|
| 8 |
Whether an element is contained inside a container should be checked with ``contains`` instead of ``count``/``find`` because ``contains`` conveys the intent more clearly. Furthermore, for containers which permit multiple entries per key (``multimap``, ``multiset``, ...), ``contains`` is more efficient than ``count`` because ``count`` has to do unnecessary additional work. |
| 9 |
|
| 10 |
Examples: |
| 11 |
|
| 12 |
=========================================== ============================== |
| 13 |
Initial expression Result |
| 14 |
------------------------------------------- ------------------------------ |
| 15 |
``myMap.find(x) == myMap.end()`` ``!myMap.contains(x)`` |
| 16 |
``myMap.find(x) != myMap.end()`` ``myMap.contains(x)`` |
| 17 |
``if (myMap.count(x))`` ``if (myMap.contains(x))`` |
| 18 |
``bool exists = myMap.count(x)`` ``bool exists = myMap.contains(x)`` |
| 19 |
``bool exists = myMap.count(x) > 0`` ``bool exists = myMap.contains(x)`` |
| 20 |
``bool exists = myMap.count(x) >= 1`` ``bool exists = myMap.contains(x)`` |
| 21 |
``bool missing = myMap.count(x) == 0`` ``bool missing = !myMap.contains(x)`` |
| 22 |
=========================================== ============================== |
| 23 |
|
| 24 |
This check applies to ``std::set``, ``std::unordered_set``, ``std::map``, ``std::unordered_map`` and the corresponding multi-key variants. |
| 25 |
It is only active for C++20 and later, as the ``contains`` method was only added in C++20. |