Merge pull request #1 from sir-gon/feature/euler001

[Hacker Rank]: Project Euler #1: Multiples of 3 and 5 solved ✓

Author: sir-gon

docs/hackerrank/projecteuler/euler001.md

@@ -0,0 +1,49 @@
+# [Multiples of 3 and 5](https://www.hackerrank.com/contests/projecteuler/challenges/euler001)
+
+- Difficulty: #easy
+- Category: #ProjectEuler+
+
+If we list all the natural numbers below $ 10 $ that are multiples of
+ $ 3 $ or $ 5 $, we get $ 3, 5, 6 $ and $ 9 $.
+ The sum of these multiples
+ is $ 23 $.
+
+Find the sum of all the multiples of $ 3 $ or $ 5 $ below $ N $.
+
+## Input Format
+
+First line contains $ T $ that denotes the number of test cases.
+This is followed by $ T $ lines, each containing an integer, $ N $.
+
+## Constraints
+
+- 1 $ \leq T \leq 10^5 $
+- 1 $ \leq N \leq 10^9 $
+
+## Output Format
+
+For each test case, print an integer that denotes the sum of all the multiples
+of $ 3 $ or $ 5 $ below $ N $.
+
+## Sample Input 0
+
+```text
+2
+10
+100
+```
+
+## Sample Output 0
+
+```text
+23
+2318
+```
+
+## Explanation 0
+
+For $ N = 10 $, if we list all the natural numbers below $ 10 $ that are
+ multiples of $ 3 $ or $ 5 $, we get $ 3, 5, 6 $ and $ 9 $.
+  The sum of these multiples is $ 23 $.
+
+Similarly for $ N = 100 $, we get $ 2318 $.

src/lib/exercises/include/exercises/hackerrank/projecteuler/euler001.h

@@ -0,0 +1,11 @@
+#pragma once
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+unsigned long HACKERRANK_PROJECTEULER_euler001(int a, int b, int n);
+
+#ifdef __cplusplus
+} // extern "C"
+#endif

src/lib/exercises/src/hackerrank/projecteuler/euler001.c

@@ -0,0 +1,47 @@
+#include <exercises/hackerrank/projecteuler/euler001.h>
+
+/**
+ * @link Problem definition [[docs/hackerrank/projecteuler/euler001.md]]
+ */
+
+unsigned long HACKERRANK_PROJECTEULER_min(unsigned long a, unsigned long b) {
+  if (a > b) {
+    return b;
+  }
+
+  return a;
+}
+
+// Function to return gcd of a and b
+unsigned long HACKERRANK_PROJECTEULER_gcd(unsigned long a, unsigned long b) {
+  // Find Minimum of a and b
+  unsigned long result = HACKERRANK_PROJECTEULER_min(a, b);
+  while (result > 0) {
+    if (a % result == 0 && b % result == 0) {
+      break;
+    }
+    result--;
+  }
+
+  // Return gcd of a and b
+  return result;
+}
+
+// Function to find sum of Arithmetic Progression series
+unsigned long HACKERRANK_PROJECTEULER_sum_of_arithmetic_progression(unsigned long n, unsigned long d) {
+  // Number of terms
+  n = n / d;
+  return n * (1 + n) * d / 2;
+}
+
+// Function to find the sum of all multiples of a and b below n
+unsigned long HACKERRANK_PROJECTEULER_euler001(int a, int b, int n) {
+  // Since, we need the sum of multiples less than N
+  n = n - 1;
+
+  unsigned long lcm = (a * b) / HACKERRANK_PROJECTEULER_gcd(a, b);
+
+  return HACKERRANK_PROJECTEULER_sum_of_arithmetic_progression(n, a) +
+         HACKERRANK_PROJECTEULER_sum_of_arithmetic_progression(n, b) -
+         HACKERRANK_PROJECTEULER_sum_of_arithmetic_progression(n, lcm);
+}

src/tests/unit/lib/hackerrank/projecteuler/euler001.test.cpp

@@ -0,0 +1,29 @@
+#include <catch2/catch_test_macros.hpp>
+
+#include <exercises/hackerrank/projecteuler/euler001.h>
+#include <iostream>
+#include <vector>
+
+#include <filesystem>
+#include <fstream>
+#include <nlohmann/json.hpp>
+using json = nlohmann::json;
+
+TEST_CASE("euler001 JSON Test Cases",
+          "[hackerrank] [jsontestcase] [projecteuler]") {
+  std::filesystem::path cwd = std::filesystem::current_path();
+  std::string path =
+      cwd.string() +
+      "/unit/lib/hackerrank/projecteuler/euler001.testcases.json";
+
+  INFO("euler001 JSON test cases FILE: " << path);
+
+  std::ifstream f(path);
+  json data = json::parse(f);
+
+  for (auto testcase : data) {
+    int result = HACKERRANK_PROJECTEULER_euler001(testcase["a"], testcase["b"],
+                                                  testcase["n"]);
+    CHECK(result == testcase["expected"]);
+  }
+}

src/tests/unit/lib/hackerrank/projecteuler/euler001.testcases.json

@@ -0,0 +1,6 @@
+[
+  { "a": 3, "b": 5, "n": 10, "expected": 23 },
+  { "a": 5, "b": 3, "n": 10, "expected": 23 },
+  { "a": 3, "b": 5, "n": 100, "expected": 2318 },
+  { "a": 3, "b": 5, "n": 1000, "expected": 233168 }
+]