search

DNedic / lockfree

A collection of lock-free data structures written in standard C++11
MIT License
791 stars 49 forks source link

There are no 'How it works' sections in data structure READMEs #16

Open DNedic opened 10 months ago

DNedic commented 10 months ago

In order to help both users, curious bystanders or people looking to contribute, we should have sections explaining how data structures work under the hood, prefferably with diagrams included.

For data structures that are widely used and documented, like the spsc::Queue, it might not be necessary.

gmottajr commented 9 months ago

Shall I help you out with that? Please assign this issue to me. I'm forking your repo.

DNedic commented 9 months ago

Hello @gmottajr , thank you for the offer, I would be glad to get any help!

I have already prepared some drafts for the Bipartite Buffer, so you might want to look at that when I push it, and do documentation for other data structures.