https://github.com/nam20485/staxlinkedlist

Doubly-Linked List for Stax application
https://github.com/nam20485/staxlinkedlist

Last synced: 2 months ago
JSON representation

Doubly-Linked List for Stax application

• Host: GitHub
• URL: https://github.com/nam20485/staxlinkedlist
• Owner: nam20485
• Created: 2024-03-19T20:47:43.000Z (about 1 year ago)
• Default Branch: development
• Last Pushed: 2024-03-29T16:07:19.000Z (about 1 year ago)
• Last Synced: 2025-02-02T04:31:53.700Z (4 months ago)
• Language: Objective-C
• Size: 170 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Build and Test](https://github.com/nam20485/StaxLinkedList/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/nam20485/StaxLinkedList/actions/workflows/build-and-test.yml)

[![Deploy API Documentation](https://github.com/nam20485/StaxLinkedList/actions/workflows/doxygen-gh-pages.yml/badge.svg)](https://github.com/nam20485/StaxLinkedList/actions/workflows/doxygen-gh-pages.yml)

# StaxLinkedList

Doubly-linked list created for the Stax application. The API is designed using the conventions of the STL containers, and an STL-like iterator class is provided. This means that the LinkedList class can be used with the `range-based for loop` and other standard methods in the STL `` header, such as `std::find`, `std::for_each`, etc. It is designed as a class template so it can be used with any type of data.

>The `StaxApplicationData` struct is an example of an application data object that can be used with the LinkedList class. A specialization of the LinkedList\ template for the StaxApplicationData struct is also provided in StaxAppData.h, named the `StaxAppData::LinkedList` type.

## Code

The majority of the LinkedList code can be found in `LinkedList.h`. The `main.cpp` file contains examples of usage of the LinkedList class. Test cases can be found in the `Tests` project's files.

* [LinkedList.h](StaxLinkedList/LinkedList.h)

* [main.cpp](StaxLinkedList/main.cpp)

* [LinkedListIterator.h](StaxLinkedList/LinkedListIterator.h)

* [StaxApplicationData.h](StaxLinkedList/StaxAppData.cpp)

## API Documentation

API documentation created with Doxygen can be viewed here:

* [Main API Page](https://nam20485.github.io/StaxLinkedList/annotated.html)

* [LinkedList class](https://nam20485.github.io/StaxLinkedList/classLinkedList.html)

* [LinkedListIterator class](https://nam20485.github.io/StaxLinkedList/classLinkedListIterator.html)

## Tests

Test cases can be found in the `Tests` project. The tests are written using the Google Test (GTest) testing framework. Automated tests run on every commit as part of the CI/CD pipeline.

>The random operations test is designed to stress test the LinkedList class, running 4,000,000 random operations on a linked list instance and then comparing the results to a `std::vector` that has had the same operations performed on it. The test checks that the linked list and vector have the same size and that the elements in the linked list are in the same order as the vector.

Test Case Files:

* [Logic Tests](Tests/LinkedListLogicTests.cpp)

* [Method Tests](Tests/LinkedListMethodTests.cpp)

* [Random Operations Test](Tests/RandomOperationsTests.cpp)

[Test results can be seen here.](https://github.com/nam20485/StaxLinkedList/actions/runs/8412559181/job/23033557118)

## Build

To build and run the project, open the `\StaxLinkedList.sln` file in Visual Studio and build the project. You can then run the project.