From 8057051d9aadea8fdfb5e548e5dcffeb0cb4de25 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Vladim=C3=ADr=20Vondru=C5=A1?= <mosra@centrum.cz>
Date: Mon, 7 Mar 2022 09:57:21 +0100
Subject: [PATCH] Document what each #include <algorithm> is for.

Or remove it, if not for anything anymore.
---
 doc/snippets/MagnumSceneGraph.cpp                             | 2 +-
 src/Magnum/Audio/Context.cpp                                  | 2 +-
 src/Magnum/Audio/Source.cpp                                   | 2 +-
 src/Magnum/DebugTools/Profiler.cpp                            | 2 +-
 src/Magnum/GL/Context.cpp                                     | 2 +-
 src/Magnum/GL/Test/ContextGLTest.cpp                          | 2 +-
 src/Magnum/Math/Test/HalfTest.cpp                             | 1 -
 src/Magnum/MeshTools/Test/RemoveDuplicatesTest.cpp            | 4 ++--
 src/Magnum/SceneGraph/FeatureGroup.hpp                        | 2 +-
 src/Magnum/SceneGraph/Object.hpp                              | 2 +-
 src/Magnum/SceneGraph/Test/CameraTest.cpp                     | 2 +-
 src/Magnum/Text/AbstractFontConverter.cpp                     | 2 +-
 src/Magnum/Trade/MaterialData.cpp                             | 2 +-
 src/Magnum/Trade/SceneData.cpp                                | 2 +-
 src/Magnum/Trade/Test/MaterialDataTest.cpp                    | 2 +-
 src/Magnum/Vk/Device.cpp                                      | 2 +-
 src/Magnum/Vk/ExtensionProperties.cpp                         | 2 +-
 src/Magnum/Vk/Instance.cpp                                    | 2 +-
 src/Magnum/Vk/LayerProperties.cpp                             | 2 +-
 src/MagnumPlugins/MagnumFontConverter/MagnumFontConverter.cpp | 2 +-
 20 files changed, 20 insertions(+), 21 deletions(-)

diff --git a/doc/snippets/MagnumSceneGraph.cpp b/doc/snippets/MagnumSceneGraph.cpp
index 076182e8f..c639bdc7f 100644
--- a/doc/snippets/MagnumSceneGraph.cpp
+++ b/doc/snippets/MagnumSceneGraph.cpp
@@ -23,7 +23,7 @@
     DEALINGS IN THE SOFTWARE.
 */
 
-#include <algorithm>
+#include <algorithm> /* std::sort() */
 
 #include "Magnum/Math/Matrix4.h"
 #include "Magnum/Math/Intersection.h"
diff --git a/src/Magnum/Audio/Context.cpp b/src/Magnum/Audio/Context.cpp
index 6fd7c70ce..2e2963d71 100644
--- a/src/Magnum/Audio/Context.cpp
+++ b/src/Magnum/Audio/Context.cpp
@@ -28,7 +28,7 @@
 #include "Context.h"
 
 #include <cstring>
-#include <algorithm>
+#include <algorithm> /* std::lower_bound() */
 #include <Corrade/Utility/Arguments.h>
 #include <Corrade/Utility/Assert.h>
 #include <Corrade/Utility/Debug.h>
diff --git a/src/Magnum/Audio/Source.cpp b/src/Magnum/Audio/Source.cpp
index 61590a3a0..e7df860eb 100644
--- a/src/Magnum/Audio/Source.cpp
+++ b/src/Magnum/Audio/Source.cpp
@@ -25,7 +25,7 @@
 
 #include "Source.h"
 
-#include <algorithm>
+#include <algorithm> /* std::remove_if() */
 
 #include <Corrade/Containers/Array.h>
 #include <Corrade/Containers/Reference.h>
diff --git a/src/Magnum/DebugTools/Profiler.cpp b/src/Magnum/DebugTools/Profiler.cpp
index 6d7e8367a..eaaa79634 100644
--- a/src/Magnum/DebugTools/Profiler.cpp
+++ b/src/Magnum/DebugTools/Profiler.cpp
@@ -27,7 +27,7 @@
 
 #include "Profiler.h"
 
-#include <algorithm>
+#include <algorithm> /* std::sort() */
 #include <numeric>
 #include <Corrade/Utility/Assert.h>
 #include <Corrade/Utility/Debug.h>
diff --git a/src/Magnum/GL/Context.cpp b/src/Magnum/GL/Context.cpp
index c2c44851e..9d662ffdc 100644
--- a/src/Magnum/GL/Context.cpp
+++ b/src/Magnum/GL/Context.cpp
@@ -25,7 +25,7 @@
 
 #include "Context.h"
 
-#include <algorithm>
+#include <algorithm> /* std::lower_bound() */
 #include <Corrade/Containers/EnumSet.hpp>
 #include <Corrade/Containers/GrowableArray.h>
 #include <Corrade/Utility/Arguments.h>
diff --git a/src/Magnum/GL/Test/ContextGLTest.cpp b/src/Magnum/GL/Test/ContextGLTest.cpp
index 59ebbe432..6bee5e6c3 100644
--- a/src/Magnum/GL/Test/ContextGLTest.cpp
+++ b/src/Magnum/GL/Test/ContextGLTest.cpp
@@ -23,7 +23,7 @@
     DEALINGS IN THE SOFTWARE.
 */
 
-#include <algorithm>
+#include <algorithm> /* std::find() */
 #include <sstream>
 #include <Corrade/Containers/ScopeGuard.h>
 #include <Corrade/Containers/StringStl.h>
diff --git a/src/Magnum/Math/Test/HalfTest.cpp b/src/Magnum/Math/Test/HalfTest.cpp
index cbeb6ef06..36611c81a 100644
--- a/src/Magnum/Math/Test/HalfTest.cpp
+++ b/src/Magnum/Math/Test/HalfTest.cpp
@@ -24,7 +24,6 @@
 */
 
 #include <cstring>
-#include <algorithm>
 #include <sstream>
 #include <Corrade/Containers/StridedArrayView.h>
 #include <Corrade/TestSuite/Tester.h>
diff --git a/src/Magnum/MeshTools/Test/RemoveDuplicatesTest.cpp b/src/Magnum/MeshTools/Test/RemoveDuplicatesTest.cpp
index df8f57594..293f58b36 100644
--- a/src/Magnum/MeshTools/Test/RemoveDuplicatesTest.cpp
+++ b/src/Magnum/MeshTools/Test/RemoveDuplicatesTest.cpp
@@ -23,8 +23,8 @@
     DEALINGS IN THE SOFTWARE.
 */
 
-#include <algorithm>
-#include <random>
+#include <algorithm> /* std::shuffle() */
+#include <random> /* random device for std::shuffle() */
 #include <sstream>
 #include <Corrade/Containers/GrowableArray.h>
 #include <Corrade/TestSuite/Tester.h>
diff --git a/src/Magnum/SceneGraph/FeatureGroup.hpp b/src/Magnum/SceneGraph/FeatureGroup.hpp
index 58e361b63..84df212d6 100644
--- a/src/Magnum/SceneGraph/FeatureGroup.hpp
+++ b/src/Magnum/SceneGraph/FeatureGroup.hpp
@@ -29,7 +29,7 @@
  * @brief @ref compilation-speedup-hpp "Template implementation" for @ref FeatureGroup.h
  */
 
-#include <algorithm>
+#include <algorithm> /* std::find_if() */
 
 #include "Magnum/SceneGraph/FeatureGroup.h"
 
diff --git a/src/Magnum/SceneGraph/Object.hpp b/src/Magnum/SceneGraph/Object.hpp
index 4a8c2a535..8b6a63a7c 100644
--- a/src/Magnum/SceneGraph/Object.hpp
+++ b/src/Magnum/SceneGraph/Object.hpp
@@ -29,7 +29,7 @@
  * @brief @ref compilation-speedup-hpp "Template implementation" for @ref AbstractObject.h, @ref AbstractTransformation.h and @ref Object.h
  */
 
-#include <algorithm>
+#include <algorithm> /* std::remove_if() */
 #include <stack>
 
 #include "Magnum/SceneGraph/AbstractTransformation.h"
diff --git a/src/Magnum/SceneGraph/Test/CameraTest.cpp b/src/Magnum/SceneGraph/Test/CameraTest.cpp
index ccb9ef575..9f6eaa8cd 100644
--- a/src/Magnum/SceneGraph/Test/CameraTest.cpp
+++ b/src/Magnum/SceneGraph/Test/CameraTest.cpp
@@ -23,7 +23,7 @@
     DEALINGS IN THE SOFTWARE.
 */
 
-#include <algorithm>
+#include <algorithm> /* std::sort() */
 #include <Corrade/TestSuite/Tester.h>
 #include <Corrade/TestSuite/Compare/Container.h>
 
diff --git a/src/Magnum/Text/AbstractFontConverter.cpp b/src/Magnum/Text/AbstractFontConverter.cpp
index b117ab15a..2392c74f0 100644
--- a/src/Magnum/Text/AbstractFontConverter.cpp
+++ b/src/Magnum/Text/AbstractFontConverter.cpp
@@ -25,7 +25,7 @@
 
 #include "AbstractFontConverter.h"
 
-#include <algorithm>
+#include <algorithm> /* std::sort(), std::unique() */
 #include <Corrade/Containers/Array.h>
 #include <Corrade/Containers/EnumSet.hpp>
 #include <Corrade/Utility/Assert.h>
diff --git a/src/Magnum/Trade/MaterialData.cpp b/src/Magnum/Trade/MaterialData.cpp
index 13c6a57eb..5ea2b12fd 100644
--- a/src/Magnum/Trade/MaterialData.cpp
+++ b/src/Magnum/Trade/MaterialData.cpp
@@ -26,7 +26,7 @@
 #include "MaterialData.h"
 
 #include <cstring>
-#include <algorithm>
+#include <algorithm> /* std::sort() */
 #include <Corrade/Containers/EnumSet.hpp>
 #include <Corrade/Containers/GrowableArray.h>
 
diff --git a/src/Magnum/Trade/SceneData.cpp b/src/Magnum/Trade/SceneData.cpp
index 31cb1698e..1415d1cc7 100644
--- a/src/Magnum/Trade/SceneData.cpp
+++ b/src/Magnum/Trade/SceneData.cpp
@@ -25,7 +25,7 @@
 
 #include "SceneData.h"
 
-#include <algorithm>
+#include <algorithm> /* std::lower_bound() */
 #include <Corrade/Containers/EnumSet.hpp>
 #include <Corrade/Containers/GrowableArray.h>
 #include <Corrade/Containers/Optional.h>
diff --git a/src/Magnum/Trade/Test/MaterialDataTest.cpp b/src/Magnum/Trade/Test/MaterialDataTest.cpp
index 6c6996377..797a35a0a 100644
--- a/src/Magnum/Trade/Test/MaterialDataTest.cpp
+++ b/src/Magnum/Trade/Test/MaterialDataTest.cpp
@@ -23,7 +23,7 @@
     DEALINGS IN THE SOFTWARE.
 */
 
-#include <algorithm>
+#include <algorithm> /* std::next_permutation() */
 #include <sstream>
 #include <Corrade/Containers/StaticArray.h>
 #include <Corrade/Containers/StringStl.h>
diff --git a/src/Magnum/Vk/Device.cpp b/src/Magnum/Vk/Device.cpp
index 25c943f31..3016d4205 100644
--- a/src/Magnum/Vk/Device.cpp
+++ b/src/Magnum/Vk/Device.cpp
@@ -26,7 +26,7 @@
 #include "Device.h"
 #include "DeviceCreateInfo.h"
 
-#include <algorithm>
+#include <algorithm> /* std::lower_bound() */
 #include <Corrade/Containers/Optional.h>
 #include <Corrade/Containers/GrowableArray.h>
 #include <Corrade/Containers/StaticArray.h>
diff --git a/src/Magnum/Vk/ExtensionProperties.cpp b/src/Magnum/Vk/ExtensionProperties.cpp
index 8a3cdb1cc..bfe471b07 100644
--- a/src/Magnum/Vk/ExtensionProperties.cpp
+++ b/src/Magnum/Vk/ExtensionProperties.cpp
@@ -25,7 +25,7 @@
 
 #include "ExtensionProperties.h"
 
-#include <algorithm>
+#include <algorithm> /* std::lower_bound() */
 #include <Corrade/Containers/String.h>
 #include <Corrade/Containers/StringView.h>
 #include <Corrade/Utility/Assert.h>
diff --git a/src/Magnum/Vk/Instance.cpp b/src/Magnum/Vk/Instance.cpp
index 7b3c2a768..32f985832 100644
--- a/src/Magnum/Vk/Instance.cpp
+++ b/src/Magnum/Vk/Instance.cpp
@@ -26,7 +26,7 @@
 #include "Instance.h"
 #include "InstanceCreateInfo.h"
 
-#include <algorithm>
+#include <algorithm> /* std::lower_bound() */
 #include <Corrade/Containers/Optional.h>
 #include <Corrade/Containers/GrowableArray.h>
 #include <Corrade/Containers/String.h>
diff --git a/src/Magnum/Vk/LayerProperties.cpp b/src/Magnum/Vk/LayerProperties.cpp
index 585ff6e70..5459b03c4 100644
--- a/src/Magnum/Vk/LayerProperties.cpp
+++ b/src/Magnum/Vk/LayerProperties.cpp
@@ -25,7 +25,7 @@
 
 #include "LayerProperties.h"
 
-#include <algorithm>
+#include <algorithm> /* std::sort() */
 #include <Corrade/Containers/StringView.h>
 
 #include "Magnum/Vk/Assert.h"
diff --git a/src/MagnumPlugins/MagnumFontConverter/MagnumFontConverter.cpp b/src/MagnumPlugins/MagnumFontConverter/MagnumFontConverter.cpp
index 5f520433a..2558f6201 100644
--- a/src/MagnumPlugins/MagnumFontConverter/MagnumFontConverter.cpp
+++ b/src/MagnumPlugins/MagnumFontConverter/MagnumFontConverter.cpp
@@ -25,7 +25,7 @@
 
 #include "MagnumFontConverter.h"
 
-#include <algorithm>
+#include <algorithm> /* std::sort() */
 #include <sstream>
 #include <Corrade/Containers/Array.h>
 #include <Corrade/Utility/Configuration.h>