mirror of
https://hub.njuu.cf/TheAlgorithms/C-Plus-Plus.git
synced 2023-10-11 13:05:55 +08:00
clang-format and clang-tidy fixes for be0160b4
This commit is contained in:
github-actions
parent
be0160b415
commit
0c8d149fc6
@ -37,128 +37,126 @@ namespace search {
|
||||
* Search](https://www.geeksforgeeks.org/sublist-search-search-a-linked-list-in-another-list)
|
||||
* implementation
|
||||
*/
|
||||
namespace sublist_search {
|
||||
/**
|
||||
* @brief A Node structure representing a single link Node in a linked list
|
||||
*/
|
||||
struct Node {
|
||||
uint32_t data = 0;
|
||||
Node *next{};
|
||||
};
|
||||
namespace sublist_search {
|
||||
/**
|
||||
* @brief A Node structure representing a single link Node in a linked list
|
||||
*/
|
||||
struct Node {
|
||||
uint32_t data = 0;
|
||||
Node *next{};
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief A simple function to print the linked list
|
||||
* @param start The head of the linked list
|
||||
* @returns void
|
||||
*/
|
||||
void printLinkedList(Node *start) {
|
||||
while (start != nullptr) {
|
||||
std::cout << "->" << start->data;
|
||||
start = start->next;
|
||||
}
|
||||
std::cout << std::endl;
|
||||
/**
|
||||
* @brief A simple function to print the linked list
|
||||
* @param start The head of the linked list
|
||||
* @returns void
|
||||
*/
|
||||
void printLinkedList(Node *start) {
|
||||
while (start != nullptr) {
|
||||
std::cout << "->" << start->data;
|
||||
start = start->next;
|
||||
}
|
||||
std::cout << std::endl;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Makes a dummy linked list for testing.
|
||||
* @param data A vector of "int" containing the data that is supposed to be
|
||||
* stored in nodes of linked list.
|
||||
* @returns Node* A head pointer to the linked list.
|
||||
*/
|
||||
Node *makeLinkedList(const std::vector<uint64_t> &data) {
|
||||
Node *head = nullptr;
|
||||
Node *tail = nullptr;
|
||||
for (int i : data) {
|
||||
Node *node = new Node;
|
||||
node->data = i;
|
||||
node->next = nullptr;
|
||||
if (head == nullptr) {
|
||||
head = node;
|
||||
tail = node;
|
||||
} else {
|
||||
tail->next = node;
|
||||
tail = tail->next;
|
||||
}
|
||||
}
|
||||
return head;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Makes a dummy linked list for testing.
|
||||
* @param data A vector of "int" containing the data that is supposed to be
|
||||
* stored in nodes of linked list.
|
||||
* @returns Node* A head pointer to the linked list.
|
||||
*/
|
||||
Node *makeLinkedList(const std::vector<uint64_t> &data) {
|
||||
Node *head = nullptr;
|
||||
Node *tail = nullptr;
|
||||
for (int i : data) {
|
||||
Node *node = new Node;
|
||||
node->data = i;
|
||||
node->next = nullptr;
|
||||
if (head == nullptr) {
|
||||
head = node;
|
||||
tail = node;
|
||||
} else {
|
||||
tail->next = node;
|
||||
tail = tail->next;
|
||||
}
|
||||
}
|
||||
return head;
|
||||
}
|
||||
/**
|
||||
* @brief Main searching function
|
||||
* @param sublist A linked list which is supposed to be searched in mainList.
|
||||
* @param mainList A linked list in which sublist will be searched.
|
||||
* @returns true if the sublist is found
|
||||
* @returns false if the sublist is NOT found
|
||||
*/
|
||||
bool sublistSearch(Node *sublist, Node *mainList) {
|
||||
if (sublist == nullptr || mainList == nullptr) {
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Main searching function
|
||||
* @param sublist A linked list which is supposed to be searched in mainList.
|
||||
* @param mainList A linked list in which sublist will be searched.
|
||||
* @returns true if the sublist is found
|
||||
* @returns false if the sublist is NOT found
|
||||
*/
|
||||
bool sublistSearch(Node *sublist, Node *mainList) {
|
||||
if (sublist == nullptr || mainList == nullptr) {
|
||||
Node *target_ptr = sublist;
|
||||
|
||||
while (mainList != nullptr) {
|
||||
Node *main_ptr = mainList; // Initialize main pointer to the current
|
||||
// node of main list.
|
||||
|
||||
while (target_ptr != nullptr) {
|
||||
if (main_ptr == nullptr) {
|
||||
return false;
|
||||
|
||||
} else if (main_ptr->data == target_ptr->data) {
|
||||
// If the data of target node and main node is equal then move
|
||||
// to the next node of both lists.
|
||||
target_ptr = target_ptr->next;
|
||||
main_ptr = main_ptr->next;
|
||||
|
||||
} else {
|
||||
break;
|
||||
}
|
||||
|
||||
Node *target_ptr = sublist;
|
||||
|
||||
while (mainList != nullptr) {
|
||||
Node *main_ptr = mainList; // Initialize main pointer to the current
|
||||
// node of main list.
|
||||
|
||||
while (target_ptr != nullptr) {
|
||||
if (main_ptr == nullptr) {
|
||||
return false;
|
||||
|
||||
} else if (main_ptr->data == target_ptr->data) {
|
||||
// If the data of target node and main node is equal then move
|
||||
// to the next node of both lists.
|
||||
target_ptr = target_ptr->next;
|
||||
main_ptr = main_ptr->next;
|
||||
|
||||
} else {
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (target_ptr == nullptr) {
|
||||
// Is target pointer becomes null that means the target list is been
|
||||
// traversed without returning false. Which means the sublist has
|
||||
// been found and return ture.
|
||||
return true;
|
||||
}
|
||||
|
||||
target_ptr = sublist; // set the target pointer again to stating point
|
||||
// of target list.
|
||||
mainList = mainList->next; // set the main pointer to the next element
|
||||
// of the main list and repeat the algo.
|
||||
}
|
||||
|
||||
// If the main list is exhausted, means sublist does not found, return false
|
||||
return false;
|
||||
}
|
||||
|
||||
} // namespace sublist_search
|
||||
} // namespace search
|
||||
if (target_ptr == nullptr) {
|
||||
// Is target pointer becomes null that means the target list is been
|
||||
// traversed without returning false. Which means the sublist has
|
||||
// been found and return ture.
|
||||
return true;
|
||||
}
|
||||
|
||||
target_ptr = sublist; // set the target pointer again to stating point
|
||||
// of target list.
|
||||
mainList = mainList->next; // set the main pointer to the next element
|
||||
// of the main list and repeat the algo.
|
||||
}
|
||||
|
||||
// If the main list is exhausted, means sublist does not found, return false
|
||||
return false;
|
||||
}
|
||||
|
||||
} // namespace sublist_search
|
||||
} // namespace search
|
||||
|
||||
/**
|
||||
* @brief class encapsulating the necessary test cases
|
||||
*/
|
||||
class TestCases {
|
||||
private:
|
||||
private:
|
||||
/**
|
||||
* @brief A function to print given message on console.
|
||||
* @tparam T Type of the given message.
|
||||
* @returns void
|
||||
* */
|
||||
template<typename T>
|
||||
* @brief A function to print given message on console.
|
||||
* @tparam T Type of the given message.
|
||||
* @returns void
|
||||
* */
|
||||
template <typename T>
|
||||
void log(T msg) {
|
||||
// It's just to avoid writing cout and endl
|
||||
std::cout << "[TESTS] : ---> " << msg << std::endl;
|
||||
}
|
||||
|
||||
public:
|
||||
public:
|
||||
/**
|
||||
* @brief Executes test cases
|
||||
* @returns void
|
||||
* */
|
||||
* @brief Executes test cases
|
||||
* @returns void
|
||||
* */
|
||||
void runTests() {
|
||||
log("Running Tests...");
|
||||
|
||||
@ -171,13 +169,14 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief A test case contains edge case, Only contains one element.
|
||||
* @returns void
|
||||
* */
|
||||
* @brief A test case contains edge case, Only contains one element.
|
||||
* @returns void
|
||||
* */
|
||||
void testCase_1() {
|
||||
const bool expectedOutput = true;
|
||||
|
||||
log("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~");
|
||||
log("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
|
||||
"~");
|
||||
log("This is test case 1 for sublist search Algorithm : ");
|
||||
log("Description:");
|
||||
log(" EDGE CASE : Only contains one element");
|
||||
@ -186,28 +185,30 @@ public:
|
||||
std::vector<uint64_t> mainlistData = {2, 5, 6, 7, 8};
|
||||
|
||||
search::sublist_search::Node *sublistLL =
|
||||
search::sublist_search::makeLinkedList(sublistData);
|
||||
search::sublist_search::makeLinkedList(sublistData);
|
||||
search::sublist_search::Node *mainlistLL =
|
||||
search::sublist_search::makeLinkedList(mainlistData);
|
||||
search::sublist_search::makeLinkedList(mainlistData);
|
||||
|
||||
bool exists =
|
||||
search::sublist_search::sublistSearch(sublistLL, mainlistLL);
|
||||
search::sublist_search::sublistSearch(sublistLL, mainlistLL);
|
||||
|
||||
log("Checking assert expression...");
|
||||
assert(exists == expectedOutput);
|
||||
log("Assertion check passed!");
|
||||
|
||||
log("[PASS] : TEST CASE 1 PASS!");
|
||||
log("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~");
|
||||
log("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
|
||||
"~");
|
||||
|
||||
delete (sublistLL);
|
||||
delete (mainlistLL);
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief A test case which contains main list of 100 elements and sublist of 20.
|
||||
* @returns void
|
||||
* */
|
||||
* @brief A test case which contains main list of 100 elements and sublist
|
||||
* of 20.
|
||||
* @returns void
|
||||
* */
|
||||
void testCase_2() {
|
||||
const bool expectedOutput = true;
|
||||
|
||||
@ -233,12 +234,12 @@ public:
|
||||
}
|
||||
|
||||
search::sublist_search::Node *sublistLL =
|
||||
search::sublist_search::makeLinkedList(sublistData);
|
||||
search::sublist_search::makeLinkedList(sublistData);
|
||||
search::sublist_search::Node *mainlistLL =
|
||||
search::sublist_search::makeLinkedList(mainlistData);
|
||||
search::sublist_search::makeLinkedList(mainlistData);
|
||||
|
||||
bool exists =
|
||||
search::sublist_search::sublistSearch(sublistLL, mainlistLL);
|
||||
search::sublist_search::sublistSearch(sublistLL, mainlistLL);
|
||||
|
||||
log("Checking assert expression...");
|
||||
assert(exists == expectedOutput);
|
||||
@ -250,9 +251,10 @@ public:
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief A test case which contains main list of 50 elements and sublist of 20.
|
||||
* @returns void
|
||||
* */
|
||||
* @brief A test case which contains main list of 50 elements and sublist
|
||||
* of 20.
|
||||
* @returns void
|
||||
* */
|
||||
void testCase_3() {
|
||||
const bool expectedOutput = false;
|
||||
|
||||
@ -276,12 +278,12 @@ public:
|
||||
}
|
||||
|
||||
search::sublist_search::Node *sublistLL =
|
||||
search::sublist_search::makeLinkedList(sublistData);
|
||||
search::sublist_search::makeLinkedList(sublistData);
|
||||
search::sublist_search::Node *mainlistLL =
|
||||
search::sublist_search::makeLinkedList(mainlistData);
|
||||
search::sublist_search::makeLinkedList(mainlistData);
|
||||
|
||||
bool exists =
|
||||
search::sublist_search::sublistSearch(sublistLL, mainlistLL);
|
||||
search::sublist_search::sublistSearch(sublistLL, mainlistLL);
|
||||
|
||||
log("Checking assert expression...");
|
||||
assert(exists == expectedOutput);
|
||||
@ -314,9 +316,9 @@ int main(int argc, char *argv[]) {
|
||||
std::vector<uint64_t> mainlistData = {2, 5, 6, 7, 8};
|
||||
std::vector<uint64_t> sublistData = {6, 8};
|
||||
search::sublist_search::Node *mainlistLL =
|
||||
search::sublist_search::makeLinkedList(mainlistData);
|
||||
search::sublist_search::makeLinkedList(mainlistData);
|
||||
search::sublist_search::Node *sublistLL =
|
||||
search::sublist_search::makeLinkedList(sublistData);
|
||||
search::sublist_search::makeLinkedList(sublistData);
|
||||
|
||||
bool exists = search::sublist_search::sublistSearch(sublistLL, mainlistLL);
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user