https://github.com/dxrzc/list-data-structure-cpp
Templated circular doubly linked list implementation in modern C++ focusing on low-level design, iterator support and move semantics.
https://github.com/dxrzc/list-data-structure-cpp
cmake cpp20 data-structures googletest
Last synced: 8 days ago
JSON representation
Templated circular doubly linked list implementation in modern C++ focusing on low-level design, iterator support and move semantics.
- Host: GitHub
- URL: https://github.com/dxrzc/list-data-structure-cpp
- Owner: dxrzc
- Created: 2024-11-01T17:35:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-02-14T20:29:17.000Z (4 months ago)
- Last Synced: 2026-02-15T03:41:11.655Z (4 months ago)
- Topics: cmake, cpp20, data-structures, googletest
- Language: C++
- Homepage:
- Size: 3.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.MD
Awesome Lists containing this project
README
# List Data Structure (C++20)
This repository provides a templated circular doubly linked list implemented in modern C++ (C++20), focusing on iterator support, move semantics, and correctness.
## Features
### Core design
- Templated circular doubly linked list
- Head node design that does not require a default-constructible type
- Strong ownership and memory management guarantees
### Iterators
- Forward iterator
- Const forward iterator
- Reverse iterator
- Const reverse iterator
- Compatible with `std::advance`, range-based for loops, and standard algorithms
### Operations
- Copy and move semantics
- In-place element construction (`emplace`)
- Element access and traversal
- Conditional removal (`remove_if`)
- Element lookup returning iterators
- List reversal
- In-place sorting (QuickSort-based implementation)
- Splicing elements between lists
### Testing
- Unit tests implemented using Google Test
### Continuous integration
Linux-based builds with compiler matrix:
- GCC
- Clang
## Build and test
### Requirements
- C++20 compatible compiler
- CMake
- Ninja (recommended)
```bash
git clone https://github.com/dxrzc/list-data-structure-cpp.git
cd list-data-structure-cpp
cmake -S . -B build -G Ninja -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
cmake --build build
cd build
ctest
```
## Usage
The following example demonstrates usage of the list with custom types, move semantics, sorting, and standard library interoperability.
```cpp
#include "list.h"
#include
#include
#include
#include
class User
{
private:
std::string m_username;
std::string m_id;
list m_items;
public:
User() = delete;
User(const User &rhs) = default;
User(User &&rhs) = default;
User(const std::string &username, const std::string &id, const list &items = {})
: m_username(username),
m_id(id),
m_items(items)
{}
std::size_t add_item(const std::string &item_id)
{
m_items.push_back(item_id);
return m_items.size();
}
auto operator<=>(const User &user) const
{
return m_username <=> user.m_username;
}
friend std::ostream &operator<<(std::ostream &os, const User &user)
{
os << "User { name:\"" << user.m_username << "\", id:\"" << user.m_id << "\", items:[";
for (std::size_t i = 0; i < user.m_items.size(); ++i)
{
os << "\"" << user.m_items[i] << "\"";
if (i + 1 < user.m_items.size())
os << ", ";
}
os << "]}";
return os;
}
};
int main()
{
try
{
list users;
// Create and copy
User user1{"Lance", "1457"};
user1.add_item("item1");
user1.add_item("item2");
users.push_back(user1);
// Create and "move"
User user2{"Conor", "54321"};
user2.add_item("itemA");
user2.add_item("itemB");
users.push_back(std::move(user2));
// Create in list
users.emplace_back("Ryley", "12345", list{"itemX", "itemY"});
// Sort by name
users.sort();
// Print
std::ranges::copy(users, std::ostream_iterator(std::cout, "\n"));
}
catch (const std::exception &e)
{
std::cerr << e.what() << '\n';
}
}
```
Output:
```
User { name:"Conor", id:"54321", items:["itemA", "itemB"]}
User { name:"Lance", id:"1457", items:["item1", "item2"]}
User { name:"Ryley", id:"12345", items:["itemX", "itemY"]}
```