LinkedList.c File Reference

#include <malloc.h>
#include "LinkedList.h"

Functions
List *	CreateList ()
	Create a List object. More...
void	FreeList (List *list)
	Free all memory allocated for the list. More...
size_t	GetListSize (List *list)
	Get the size of the list. More...
Node *	GetListHead (List *list)
	Get the list's head. More...
Node *	GetNextNode (Node *currentNode)
	Get the next node for the given node. More...
ListDataType	GetValue (Node *node)
	Get the value of the Node. More...
Node *	Insert (Node *after, ListDataType newValue)
	Inserts a new node after the given node. More...
Node *	PushFront (List *list, ListDataType newValue)
	Appends a new node to the head of the list. More...
Node *	PushBack (List *list, ListDataType newValue)
	Append a new node to the end of the list. More...
ListDataType	PopFront (List *list)
	Removes the node from the front of the list. More...
ListDataType	PopBack (List *list)
	Removes the node from the end of the list. More...
void	DeleteNode (List *list, Node *target)
	Delete node from list given node. More...
Node *	DeleteValue (List *list, ListDataType value)
	Deletes a node from the list given the value. More...
Node *	Find (List *list, ListDataType value)
	Finds the first node with the given value. More...

Function Documentation

CreateList()

List* CreateList

(

)

Create a List object.

Returns

List* The created List object

DeleteNode()

void DeleteNode	(	List *	list,
		Node *	target
	)

Delete node from list given node.

Parameters

list	The list to delete node from
target	The node to delete

DeleteValue()

Node* DeleteValue	(	List *	list,
		ListDataType	value
	)

Deletes a node from the list given the value.

Parameters

list	The list to delete the node from.
value	The value of the node to delete.

Returns

Node* NULL

Find()

Node* Find	(	List *	list,
		ListDataType	value
	)

Finds the first node with the given value.

Parameters

list	The list to search.
value	The value to search for.

Returns

Node* The first node with the given value.

FreeList()

void FreeList

(

List *

list

)

Free all memory allocated for the list.

Parameters

list	The List to be freed.

GetListHead()

Node* GetListHead

(

List *

list

)

Get the list's head.

Parameters

list

The list

Returns

Node* The list's head

GetListSize()

size_t GetListSize

(

List *

list

)

Get the size of the list.

Parameters

list	The list to get the size of

Returns

size_t The size of the list

GetNextNode()

Node* GetNextNode

(

Node *

currentNode

)

Get the next node for the given node.

Parameters

currentNode

The node to get the next node for

Returns

Node* The next node

GetValue()

ListDataType GetValue

(

Node *

node

)

Get the value of the Node.

Parameters

node	The Node to get the value from

Returns

ListDataType The value of the Node

Insert()

Node* Insert	(	Node *	after,
		ListDataType	newValue
	)

Inserts a new node after the given node.

Parameters

after	The node after which the new node is inserted.
newValue	The value of the new node.

Returns

Node* The new node.

PopBack()

ListDataType PopBack

(

List *

list

)

Removes the node from the end of the list.

Parameters

list	The list to remove the node from.

Returns

ListDataType The value of the removed node.

PopFront()

ListDataType PopFront

(

List *

list

)

Removes the node from the front of the list.

Parameters

list	The list to remove the node from.

Returns

ListDataType The value of the removed node.

PushBack()

Node* PushBack	(	List *	list,
		ListDataType	newValue
	)

Append a new node to the end of the list.

Parameters

list	The list to append to
newValue	The value to append

Returns

Node* The new node

PushFront()

Node* PushFront	(	List *	list,
		ListDataType	newValue
	)

Appends a new node to the head of the list.

Parameters

list	The list to append to.
newValue	The value to append.

Returns

Node* The new head of the list.