From 00c8c0bfdbc4b1c7b7beed29c281c45e66861731 Mon Sep 17 00:00:00 2001
From: Krishna Vedala <krishna.vedala@ieee.org>
Date: Thu, 28 May 2020 12:55:06 -0400
Subject: [PATCH] document primality test

---
 others/primality_test.cpp | 60 +++++++++++++++++++++++----------------
 1 file changed, 35 insertions(+), 25 deletions(-)

diff --git a/others/primality_test.cpp b/others/primality_test.cpp
index ce8fc1706..faec6589c 100644
--- a/others/primality_test.cpp
+++ b/others/primality_test.cpp
@@ -1,32 +1,42 @@
+/**
+ * @file
+ * @brief [Primality test](https://en.wikipedia.org/wiki/Primality_test)
+ * implementation.
+ *
+ * A simple and efficient implementation of a function to test if a number is
+ * prime, based on the fact that
+ * > Every Prime number, except 2 and 3, are of the form \f$6k\pm1\f$ for
+ * > integer values of k.
+ * This gives a 3x speed improvement.
+ */
 #include <iostream>
-using namespace std;
 
-//A simple and efficient implementation of a function to test if a number is prime, based on the fact that
-//Every Prime number, except 2 and 3 are of the form 6*k+1 or 6*k-1 for integer values of k.
+/** Check if a number is prime
+ * \param[in] number number to check
+ * \returns true if prime else false
+ */
+bool IsPrime(int number) {
+    if (((!(number & 1)) && number != 2) || (number < 2) ||
+        (number % 3 == 0 && number != 3))
+        return false;
 
-bool IsPrime(int number)
-{
-	if (((!(number & 1)) && number != 2) || (number < 2) || (number % 3 == 0 && number != 3))
-		return false;
-
-	for (int k = 1; 36 * k * k - 12 * k < number; ++k)
-	{
-		if ((number % (6 * k + 1) == 0) || (number % (6 * k - 1) == 0))
-			return false;
-	}
-	return true;
+    for (int k = 1; 36 * k * k - 12 * k < number; ++k) {
+        if ((number % (6 * k + 1) == 0) || (number % (6 * k - 1) == 0))
+            return false;
+    }
+    return true;
 }
 
-int main()
-{
-	//Main Function
-	cout << "Enter the value of n to check if Prime\n";
-	int n;
-	cin >> n;
-	if (IsPrime(n))
-		cout << n << " is Prime" << endl;
-	else
-		cout << n << " is not Prime" << endl;
+/** main function */
+int main() {
+    // Main Function
+    std::cout << "Enter the value of n to check if Prime\n";
+    int n;
+    std::cin >> n;
+    if (IsPrime(n))
+        std::cout << n << " is Prime" << std::endl;
+    else
+        std::cout << n << " is not Prime" << std::endl;
 
-	return 0;
+    return 0;
 }