OpenSoure_Repos/TheAlgorithms-C-Plus-Plus
1
0
Fork 0
mirror of https://hub.njuu.cf/TheAlgorithms/C-Plus-Plus.git synced 2023-10-11 13:05:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

added one liner docs

Browse Source
This commit is contained in:
foo290 2021-07-06 07:27:50 +05:30
parent e7b332e441
commit f6913b7521
No known key found for this signature in database
GPG Key ID: 37349CBEF6299747
1 changed files with 99 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
search/sublist_search.cpp
View File

@ -63,15 +63,14 @@ void printLinkedList(Node *start) {
/**
* @brief Give a vector of data,
* it adds each element of vector in the linked list and return the address of
* head pointer.
* it adds each element of vector in the linked list and return the address of head pointer.
* @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) {
/// This is used in test cases for rapidly creating linked list with 100+
/// elements, instead of hard-coding 100 elements in test cases.
/// This is used in test cases for rapidly creating linked list with 100+ elements, instead of hard-coding
/// 100 elements in test cases.
Node *head = nullptr;
Node *tail = nullptr;
for (int i : data) {
@ -124,22 +123,20 @@ bool sublistSearch(Node *sublist, Node *mainList) {
}
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.
/// 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;
}
/// set the target pointer again to stating point of target list.
target_ptr = sublist;
/// set the main pointer to the next element of the main list and repeat
/// the algo.
/// set the main pointer to the next element of the main list and repeat the algo.
mainList = mainList->next;
}
/// 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;
}
@ -183,7 +180,7 @@ class TestCases {
* @returns void
* */
void testCase_1() {
const bool expectedOutput = true; /// Expected output of this test
const bool expectedOutput = true; ///< Expected output of this test
log("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
"~");
@ -191,21 +188,16 @@ class TestCases {
log("Description:");
log(" EDGE CASE : Only contains one element");
std::vector<uint64_t> sublistData = {
6}; /// Data to make linked list which will be the sublist
std::vector<uint64_t> mainlistData = {
2, 5, 6, 7,
8}; /// Data to make linked list which will be the main list
std::vector<uint64_t> sublistData = {6}; ///< Data to make linked list which will be the sublist
std::vector<uint64_t> mainlistData = {2, 5, 6, 7, 8}; ///< Data to make linked list which will be the main list
search::sublist_search::Node *sublistLL =
search::sublist_search::makeLinkedList(
sublistData); /// Sublist to be searched
search::sublist_search::makeLinkedList(sublistData); ///< Sublist to be searched
search::sublist_search::Node *mainlistLL =
search::sublist_search::makeLinkedList(
mainlistData); /// Main list in which sublist is to be searched
search::sublist_search::makeLinkedList(mainlistData); ///< Main list in which sublist is to be searched
bool exists = search::sublist_search::sublistSearch(
sublistLL, mainlistLL); /// boolean, if sublist exist or not
sublistLL, mainlistLL); ///< boolean, if sublist exist or not
log("Checking assert expression...");
assert(exists == expectedOutput);
@ -227,16 +219,13 @@ class TestCases {
void testCase_2() {
const bool expectedOutput = true; /// Expected output of this test
log("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
"~");
log("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~");
log("This is test case 2 for sublist search Algorithm : ");
log("Description:");
log(" contains main list of 100 elements and sublist of 20");
std::vector<uint64_t> sublistData(
20); /// Data to make linked list which will be the sublist
std::vector<uint64_t> mainlistData(
100); /// Main list in which sublist is to be searched
std::vector<uint64_t> sublistData(20); ///< Data to make linked list which will be the sublist
std::vector<uint64_t> mainlistData(100); ///< Main list in which sublist is to be searched
for (int i = 0; i < 100; i++) {
/// Inserts 100 elements in main list
@ -251,22 +240,19 @@ class TestCases {
}
search::sublist_search::Node *sublistLL =
search::sublist_search::makeLinkedList(
sublistData); /// Sublist to be searched
search::sublist_search::makeLinkedList(sublistData); ///< Sublist to be searched
search::sublist_search::Node *mainlistLL =
search::sublist_search::makeLinkedList(
mainlistData); /// Main list in which sublist is to be searched
search::sublist_search::makeLinkedList(mainlistData); ///< Main list in which sublist is to be searched
bool exists = search::sublist_search::sublistSearch(
sublistLL, mainlistLL); // boolean, if sublist exist or not
sublistLL, mainlistLL); ///< boolean, if sublist exist or not
log("Checking assert expression...");
assert(exists == expectedOutput);
log("Assertion check passed!");
log("[PASS] : TEST CASE 2 PASS!");
log("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
"~");
log("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~");
}
/**
@ -275,17 +261,15 @@ class TestCases {
* @returns void
* */
void testCase_3() {
const bool expectedOutput = false; /// Expected output of this test
const bool expectedOutput = false; ///< Expected output of this test
log("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
"~");
log("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~");
log("This is test case 3 for sublist search Algorithm : ");
log("Description:");
log(" contains main list of 50 elements and sublist of 20");
std::vector<uint64_t> sublistData(20); /// Sublist to be searched
std::vector<uint64_t> mainlistData(
50); /// Main list in which sublist is to be searched
std::vector<uint64_t> sublistData(20); ///< Sublist to be searched
std::vector<uint64_t> mainlistData(50); ///< Main list in which sublist is to be searched
for (int i = 0; i < 50; i++) {
/// Inserts 100 elements in main list
@ -298,22 +282,19 @@ class TestCases {
}
search::sublist_search::Node *sublistLL =
search::sublist_search::makeLinkedList(
sublistData); /// Sublist to be searched
search::sublist_search::makeLinkedList(sublistData); ///< Sublist to be searched
search::sublist_search::Node *mainlistLL =
search::sublist_search::makeLinkedList(
mainlistData); /// Main list in which sublist is to be searched
search::sublist_search::makeLinkedList(mainlistData); ///< Main list in which sublist is to be searched
bool exists = search::sublist_search::sublistSearch(
sublistLL, mainlistLL); /// boolean, if sublist exist or not
sublistLL, mainlistLL); ///< boolean, if sublist exist or not
log("Checking assert expression...");
assert(exists == expectedOutput);
log("Assertion check passed!");
log("[PASS] : TEST CASE 3 PASS!");
log("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~"
"~");
log("~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~");
}
};