https://github.com/grindelfp/grindelf-queue

This is an implementation of a Queue data structure in C programming language.
https://github.com/grindelfp/grindelf-queue

c library queue

Last synced: about 1 month ago
JSON representation

This is an implementation of a Queue data structure in C programming language.

• Host: GitHub
• URL: https://github.com/grindelfp/grindelf-queue
• Owner: GrindelfP
• License: mit
• Created: 2023-10-05T18:05:04.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-27T09:04:40.000Z (about 1 year ago)
• Last Synced: 2023-10-28T10:31:51.083Z (about 1 year ago)
• Topics: c, library, queue
• Language: C
• Homepage: https://grindelfp.github.io/grindelf-queue-docs.github.io/
• Size: 36.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc

Awesome Lists containing this project

README

        
= Grindelf Queue =

== Description ==

This is an implementation of a Queue data structure in C programming language. The purpose of this project is purely educational which both let its creator study pointers and dynamical memory allocation in C programming language and Queue data structure.

== Documentation ==

You can access documentation of this library https://grindelfp.github.io/grindelf-queue-docs.github.io/[here].

== Installation ==

To use this library in your project you should follow these steps:

1) Place the file libgrindelf_queue.a in your project build directory (for a CMake project by default it is cmake-build-debug directory).

2) In your code add an include statement as follows:

[source, c]

----

#include "queue.h"

----

3.1) If you are using CMake, add the following lines to your CMakeLists.txt file:

[souce, CMake]

----

add_library(grindelf_queue STATIC IMPORTED)

set_target_properties(grindelf_queue PROPERTIES IMPORTED_LOCATION /path/to/library_directory/libgrindelf_queue.a)

target_link_libraries(your_target_name grindelf_queue)

----

Make sure you replace /path/to/library_directory/libgrindelf_queue.a with path to where you've placed your library .a file.

3.2) If you are not using CMake, add the following line to your compiler command (example given with gcc):

[source, bash]

----

gcc -o output_file source_file.c -L/path/to/library_directory -lgrindelf_queue

----

Make sure you replace /path/to/library_directory with path to where you've placed your library .a file (without filename in the path).

== Usage ==

To use this Queue data structure, you need to include the header file "queue.h" in your C program. Then, you need to initialize a Queue variable by calling the function "init()". This function will return a pointer to the new Queue variable.

*Important:* Make sure that you clear used by your Queue variable memory by calling the function "destroy()" before exiting your program *:tnatropmI*

To include an element into your Queue use the function "enqueue()".

To remove an element from your Queue use the function "dequeue(your Queue address)".

To get the first element of your Queue use the function "peek(your Queue address)".

To destroy your Queue use the function "destroy(your Queue address)".