Initial commit for circular doubly linked list class
This commit is contained in:
parent
7ebcb12569
commit
d53c83c748
|
|
@ -0,0 +1,23 @@
|
|||
CXX=g++
|
||||
CXXFLAGS=-g -Wall
|
||||
|
||||
###############################################################################
|
||||
# Driver
|
||||
###############################################################################
|
||||
|
||||
driver: driver.cpp circledoublelist.o
|
||||
${CXX} ${CXXFLAGS} driver.cpp circledoublelist.o -o driver
|
||||
|
||||
###############################################################################
|
||||
# CircleDoubleList
|
||||
###############################################################################
|
||||
|
||||
circledoublelist.o: circledoublelist.cpp circledoublelist.h
|
||||
${CXX} ${CXXFLAGS} -c circledoublelist.cpp -o circledoublelist.o
|
||||
|
||||
###############################################################################
|
||||
# Clean
|
||||
###############################################################################
|
||||
|
||||
clean:
|
||||
rm -f *.o driver
|
||||
|
|
@ -0,0 +1,338 @@
|
|||
/*#############################################################################
|
||||
## Author: Shaun Reed ##
|
||||
## Legal: All Content (c) 2020 Shaun Reed, all rights reserved ##
|
||||
## About: An example of a doubly linked list ##
|
||||
## ##
|
||||
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||
##############################################################################
|
||||
## doublelist.cpp
|
||||
*/
|
||||
|
||||
#include "circledoublelist.h"
|
||||
|
||||
|
||||
/******************************************************************************
|
||||
* Constructors, Destructors, Operators
|
||||
*****************************************************************************/
|
||||
|
||||
/** copy constructor
|
||||
* @brief Construct a new DoubleList::DoubleList object from an existing one
|
||||
*
|
||||
* @param rhs DoubleList object
|
||||
*/
|
||||
DdoubleList::DoubleList(const DoubleList& rhs)
|
||||
{
|
||||
Node *cp2 = rhs.head;
|
||||
Node *cp = rhs.head;
|
||||
Node *tempHead;
|
||||
if (cp == NULL) head = NULL;
|
||||
else {
|
||||
head = new Node(cp->data);
|
||||
tempHead = head;
|
||||
while (cp->next != NULL) {
|
||||
cp = cp->next;
|
||||
head->next = new Node(cp->data);
|
||||
head = head->next;
|
||||
}
|
||||
head = tempHead;
|
||||
}
|
||||
}
|
||||
/** operator=
|
||||
* @brief Assign two DoubleList objects equal using copy constr and class destr
|
||||
* Pass the rhs by value to create local copy, swap its contents
|
||||
* Destructor called on previous DoubleList data at the end of this scope
|
||||
*
|
||||
* @param rhs DoubleList object passed by value
|
||||
* @return DoubleList A deep copy of the rhs DoubleList object
|
||||
*/
|
||||
DoubleList DoubleList::operator=(DoubleList rhs)
|
||||
{
|
||||
if (this != &rhs) return *this;
|
||||
std::swap(head, rhs.head);
|
||||
return *this;
|
||||
}
|
||||
|
||||
/** destructor
|
||||
* @brief Destroy the DoubleList::DoubleList object
|
||||
*/
|
||||
DoubleList::~DoubleList()
|
||||
{
|
||||
makeEmpty();
|
||||
}
|
||||
|
||||
|
||||
/******************************************************************************
|
||||
* Public Member Functions
|
||||
*****************************************************************************/
|
||||
|
||||
/** insert
|
||||
* @brief Inserts a value to the head of our linked list
|
||||
*
|
||||
* @param x The value to be inserted
|
||||
*/
|
||||
bool DoubleList::insert(int val)
|
||||
{
|
||||
bool inserted = insert(val, head);
|
||||
if (inserted)
|
||||
std::cout << "[" << val << "] was inserted into the list\n";
|
||||
else std::cout << "[" << val << "] could not be inserted into the list\n";
|
||||
return inserted;
|
||||
}
|
||||
|
||||
/** insert at
|
||||
* @brief Inserts a value in the place of a given key
|
||||
* Key Node found is moved to the newNode->next positon
|
||||
*
|
||||
* @param key The value to search for to determine insert location
|
||||
* @param val The value to be inserted into the list
|
||||
*/
|
||||
bool DoubleList::insert(int val, int key)
|
||||
{
|
||||
bool inserted = insert(val, key, head);
|
||||
if (inserted)
|
||||
std::cout << "[" << val << "] was inserted into the list\n";
|
||||
else std::cout << "[" << val << "] could not be inserted into the list\n";
|
||||
return inserted;
|
||||
}
|
||||
|
||||
/** remove
|
||||
* @brief Removes a value in the list by calling a private member and handling output
|
||||
*
|
||||
* @param val Value to be removed from the list
|
||||
* @return true If the value was removed from the list
|
||||
* @return false If the value was not removed from the list
|
||||
*/
|
||||
bool DoubleList::remove(int val)
|
||||
{
|
||||
bool removed = remove(val, head);
|
||||
if (removed)
|
||||
std::cout << "[" << val << "] was removed from the list\n";
|
||||
else std::cout << "[" << val << "] could not be removed from the list\n";
|
||||
return removed;
|
||||
}
|
||||
|
||||
/** replace
|
||||
* @brief Replaces a value in the list by calling a private member and handling output
|
||||
*
|
||||
* @param val Value to insert into the list
|
||||
* @param key Value to be replaced within the list
|
||||
* @return true If the key has been replaced in the list by val
|
||||
* @return false If the key has not been replaced in the list by val
|
||||
*/
|
||||
bool DoubleList::replace(int val, int key)
|
||||
{
|
||||
bool replaced = replace(val, key, head);
|
||||
if (replaced)
|
||||
std::cout << "[" << key << "] was replaced by [" << val << "] in the list\n";
|
||||
else std::cout << "[" << key << "] could not be replaced by [" << val << "] in the list\n";
|
||||
return replaced;
|
||||
}
|
||||
|
||||
/** makeEmpty
|
||||
* @brief Empty this DoubleList object, deleting all associated Nodes
|
||||
*/
|
||||
void DoubleList::makeEmpty()
|
||||
{
|
||||
Node *nextNode, *temp;
|
||||
|
||||
if (head == NULL) return;
|
||||
nextNode = head->next;
|
||||
delete head;
|
||||
head = NULL;
|
||||
while(nextNode != NULL) {
|
||||
temp = nextNode;
|
||||
nextNode = nextNode->next;
|
||||
delete temp;
|
||||
temp = NULL;
|
||||
}
|
||||
}
|
||||
|
||||
/** isEmpty
|
||||
* @brief Determine if the DoubleList is empty
|
||||
*
|
||||
* @return true If the DoubleList::head is NULL
|
||||
* @return false If the DoubleList::head contains data
|
||||
*/
|
||||
bool DoubleList::isEmpty() const
|
||||
{
|
||||
return head == NULL;
|
||||
}
|
||||
|
||||
/** peek
|
||||
* @brief returns the value at the DoubleList::head
|
||||
*
|
||||
* @return int The value held at the Node pointed to by DoubleList::head
|
||||
*/
|
||||
int DoubleList::peek() const
|
||||
{
|
||||
if (!isEmpty())
|
||||
std::cout << "[" << head->data << "] is at the top of our list\n";
|
||||
else std::cout << "Nothing to peek, our list is empty...\n";
|
||||
return head->data;
|
||||
}
|
||||
|
||||
/** print
|
||||
* @brief Output the data held by the DoubleList object
|
||||
* Calls to the private print()
|
||||
*/
|
||||
void DoubleList::print() const
|
||||
{
|
||||
if(!isEmpty()) print(head);
|
||||
else std::cout << "Nothing to print, our list is empty...\n";
|
||||
}
|
||||
|
||||
/** find
|
||||
* @brief Calls to the private member find() and handles return cases
|
||||
*
|
||||
* @param val The value to search for within our DoubleList
|
||||
* @return true If the value was found in this DoubleList
|
||||
* @return false If the value was not found in this DoubleList
|
||||
*/
|
||||
bool DoubleList::find(int val) const
|
||||
{
|
||||
Node *result = find(val, head);
|
||||
if( result == NULL) {
|
||||
std::cout << "[" << val << "] Was not found in our list\n";
|
||||
return false;
|
||||
}
|
||||
|
||||
std::cout << "[" << result->data << "] Was found in our list\n";
|
||||
return true;
|
||||
}
|
||||
|
||||
|
||||
/******************************************************************************
|
||||
* Private Member Functions
|
||||
*****************************************************************************/
|
||||
|
||||
/** insert
|
||||
* @brief Private member to handle inserting value into the list
|
||||
*
|
||||
* @param val Value to be inserted
|
||||
* @param head The head of the list to insert the value into
|
||||
* @return true If the value was inserted
|
||||
* @return false If the value could not be inserted
|
||||
*/
|
||||
bool DoubleList::insert(int val, Node *&head)
|
||||
{
|
||||
Node *newNode = new Node(val);
|
||||
// If the list is not empty, update next pointer to head node
|
||||
if (!isEmpty()) {
|
||||
newNode->next = head;
|
||||
// Create a prev ptr for the head node
|
||||
head->prev = newNode;
|
||||
}
|
||||
// Always set head to our newNode
|
||||
head = newNode;
|
||||
return true;
|
||||
}
|
||||
|
||||
/** insert at
|
||||
* @brief Private member to handle inserting a value at a key within our list
|
||||
*
|
||||
* @param val Value to be inserted
|
||||
* @param key Key value to search for within the list
|
||||
* @param head Head node of the list to insert to
|
||||
* @return true If the value was inserted
|
||||
* @return false If the value was not inserted
|
||||
*/
|
||||
bool DoubleList::insert(int val, int key, Node *&head)
|
||||
{
|
||||
Node *newNode = new Node(val);
|
||||
if (isEmpty()) return false;
|
||||
// Let insert() handle inserting at the head
|
||||
else if (head->data == key) return insert(val);
|
||||
|
||||
Node *keyNode = find(key, head);
|
||||
// If there was no keyNode found, the key does is not in our list
|
||||
// Don't insert anything, return false and let caller decide whats next
|
||||
if (keyNode == NULL) return false;
|
||||
// Insert the newNode infront of the previous to the keyNode
|
||||
newNode->prev = keyNode->prev;
|
||||
keyNode->prev->next = newNode;
|
||||
|
||||
// Change the keyNode->prev ptr to newNode
|
||||
newNode->next = keyNode;
|
||||
keyNode->prev = newNode;
|
||||
return true;
|
||||
}
|
||||
|
||||
/** remove
|
||||
* @brief Private member to remove values from the list
|
||||
*
|
||||
* @param val Value to be removed
|
||||
* @param head Head of the list to remove the value from
|
||||
* @return true If the value has been removed from the list
|
||||
* @return false If the value has not been removed from the list
|
||||
*/
|
||||
bool DoubleList::remove(int val, Node *&head)
|
||||
{
|
||||
if (head == NULL) return false;
|
||||
else if (head->data == val) {
|
||||
head = head->next;
|
||||
return true;
|
||||
}
|
||||
|
||||
Node *keyNode = find(val, head);
|
||||
if (keyNode == NULL) return false;
|
||||
Node *gtfo = keyNode;
|
||||
if (keyNode->next != NULL) keyNode->next->prev = keyNode->prev;
|
||||
if (keyNode->prev != NULL) keyNode->prev->next = keyNode->next;
|
||||
delete gtfo;
|
||||
gtfo = NULL;
|
||||
return true;
|
||||
}
|
||||
|
||||
/** replace
|
||||
* @brief Private member to replace values within the list
|
||||
*
|
||||
* @param val Value to insert into the list
|
||||
* @param key Value to be replaced within the list
|
||||
* @param head Head of the list to replace the value
|
||||
* @return true If the key has been replaced by val within the list
|
||||
* @return false If the key has not been replaced by val within the list
|
||||
*/
|
||||
bool DoubleList::replace(int val, int key, Node *&head)
|
||||
{
|
||||
Node *replacee = find(key, head);
|
||||
if (replacee == NULL) return false;
|
||||
replacee->data = val;
|
||||
return true;
|
||||
}
|
||||
|
||||
/** find
|
||||
* @brief Find and return a Node which contains the given value
|
||||
*
|
||||
* @param val The value to search for within our DoubleList
|
||||
* @return DoubleList::Node* A pointer to the Node containing the search value
|
||||
*/
|
||||
DoubleList::Node* DoubleList::find(int val, Node *start) const
|
||||
{
|
||||
// If given a NULL list, return NULL
|
||||
// If given a head which contains the requested value, return the foundNode
|
||||
if (start == NULL || start->data == val) return start;
|
||||
|
||||
Node *foundNode = start;
|
||||
while (foundNode->next != NULL) {
|
||||
foundNode = foundNode->next;
|
||||
if (foundNode->data == val) return foundNode;
|
||||
}
|
||||
// If we have not yet returned a foundNode, the key is not in our list
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/** print
|
||||
* @brief Output the contents of a DoubleList from the given Node to NULL
|
||||
*
|
||||
* @param start The Node to begin traversing output from
|
||||
*/
|
||||
void DoubleList::print(Node *start) const
|
||||
{
|
||||
Node *temp = start;
|
||||
std::cout << "List Contents: ";
|
||||
while (temp != NULL) {
|
||||
std::cout << temp->data << " | ";
|
||||
temp = temp->next;
|
||||
}
|
||||
std::cout << std::endl;
|
||||
}
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
/*#############################################################################
|
||||
## Author: Shaun Reed ##
|
||||
## Legal: All Content (c) 2020 Shaun Reed, all rights reserved ##
|
||||
## About: An example of a doubly linked list ##
|
||||
## ##
|
||||
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||
##############################################################################
|
||||
## doublelist.h
|
||||
*/
|
||||
|
||||
#ifndef DOUBLELIST_H
|
||||
#define DOUBLELIST_H
|
||||
|
||||
#include <iostream>
|
||||
|
||||
class DoubleList {
|
||||
public:
|
||||
DoubleList() : head(NULL) {};
|
||||
DoubleList(const DoubleList& rhs);
|
||||
DoubleList operator=(DoubleList rhs);
|
||||
~DoubleList();
|
||||
bool insert(int val);
|
||||
bool insert(int val, int key);
|
||||
bool remove(int val);
|
||||
bool replace(int val, int key);
|
||||
void makeEmpty();
|
||||
bool isEmpty() const;
|
||||
int peek() const;
|
||||
void print() const;
|
||||
bool find(int val) const;
|
||||
|
||||
private:
|
||||
struct Node {
|
||||
int data;
|
||||
Node *next, *prev;
|
||||
Node(): data(), next(NULL), prev(NULL) {};
|
||||
Node(int val): data(val), next(NULL), prev(NULL) {};
|
||||
};
|
||||
Node *head;
|
||||
bool insert(int val, Node *&head);
|
||||
bool insert(int val, int key, Node *&head);
|
||||
bool remove(int val, Node *&head);
|
||||
bool replace(int val, int key, Node *&head);
|
||||
Node* find(int val, Node *start) const;
|
||||
void print(Node *start) const;
|
||||
};
|
||||
|
||||
#endif
|
||||
|
|
@ -0,0 +1,106 @@
|
|||
/*#############################################################################
|
||||
## Author: Shaun Reed ##
|
||||
## Legal: All Content (c) 2020 Shaun Reed, all rights reserved ##
|
||||
## About: A driver program to test a doubly linked list ##
|
||||
## ##
|
||||
## Contact: shaunrd0@gmail.com | URL: www.shaunreed.com | GitHub: shaunrd0 ##
|
||||
##############################################################################
|
||||
## driver.cpp
|
||||
*/
|
||||
|
||||
#include "circledoublelist.h"
|
||||
#include <iostream>
|
||||
|
||||
enum OPS {
|
||||
EXIT, INSERT, INSERTAT, EMPTY, PEEK, PRINT, FIND, REMOVE, REPLACE
|
||||
};
|
||||
|
||||
int main()
|
||||
{
|
||||
std::cout << "Driver: \n";
|
||||
|
||||
DoubleList testList;
|
||||
bool exit = false;
|
||||
int choice = -1;
|
||||
int val, key;
|
||||
|
||||
while (!exit)
|
||||
{
|
||||
std::cout << "##### Singly Linked List Menu #####\n\t0. Exit"
|
||||
<< "\n\t1. Insert\n\t2. Insert at\n\t3. Empty list\n\t4. Peek top of list"
|
||||
<< "\n\t5. Print list\n\t6. Find\n\t7. Remove\n\t8. Replace\n";
|
||||
std::cin >> choice;
|
||||
std::cin.clear();
|
||||
switch (choice) {
|
||||
case EXIT:
|
||||
exit = true;
|
||||
break;
|
||||
|
||||
case INSERT:
|
||||
std::cout << "Enter a value to add to our list: ";
|
||||
std::cin >> val;
|
||||
std::cin.clear();
|
||||
testList.insert(val);
|
||||
break;
|
||||
|
||||
case INSERTAT:
|
||||
std::cout << "Enter a new value to add to our list: ";
|
||||
std::cin >> val;
|
||||
std::cin.clear();
|
||||
std::cout << "Enter an existing value to insert at within our list: ";
|
||||
std::cin >> key;
|
||||
std::cin.clear();
|
||||
if (testList.insert(val, key)) {
|
||||
std::cout << "List after inserting ["
|
||||
<< val << "] at [" << key << "]: \n";
|
||||
testList.print();
|
||||
}
|
||||
break;
|
||||
|
||||
case EMPTY:
|
||||
testList.makeEmpty();
|
||||
break;
|
||||
|
||||
case PEEK:
|
||||
testList.peek();
|
||||
break;
|
||||
|
||||
case PRINT:
|
||||
testList.print();
|
||||
break;
|
||||
|
||||
case FIND:
|
||||
std::cout << "Enter an existing value to search for within our list: ";
|
||||
std::cin >> val;
|
||||
std::cin.clear();
|
||||
testList.find(val);
|
||||
break;
|
||||
|
||||
case REMOVE:
|
||||
std::cout << "Enter an existing value to remove from our list: ";
|
||||
std::cin >> val;
|
||||
std::cin.clear();
|
||||
testList.remove(val);
|
||||
break;
|
||||
|
||||
case REPLACE:
|
||||
std::cout << "Enter a new value to add to our list: ";
|
||||
std::cin >> val;
|
||||
std::cin.clear();
|
||||
std::cout << "Enter an existing value to replace within our list: ";
|
||||
std::cin >> key;
|
||||
std::cin.clear();
|
||||
if (testList.replace(val, key)) {
|
||||
std::cout << "List after replacing ["
|
||||
<< key << "] by [" << val << "]: \n";
|
||||
testList.print();
|
||||
}
|
||||
break;
|
||||
|
||||
default:
|
||||
std::cout << "Invalid entry...\n";
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue