mirror of
https://hub.njuu.cf/TheAlgorithms/C-Plus-Plus.git
synced 2023-10-11 13:05:55 +08:00
some final docs fixes
This commit is contained in:
parent
2ba383d88a
commit
798972e934
@ -37,27 +37,27 @@ namespace search {
|
||||
* Search](https://www.geeksforgeeks.org/sublist-search-search-a-linked-list-in-another-list)
|
||||
* implementation
|
||||
*/
|
||||
namespace sublist_search {
|
||||
namespace sublist_search {
|
||||
/**
|
||||
* @brief A Node structure representing a single link Node in a linked list
|
||||
*/
|
||||
struct Node {
|
||||
struct Node {
|
||||
uint32_t data = 0; // The key/value of the node
|
||||
Node *next{}; // Pointer to the next node
|
||||
};
|
||||
};
|
||||
|
||||
/**
|
||||
* @brief A simple function to print the linked list
|
||||
* @param start The head of the linked list
|
||||
* @returns void
|
||||
*/
|
||||
void printLinkedList(Node *start) {
|
||||
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.
|
||||
@ -65,7 +65,7 @@ void printLinkedList(Node *start) {
|
||||
* stored in nodes of 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 *tail = nullptr;
|
||||
for (int i : data) {
|
||||
@ -81,7 +81,7 @@ Node *makeLinkedList(const std::vector<uint64_t> &data) {
|
||||
}
|
||||
}
|
||||
return head;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Main searching function
|
||||
@ -90,7 +90,7 @@ Node *makeLinkedList(const std::vector<uint64_t> &data) {
|
||||
* @returns true if the sublist is 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) {
|
||||
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
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace sublist_search
|
||||
} // 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.
|
||||
@ -152,7 +152,7 @@ class TestCases {
|
||||
std::cout << "[TESTS] : ---> " << msg << std::endl;
|
||||
}
|
||||
|
||||
public:
|
||||
public:
|
||||
/**
|
||||
* @brief Executes test cases
|
||||
* @returns void
|
||||
@ -190,7 +190,7 @@ class TestCases {
|
||||
search::sublist_search::makeLinkedList(mainlistData);
|
||||
|
||||
bool exists =
|
||||
search::sublist_search::sublistSearch(sublistLL, mainlistLL);
|
||||
search::sublist_search::sublistSearch(sublistLL, mainlistLL); // boolean, if sublist exist or not
|
||||
|
||||
log("Checking assert expression...");
|
||||
assert(exists == expectedOutput);
|
||||
@ -239,7 +239,7 @@ class TestCases {
|
||||
search::sublist_search::makeLinkedList(mainlistData);
|
||||
|
||||
bool exists =
|
||||
search::sublist_search::sublistSearch(sublistLL, mainlistLL);
|
||||
search::sublist_search::sublistSearch(sublistLL, mainlistLL); // boolean, if sublist exist or not
|
||||
|
||||
log("Checking assert expression...");
|
||||
assert(exists == expectedOutput);
|
||||
@ -283,7 +283,7 @@ class TestCases {
|
||||
search::sublist_search::makeLinkedList(mainlistData);
|
||||
|
||||
bool exists =
|
||||
search::sublist_search::sublistSearch(sublistLL, mainlistLL);
|
||||
search::sublist_search::sublistSearch(sublistLL, mainlistLL); // boolean, if sublist exist or not
|
||||
|
||||
log("Checking assert expression...");
|
||||
assert(exists == expectedOutput);
|
||||
@ -320,7 +320,7 @@ int main(int argc, char *argv[]) {
|
||||
search::sublist_search::Node *sublistLL =
|
||||
search::sublist_search::makeLinkedList(sublistData);
|
||||
|
||||
bool exists = search::sublist_search::sublistSearch(sublistLL, mainlistLL);
|
||||
bool exists = search::sublist_search::sublistSearch(sublistLL, mainlistLL); // boolean, if sublist exist or not
|
||||
|
||||
std::cout << "Sublist :" << std::endl;
|
||||
search::sublist_search::printLinkedList(sublistLL);
|
||||
|
Loading…
Reference in New Issue
Block a user