From 18e8625d98dfc6e202ff935064a44cbc4cd96890 Mon Sep 17 00:00:00 2001
From: Ritika Mukherjee <40390051+ritikaa17@users.noreply.github.com>
Date: Thu, 27 Jan 2022 20:36:44 +0530
Subject: [PATCH] docs: documentation improvements in
 `search/linear_search.cpp` (#1641)

* Update linear_search.cpp

Update readability of code

* update

* feat: add self-test implementations

* feat: add interactive/self-test modes

Co-authored-by: David Leal <halfpacho@gmail.com>
Co-authored-by: Abhinn Mishra <49574460+mishraabhinn@users.noreply.github.com>
---
 search/linear_search.cpp | 104 ++++++++++++++++++++++++++++++---------
 1 file changed, 81 insertions(+), 23 deletions(-)

diff --git a/search/linear_search.cpp b/search/linear_search.cpp
index 142506951..e9f24bc35 100644
--- a/search/linear_search.cpp
+++ b/search/linear_search.cpp
@@ -2,52 +2,110 @@
  * \file
  * \brief [Linear search
  * algorithm](https://en.wikipedia.org/wiki/Linear_search)
+ *
+ * @author Unknown author
+ * @author [Ritika Mukherjee](https://github.com/ritikaa17)
  */
-#include <iostream>
+
+#include <iostream>   /// for IO operations
+#include <cassert>    /// for assert
 
 /**
- * Algorithm implementation
+ * \brief [Algorithm implementation for linear search]
  * \param [in] array array to search in
  * \param [in] size length of array
  * \param [in] key key value to search for
  * \returns index where the key-value occurs in the array
  * \returns -1 if key-value not found
  */
-int LinearSearch(int *array, int size, int key) {
-    for (int i = 0; i < size; ++i) {
+int LinearSearch(int *array, int size, int key) 
+{
+    for (int i = 0; i < size; ++i) 
+    {
         if (array[i] == key) {
             return i;
         }
     }
 
+    /* We reach here only in case element is not present in array, return an invalid entry in that case*/
     return -1;
 }
 
-/** main function */
-int main() {
-    int size;
-    std::cout << "\nEnter the size of the Array : ";
-    std::cin >> size;
-
+/**
+ * @brief Self-test implementations
+ * @returns void
+ */
+static void tests() {
+    int size = 4;
     int *array = new int[size];
-    int key;
-
-    // Input array
-    std::cout << "\nEnter the Array of " << size << " numbers : ";
     for (int i = 0; i < size; i++) {
-        std::cin >> array[i];
+        array[i] = i;
     }
 
-    std::cout << "\nEnter the number to be searched : ";
-    std::cin >> key;
+    assert(LinearSearch(array, size, 0) == 0);
+    assert(LinearSearch(array, size, 1) == 1);
+    assert(LinearSearch(array, size, 2) == 2);
 
-    int index = LinearSearch(array, size, key);
-    if (index != -1) {
-        std::cout << "\nNumber found at index : " << index;
-    } else {
-        std::cout << "\nNot found";
+    size = 6;
+    for (int i = 0; i < size; i++) {
+        array[i] = i;
     }
 
-    delete[] array;
+    assert(LinearSearch(array, size, 3) == 3);
+    assert(LinearSearch(array, size, 1) == 1);
+    assert(LinearSearch(array, size, 5) == 5);
+
+    std::cout << "All tests have successfully passed!\n";
+    delete[] array; // free memory up
+}
+
+/**
+ * @brief Main function
+ * @returns 0 on exit
+ */
+int main() {
+    int mode = 0;
+
+    std::cout << "Choose mode\n";
+    std::cout << "Self-test mode (1), interactive mode (2): ";
+
+    std::cin >> mode;
+
+    if (mode == 2) {
+        int size = 0;
+        std::cout << "\nEnter the size of the array: ";
+        std::cin >> size;
+
+        while ((size <= 1) || (size >= 30)) {
+            std::cout << "Size cannot be less than zero. Please choose another value: ";
+            std::cin >> size;
+        }
+
+        int *array = new int[size];
+        int key = 0;
+
+        // Input for the array elements
+        std::cout << "Enter the array of " << size << " numbers: ";
+        for (int i = 0; i < size; i++) {
+            std::cin >> array[i];
+        }
+
+        std::cout << "\nEnter the number to be searched: ";
+        std::cin >> key;
+
+        int index = LinearSearch(array, size, key);
+        if (index != -1)
+        {
+            std::cout << "Number found at index: " << index << "\n";
+        } 
+        else
+        {
+            std::cout << "Array element not found";
+        }
+        delete[] array;
+    }
+    else {
+        tests();  // run self-test implementations
+    }
     return 0;
 }