summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLenny Maiorani <lenny@colorado.edu>2020-11-16 18:27:14 -0700
committerAndreas Kling <kling@serenityos.org>2020-11-21 19:25:14 +0100
commit6e7e16a7edb7d10354c1e4ef44740d800b20cdd5 (patch)
tree2e8684c20bade1b5a0355ea144cc57c7c543eee2
parent446a19ba51471f123a3133edba8bcf80787b3403 (diff)
downloadserenity-6e7e16a7edb7d10354c1e4ef44740d800b20cdd5.zip
AK: Implement generic all_of algorithm
Problem: - Raw loops are often written to validate that all values in a container meet a predicate, but raw loops are not as expressive as functions implementing well-named algorithms and are error-prone. Solution: - Implement a very generic form of `all_of`.
-rw-r--r--AK/AllOf.h41
-rw-r--r--AK/Tests/TestAllOf.cpp43
2 files changed, 84 insertions, 0 deletions
diff --git a/AK/AllOf.h b/AK/AllOf.h
new file mode 100644
index 0000000000..8e2f94df1c
--- /dev/null
+++ b/AK/AllOf.h
@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2020, the SerenityOS developers.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+namespace AK {
+
+constexpr bool all_of(const auto& begin, const auto& end, const auto& predicate)
+{
+ for (auto iter = begin; iter != end; ++iter) {
+ if (!predicate(*iter)) {
+ return false;
+ }
+ }
+ return true;
+}
+
+}
diff --git a/AK/Tests/TestAllOf.cpp b/AK/Tests/TestAllOf.cpp
new file mode 100644
index 0000000000..2557261d1a
--- /dev/null
+++ b/AK/Tests/TestAllOf.cpp
@@ -0,0 +1,43 @@
+/*
+ * Copyright (c) 2020, the SerenityOS developers.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include <AK/TestSuite.h>
+
+#include <AK/AllOf.h>
+#include <AK/Array.h>
+
+TEST_CASE(should_determine_if_predicate_applies_to_all_elements_in_container)
+{
+ constexpr AK::Array<int, 10> a {};
+
+ static_assert(AK::all_of(a.begin(), a.end(), [](auto elem) { return elem == 0; }));
+ static_assert(!AK::all_of(a.begin(), a.end(), [](auto elem) { return elem == 1; }));
+
+ EXPECT(AK::all_of(a.begin(), a.end(), [](auto elem) { return elem == 0; }));
+ EXPECT(!AK::all_of(a.begin(), a.end(), [](auto elem) { return elem == 1; }));
+}
+
+TEST_MAIN(AllOf)