Skip to content

README.md

Latest commit

 

History

History
130 lines (97 loc) · 4.3 KB

README.md

File metadata and controls

130 lines (97 loc) · 4.3 KB

Doubly Linked List (DLL) Implementation in C

Overview

This repository provides a generic implementation of a doubly linked list (DLL) in C, allowing you to create and manipulate doubly linked lists with different data types, including int, float, char, and double. The implementation is designed to be flexible and easy to use, allowing users to perform various operations on the doubly linked list, such as insertion, deletion, retrieval, and updating of elements.

Table of Contents

Prerequisites

Before you begin, ensure you have the following installed on your system:

  • GCC or any C compiler

Compilation

Compile the provided C files to create the executable for the doubly linked list implementation. Run the following command in your terminal or command prompt:

gcc main.c dll.c -o main

Usage Examples

Here are some usage examples demonstrating how to use the functions provided by the DLL implementation:

Creating and Initializing a Doubly Linked List

#include <stdio.h>
#include "dll.h"

int main() {
    // Initialize a doubly linked list for int data type
    DLL__int intList;
    intList.head = NULL;
    intList.tail = NULL;
    intList.size = 0;

    // OR

    DLL__int intList = {NULL, NULL, 0};

    // Initialize a doubly linked list for float data type
    DLL__float floatList;
    floatList.head = NULL;
    floatList.tail = NULL;
    floatList.size = 0;

    // OR

    DLL__float floatList = {NULL, NULL, 0};

    // Initialize a doubly linked list for char data type
    DLL__char charList;
    charList.head = NULL;
    charList.tail = NULL;
    charList.size = 0;

    // OR

    DLL__char charList = {NULL, NULL, 0};

    // Initialize a doubly linked list for double data type
    DLL__double doubleList;
    doubleList.head = NULL;
    doubleList.tail = NULL;
    doubleList.size = 0;

    // OR

    DLL__double doubleList = {NULL, NULL, 0};

    // Perform operations on the initialized lists
    // ...

    return 0;
}

Inserting Elements into the Linked List

// Insert elements into the linked list
insertAtHead(&intList, 42, int); // OR insertAtHead__int(&intList, 42);
insertAtTail(&floatList, 3.14, float); // OR insertAtTail__float(&intList, 3.14);
insertAt(&charList, 'A', 1, char); // OR insertAt__char(&intList, 'A');

Deleting Elements from the Linked List

// Delete elements from the linked list
deleteHead(&intList, int); // OR deleteHead__int(&intList);
delete(&floatList, 3.14, float); // OR delete__float(&floatList, 3.14);
deleteAll(&charList, 'A', char); // OR deleteAll__char(&charList, 'A');

Retrieving and Updating Elements in the Linked List

// Retrieve data at a specific index
int dataAtIndex = getDataAt(&intList, 1, -1, int);
// Update data at a specific index
updateAt(&intList, 1, 99, int);

API Reference

Function Descriptions

  • insertAtHead(sll, data, type): Inserts the specified data at the head of the linked list.
  • insertAtTail(sll, data, type): Inserts the specified data at the tail of the linked list.
  • insertAt(sll, data, targetIdx, type): Inserts the specified data at the specified index in the linked list.
  • deleteHead(sll, type): Deletes the head node of the linked list.
  • delete(sll, targetData, type): Deletes the first occurrence of the specified data from the linked list.
  • deleteAll(sll, targetData, type): Deletes all occurrences of the specified data from the linked list.
  • getDataAt(sll, targetIdx, data404Response, type): Retrieves the data at the specified index in the linked list.
  • updateAt(sll, targetIdx, newData, type): Updates the data at the specified index in the linked list.
  • freeDLL(sll, type): Frees the memory occupied by all nodes in the linked list and resets the list.

For detailed function descriptions and usage examples, please refer to the header file dll.h and implementation file dll.c.

Contributing

Feel free to contribute by opening issues, proposing new features, or submitting pull requests. Your feedback and contributions are highly appreciated!

License

This project is licensed under the MIT License - see the LICENSE file for details.