doubly_linked_list.h File Reference

The structure to store the information of a doubly linked list.

The structure to store the information of a doubly linked list node.

create_dlinkedlist

Creates a doubly liked list by allocating memory for it on the heap. Initialize the size to 0, as well as head, current, and tail pointer to NULL

Returns:

A pointer to an empty dlinkedlist

Definition at line 5 of file doubly_linked_list.cpp.

deleteBackward

Delete the node the current pointer is pointed at, and move the current pointer backwards. Be aware that deleteBackward will cause problem if the current pointer is pointing at list head (new head should be current->next, while the current pointer points at NULL)

Parameters:

dLinkedList

A pointer to the doubly linked list

Returns:

the data of the new current pointer and NULL if the current pointer is NULL

Definition at line 96 of file doubly_linked_list.cpp.

deleteForward

Delete the node the current pointer is pointed at, and move the current pointer forwards. Be aware that deleteForward will cause problem if the current pointer is pointing at list tail

Parameters:

dLinkedList

A pointer to the doubly linked list

Returns:

the data of the new current pointer and NULL if the current pointer is NULL

Definition at line 137 of file doubly_linked_list.cpp.

destroyList

Destroy the doubly linked list. Everything in the linked list including list structure, nodes and data are all freed from the heap

Parameters:

dLinkedList

A pointer to the doubly linked list

Definition at line 177 of file doubly_linked_list.cpp.

getCurrent

Return the data the current pointer is pointing at

Parameters:

dLinkedList

A pointer to the doubly linked list

Returns:

the current data or NULL if current == NULL

Definition at line 212 of file doubly_linked_list.cpp.

getHead

Return the data contained in the head of the doubly linked list, and set the list current pointer to head

Parameters:

dLinkedList

A pointer to the doubly linked list

Returns:

the head data or NULL if head == NULL

Definition at line 187 of file doubly_linked_list.cpp.

getNext

Return the next data the current pointer is pointing at, and move the current pointer to next node

Parameters:

dLinkedList

A pointer to the doubly linked list

Returns:

the next data or NULL if current == NULL

Definition at line 223 of file doubly_linked_list.cpp.

getPrevious

Return the previous data the current pointer is pointing at, and move the current pointer to previous node

Parameters:

dLinkedList

A pointer to the doubly linked list

Returns:

the previous data or NULL if current == NULL

Definition at line 235 of file doubly_linked_list.cpp.

getSize

Return the size of the doubly linked list

Parameters:

dLinkedList

A pointer to the doubly linked list

Returns:

the size

Definition at line 246 of file doubly_linked_list.cpp.

getTail

Return the data contained in the tail of the doubly linked list, and set the current pointer to tail

Parameters:

dLinkedList

A pointer to the doubly linked list

Returns:

the tail data or NULL if tail == NULL

Definition at line 200 of file doubly_linked_list.cpp.

insertAfter

Insert the new data to the doubly linked list right after the current pointer

Parameters:

dLinkedList	A pointer to the doubly linked list
newData	A void pointer to the new data that the user want to add after data

Returns:

1 if insert the new data successfully 0 if the current pointer is NULL

Definition at line 51 of file doubly_linked_list.cpp.

insertBefore

Insert the new data to the doubly linked list right before the current pointer

Parameters:

dLinkedList	A pointer to the doubly linked list
newData	A void pointer to the new data that the user want to add after data

Returns:

1 if insert the new data successfully 0 if the current pointer is NULL

Definition at line 73 of file doubly_linked_list.cpp.

InsertHead.

Insert the data to the head of the doubly linked list. Attention: All insert functions do not make change on the current pointer.

Parameters:

dLinkedList	A pointer to the doubly linked list
data	A void pointer to data the user is adding to the doubly linked list.

Definition at line 22 of file doubly_linked_list.cpp.

insertTail

Insert the data to the tail of the doubly linked list.

Parameters:

dLinkedList	A pointer to the doubly linked list
data	A void pointer to data the user is adding to the doubly linked list.

Definition at line 37 of file doubly_linked_list.cpp.