This is an archive of the discontinued LLVM Phabricator instance.

Documentation for bugprone-inaccurate-erase: added an example of a bug that this checker catches
ClosedPublic

Authored by gribozavr on May 7 2019, 9:45 AM.

Reviewers

Commits

LG. Thank you!

This revision is now accepted and ready to land.May 8 2019, 4:27 AM

This revision was automatically updated to reflect the committed changes.

Path

Size

docs/

clang-tidy/

checks/

16 lines

	.. title:: clang-tidy - bugprone-inaccurate-erase			.. title:: clang-tidy - bugprone-inaccurate-erase

	bugprone-inaccurate-erase			bugprone-inaccurate-erase
	=========================			=========================


	Checks for inaccurate use of the ``erase()`` method.			Checks for inaccurate use of the ``erase()`` method.

	Algorithms like ``remove()`` do not actually remove any element from the			Algorithms like ``remove()`` do not actually remove any element from the
	container but return an iterator to the first redundant element at the end			container but return an iterator to the first redundant element at the end
	of the container. These redundant elements must be removed using the			of the container. These redundant elements must be removed using the
	``erase()`` method. This check warns when not all of the elements will be			``erase()`` method. This check warns when not all of the elements will be
	removed due to using an inappropriate overload.			removed due to using an inappropriate overload.

				For example, the following code erases only one element:

				.. code-block:: c++

				std::vector<int> xs;
				...
				xs.erase(std::remove(xs.begin(), xs.end(), 10));

				Call the two-argument overload of ``erase()`` to remove the subrange:

				.. code-block:: c++

				std::vector<int> xs;
				...
				xs.erase(std::remove(xs.begin(), xs.end(), 10), xs.end());