update

math/power_of_two.cpp

@@ -19,12 +19,11 @@
  * approach.
  *
  * @author [Neha Hasija](https://github.com/neha-hasija17)
+ * @author [Rijul.S](https://github.com/Rijul24)
  */
 
-//Added self implementation Cases Contribution
-
-#include <iostream> /// for std::cout
-#include <cassert> ///for assert
+#include <iostream> /// for IO operations
+#include <cassert> /// for assert
 
 
 /**
@@ -33,25 +32,23 @@
  */
 namespace math {
 /**
- * @brief Function to test above algorithm
- * @param n description
- * @returns int
+ * @brief This function finds whether a number is power of 2 or not
+ * @param n value for which we want to check
+ * prints the result, as "Yes, the number n is a power of 2" or
+ * "No, the number is not a power of 2" without quotes
+ * @returns 1 if `n` IS the power of 2
+ * @returns 0 if n is NOT a power of 2
  */
-
 int power_of_two(int n) {
- /**
- * This function finds whether a number is power of 2 or not
- * @param n value for which we want to check
- * returns 1 if n is power of 2
- * returns 0 if n is not a power of 2
- */
  /// result stores the
  /// bitwise and of n and n-1
  int result = n & (n - 1);
 
- if(result == 0) return 1 ; //yes it is
- else return 0; // no it is not
-
+ if (result == 0) {
+ return 1;
+ } else {
+ return 0;
+ }
 }
 } // namespace math
 
@@ -60,54 +57,50 @@ int power_of_two(int n) {
  * @returns void
  */
 static void test() {
-
- std::cout << "First case testing.. \n"; // for n = 32 return 1
+ std::cout << "First case testing... \n"; // for n = 32 return 1
  assert(math::power_of_two(32) == 1);
- std::cout << "Passed\n";
+ std::cout << "\nPassed!\n";
 
- std::cout << "Second case testing.. \n"; // for n = 5 return 0
+ std::cout << "Second case testing... \n"; // for n = 5 return 0
  assert(math::power_of_two(5) == 0);
- std::cout << "Passed\n";
+ std::cout << "\nPassed!\n";
 
- std::cout << "Third case testing.. \n"; // for n = 232 return 0
+ std::cout << "Third case testing... \n"; // for n = 232 return 0
  assert(math::power_of_two(232) == 0);
- std::cout << "Passed\n";
+ std::cout << "\nPassed!\n";
 
- std::cout << "All test cases passed! \n";
+ std::cout << "\nAll test cases have successfully passed!\n";
 }
 
 /**
- * @brief take user input
+ * @brief Take user input in the test cases (optional; currently commented)
  * @returns void
  */
-
 void user_input_test() {
-
  int n = 0; // input from user
 
  std::cout << "Enter a number " << std::endl;
  std::cin >> n; 
 
  /// function call with @param n
  int result = math::power_of_two(n);
- if(result == 1) std::cout << "Yes, the number " << n << " is a power of 2 \n"; 
- else std::cout << "No, the number " << n << " is not a power of 2\n";
-
+ if (result == 1) {
+ std::cout << "Yes, the number " << n << " is a power of 2\n";
+ }
+ else { 
+ std::cout << "No, the number " << n << " is not a power of 2\n";
+ }
 }
 
-
 /**
  * @brief Main function
  * @returns 0 on exit
  */
-
 int main() {
-
- test(); //run self-test implementations
+ test(); // run self-test implementations
 
- //UN - COMMENT BELOW LINE TO TAKE USER INPUTS
- // user_input_test(); 
+ // uncomment the line below to take user inputs
+ //user_input_test();
 
-
  return 0;
 }