Compare commits

..

No commits in common. "8140187d226413824399667c3b950712d66f5802" and "73df7a5e740b4d4a08b9a9d92907699b993eedee" have entirely different histories.

View File

@ -18,8 +18,6 @@
#ifndef GLACIERDATA_H_
#define GLACIERDATA_H_
#include <stdbool.h>
/*
* create_node
*
@ -60,7 +58,7 @@ void add_child(struct node *parent, struct node *child);
/*
* print_tree
*
* DESCRIPTION: Print_tree prints a dependency tree specified at its root node.
* DESCRIPTION: Print_tree prints a dependency tree specified at its root node
* PARAMETERS:
* struct node *root -> The tree to print
* int level -> The number of levels to descend
@ -76,16 +74,6 @@ void print_tree(struct node *root, int level);
/**************************************************************************************************************/
/*
* queue
*
* DESCRIPTION: Queue is a type definition for the queue data structure.
*/
typedef struct queue;
/**************************************************************************************************************/
/*
* init_queue
*
@ -107,7 +95,7 @@ void init_queue(queue *q);
/*
* queue_is_empty
*
* DESCRIPTION: Queue_is_empty checks if queue *q is empty.
* DESCRIPTION: Queue_is_empty checks if queue *q is empty
* PARAMETERS:
* queue *q -> The queue to check
* RETURN VALUES:
@ -128,7 +116,7 @@ bool queue_is_empty(queue *q);
/*
* queue_is_full
*
* DESCRIPTION: Queue_is_full checks if queue *q is full.
* DESCRIPTION: Queue_is_full checks if queue *q is full
* PARAMETERS:
* queue *q -> The queue to check
* RETURN VALUES:
@ -149,80 +137,20 @@ bool queue_is_full(queue *q);
/*
* enqueue
*
* DESCRIPTION: Enqueue enqueues an element at the back of the queue.
* DESCRIPTION: Enqueue enqueues an element at the back of the queue
* PARAMETERS:
* queue *q -> The queue to enqueue to
* int value -> The value of the element to enqueue
* int value ->
* RETURN VALUES:
* None.
* true on full, false on not full
* CAVEATS:
* None.
* EXAMPLE:
* if (! queue_is_full(q)) {
* enqueue(q, 15);
* if (queue_is_full(q)) {
* printf("Queue is full\n");
* return;
* }
*/
void enqueue(queue *q, int value);
/**************************************************************************************************************/
/*
* dequeue
*
* DESCRIPTION: Dequeue dequeues an element at the front of the queue.
* PARAMETERS:
* queue *q -> The queue to dequeue to
* RETURN VALUES:
* None.
* CAVEATS:
* None.
* EXAMPLE:
* if (! queue_is_empty(q)) {
* dequeue(q);
* }
*/
void dequeue(queue *q);
/**************************************************************************************************************/
/*
* peek
*
* DESCRIPTION: Peek displays the first element in a specified queue.
* PARAMETERS:
* queue *q -> The queue to peek at
* RETURN VALUES:
* -1 on queue is empty, element value (!= -1) on success
* CAVEATS:
* None.
* EXAMPLE:
* if (! queue_is_full(q)) {
* peek(q);
* }
*/
int peek(queue *q);
/**************************************************************************************************************/
/*
* print_queue
*
* DESCRIPTION: Print_queue displays the contents of the queue in order.
* PARAMETERS:
* queue *q -> The queue to print
* RETURN VALUES:
* None.
* CAVEATS:
* None.
* EXAMPLE:
* if (! queue_is_full(q)) {
* print_queue(q);
* }
*/
void print_queue(queue *q);
#endif