backup/C-Plus-Plus
1
0
Fork 0
mirror of https://github.com/TheAlgorithms/C-Plus-Plus.git synced 2026-05-09 15:43:48 +08:00
Code Issues Projects Releases Wiki Activity

one liner docs added

Browse Source
This commit is contained in:
foo290
2021-07-05 07:27:05 +05:30
parent 0c8d149fc6
commit 95b362f3b6
1 changed files with 82 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
search/sublist_search.cpp
View File

@@ -37,27 +37,27 @@ namespace search {
* Search](https://www.geeksforgeeks.org/sublist-search-search-a-linked-list-in-another-list) * Search](https://www.geeksforgeeks.org/sublist-search-search-a-linked-list-in-another-list)
* implementation * implementation
*/ */
namespace sublist_search { namespace sublist_search {
/** /**
* @brief A Node structure representing a single link Node in a linked list * @brief A Node structure representing a single link Node in a linked list
*/ */
struct Node { struct Node {
uint32_t data = 0; uint32_t data = 0; // The key/value of the node
Node *next{}; Node *next{}; // Pointer to the next node
}; };
/** /**
* @brief A simple function to print the linked list * @brief A simple function to print the linked list
* @param start The head of the linked list * @param start The head of the linked list
* @returns void * @returns void
*/ */
void printLinkedList(Node *start) { void printLinkedList(Node *start) {
while (start != nullptr) { while (start != nullptr) {
std::cout << "->" << start->data; std::cout << "->" << start->data;
start = start->next; start = start->next;
} }
std::cout << std::endl; std::cout << std::endl;
} }
/** /**
* @brief Makes a dummy linked list for testing. * @brief Makes a dummy linked list for testing.
@@ -65,7 +65,7 @@ void printLinkedList(Node *start) {
* stored in nodes of linked list. * stored in nodes of linked list.
* @returns Node* A head pointer to the linked list. * @returns Node* A head pointer to the linked list.
*/ */
Node *makeLinkedList(const std::vector<uint64_t> &data) { Node *makeLinkedList(const std::vector<uint64_t> &data) {
Node *head = nullptr; Node *head = nullptr;
Node *tail = nullptr; Node *tail = nullptr;
for (int i : data) { for (int i : data) {
@@ -81,7 +81,7 @@ Node *makeLinkedList(const std::vector<uint64_t> &data) {
} }
} }
return head; return head;
} }
/** /**
* @brief Main searching function * @brief Main searching function
@@ -90,7 +90,7 @@ Node *makeLinkedList(const std::vector<uint64_t> &data) {
* @returns true if the sublist is found * @returns true if the sublist is found
* @returns false if the sublist is NOT found * @returns false if the sublist is NOT found
*/ */
bool sublistSearch(Node *sublist, Node *mainList) { bool sublistSearch(Node *sublist, Node *mainList) {
if (sublist == nullptr || mainList == nullptr) { if (sublist == nullptr || mainList == nullptr) {
return false; return false;
} }
@@ -131,16 +131,16 @@ bool sublistSearch(Node *sublist, Node *mainList) {
// If the main list is exhausted, means sublist does not found, return false // If the main list is exhausted, means sublist does not found, return false
return false; return false;
} }
} // namespace sublist_search } // namespace sublist_search
} // namespace search } // namespace search
/** /**
* @brief class encapsulating the necessary test cases * @brief class encapsulating the necessary test cases
*/ */
class TestCases { class TestCases {
private: private:
/** /**
* @brief A function to print given message on console. * @brief A function to print given message on console.
* @tparam T Type of the given message. * @tparam T Type of the given message.
@@ -152,7 +152,7 @@ class TestCases {
std::cout << "[TESTS] : ---> " << msg << std::endl; std::cout << "[TESTS] : ---> " << msg << std::endl;
} }
public: public:
/** /**
* @brief Executes test cases * @brief Executes test cases
* @returns void * @returns void