Document what each #include <algorithm> is for.

Or remove it, if not for anything anymore.
4 years ago · 8057051d9a
20 changed files with 20 additions and 21 deletions
--- 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"
--- 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>
--- 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>
--- 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>
--- 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>
--- 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>
--- 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>
--- 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>
--- 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"

--- 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"
--- 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>

--- 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>
--- 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>

--- 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>
--- 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>
--- 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>
--- 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>
--- 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>
--- 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"
--- 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>