Jupiter/Jupiter/SLList.h

/**
 * Copyright (C) 2013-2014 Justin James.
 *
 * This license must be preserved.
 * Any applications, libraries, or code which make any use of any
 * component of this program must not be commercial, unless explicit
 * permission is granted from the original author. The use of this
 * program for non-profit purposes is permitted.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 *
 * In the event that this license restricts you from making desired use of this program, contact the original author.
 * Written by Justin James <justin.aj@hotmail.com>
 */

#if !defined _SLLIST_H_HEADER
#define _SLLIST_H_HEADER

#include "Jupiter.h"
#include "List.h"

/**
* @file SLList.h
* @brief Provides a generic Singly Linked List implementation using the List interface.
*/

namespace Jupiter
{
	/**
	* @brief Provides a Singly Linked List implementation using the List interface.
	*/
	template<typename T> class SLList : public List<T>
	{
	public:

		/**
		* @brief Stores a pointer to data, and a pointer to the next node in the list.
		*/
		struct Node
		{
			Node *next = nullptr;
			T *data = nullptr;
		};

		/**
		* @brief Returns the n'th Node in the list.
		*
		* @param n Index of the node to return.
		* @return n'th Node in the list.
		*/
		Node *getNode(unsigned int n) const;

		/**
		* @brief Gets the data at a specified index.
		*
		* @param index Index of the data to get.
		* @return Data stored at the specified index.
		*/
		T *get(unsigned int index) const;

		/**
		* @brief Removes the n'th Node in the list, and returns its contents.
		*
		* @param n Index of the node to remove.
		* @return Contents of the node removed.
		*/
		T *remove(unsigned int n);

		/**
		* @brief Removes the next node in the list.
		*
		* @param data Node that preceeds the node to be removed.
		* @return Contents of the node removed if the node exists, nullptr otherwise.
		*/
		T *removeNext(Node *data);

		/**
		* @brief Adds data to the list at a specified index.
		*
		* @param data Data to add to the list.
		* @param index Position in the list to add the data to.
		*/
		void add(T *data, unsigned int index);

		/**
		* @brief Adds data to the front of the list.
		*
		* @param data Data to add to the list.
		*/
		void add(T *data);

		/**
		* @brief Default constructor for the SLList class.
		*/
		SLList();

		/**
		* @brief Copy constructor for the SLList class.
		*/
		SLList(const SLList<T> &);

		/**
		* @brief Destructor for the SLList class.
		* Note: This does not delete data added to the list.
		*/
		~SLList();

	/** Private members */
	private:
		Node *head;
	};

}

// Implementation

template<typename T> Jupiter::SLList<T>::SLList()
{
	Jupiter::SLList<T>::head = new Jupiter::SLList<T>::Node();
	Jupiter::List<T>::length = 0;
}

template<typename T> Jupiter::SLList<T>::SLList(const Jupiter::SLList<T> &source)
{
	Jupiter::SLList<T>::head = new Jupiter::SLList<T>::Node();
	Jupiter::SLList<T>::Node *sourceNode = source.head;
	
	head->data = sourceNode->data;
	sourceNode = sourceNode->next;

	Jupiter::SLList<T>::Node *n = Jupiter::SLList<T>::head;

	while (sourceNode != nullptr)
	{
		n->next = new Jupiter::SLList<T>::Node();
		n = n->next;
		n->data = sourceNode->data;
		sourceNode = sourceNode->next;
	}
	Jupiter::List<T>::length = source.length;
}

template<typename T> Jupiter::SLList<T>::~SLList()
{
	Jupiter::SLList<T>::Node *p;
	Jupiter::SLList<T>::Node *c = head;
	do
	{
		p = c;
		c = c->next;
		delete p;
	} while (c != nullptr);
}

template<typename T> typename Jupiter::SLList<T>::Node *Jupiter::SLList<T>::getNode(unsigned int index) const
{
	Jupiter::SLList<T>::Node *t = head->next;
	for (unsigned int i = 0; i != index; i++) t = t->next;
	return t;
}

template<typename T> T *Jupiter::SLList<T>::get(unsigned int index)
{
	return Jupiter::SLList<T>::getNode(index)->data;
}

template<typename T> const T *Jupiter::SLList<T>::get(unsigned int index) const
{
	return Jupiter::SLList<T>::getNode(index)->data;
}

template<typename T> T *Jupiter::SLList<T>::remove(unsigned int index)
{
	Jupiter::SLList<T>::Node *t = head;
	for (unsigned int i = 0; i != index; i++) t = t->next;
	Jupiter::SLList<T>::Node *t2 = t->next;
	T *r = t2->data;
	delete t2;
	Jupiter::List<T>::length--;
	return r;
}

template<typename T> T *Jupiter::SLList<T>::removeNext(Jupiter::SLList<T>::Node *data)
{
	Jupiter::SLList<T>::Node *t = data->next;
	if (t == nullptr) return nullptr;
	T *r = t->data;
	data->next = t->next;
	delete t;
	Jupiter::List<T>::length--;
	return r;
}

template<typename T> void Jupiter::SLList<T>::add(T *data, unsigned int index)
{
	Jupiter::SLList<T>::Node *n = new Jupiter::SLList<T>::Node();
	n->data = data;
	Jupiter::SLList<T>::Node *t = Jupiter::SLList<T>::head;
	for (unsigned int i = 0; i < index; i++) t = t->next;
	n->next = t->next;
	t->next = n;
	Jupiter::List<T>::length++;
}

template<typename T> void Jupiter::SLList<T>::add(T *data)
{
	Jupiter::SLList<T>::Node *n = new Jupiter::SLList<T>::Node();
	n->data = data;
	n->next = Jupiter::SLList<T>::head->next;
	Jupiter::SLList<T>::head->next = n;
	Jupiter::List<T>::length++;
}

#endif // _SLLIST_H_HEADER