From 5e3307620c8a092a982610fa8f7ced49c7ce06f5 Mon Sep 17 00:00:00 2001
From: Neeraj C <neeraj.cnambiar@gmail.com>
Date: Wed, 24 Jun 2020 20:46:23 +0530
Subject: [PATCH] feat: create math/armstrong_number.cpp

---
 math/armstrong_number.cpp | 77 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 77 insertions(+)
 create mode 100644 math/armstrong_number.cpp

diff --git a/math/armstrong_number.cpp b/math/armstrong_number.cpp
new file mode 100644
index 000000000..0b5f01cd1
--- /dev/null
+++ b/math/armstrong_number.cpp
@@ -0,0 +1,77 @@
+/**
+ * @file
+ * \brief A C++ program to check whether a number is armstrong number or not.
+ * 
+ * \details
+ * Armstrong number or [Narcissistic number](https://en.wikipedia.org/wiki/Narcissistic_number) 
+ * is a number that is the sum of its own digits raised to the power of the number of digits.
+ * @author iamnambiar
+*/
+#include<cassert>
+#include<iostream>
+#include<cmath>
+
+/**
+ * Function to calculate the total number of digits in the number.
+ * @param num Number
+ * @return Total number of digits.
+ */
+int number_of_digits(int num) {
+    int total_digits = 0;
+    while (num > 0) {
+        num = num / 10;
+        ++total_digits;
+    }
+    return total_digits;
+}
+
+/**
+ * Function to check whether the number is armstrong number or not.
+ * @param num Number
+ * @return `true` if the number is armstrong.
+ * @return `false` if the number is not armstrong.
+ */
+bool is_armstrong(int number) {
+    // If the number is less than 0, then it is not a armstrong number.
+    if (number < 0) {
+        return false;
+    }
+    int sum = 0;
+    int temp = number;
+    // Finding the total number of digits in the number
+    int total_digits = number_of_digits(number);
+    while (temp > 0) {
+        int rem = temp % 10;
+        // Finding each digit raised to the power total digit and add it to the total sum
+        sum = sum + pow(rem, total_digits);
+        temp = temp / 10;
+    }
+    return number == sum;
+}
+
+/**
+ * Function for testing the is_amicable() with 
+ * all the test cases.
+ */
+void test() {
+    // is_armstrong(370) returns true.
+    assert(is_armstrong(370) == true);
+    // is_armstrong(225) returns false.
+    assert(is_armstrong(225) == false);
+    // is_armstrong(-23) returns false.
+    assert(is_armstrong(-23) == false);
+    // is_armstrong(153) returns true.
+    assert(is_armstrong(153) == true);
+    // is_armstrong(0) returns true.
+    assert(is_armstrong(0) == true);
+    // is_armstrong(12) returns false.
+    assert(is_armstrong(12) == false);
+}
+
+/**
+ * Main Function
+*/
+int main() {
+    test();
+    return 0;
+}