Skip to content

Commit

Permalink
change(docs): Move the trivial type limitation notice to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
DNedic committed Feb 25, 2024
1 parent b4b8c79 commit 27a3720
Show file tree
Hide file tree
Showing 5 changed files with 3 additions and 8 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ On embedded systems, ```LOCKFREE_CACHE_COHERENT``` should almost always be set a

Additionally, some systems have a non-typical cacheline length (for instance the apple M1/M2 CPUs have a cacheline length of 128 bytes), and ```LOCKFREE_CACHELINE_LENGTH``` should be set accordingly in those cases.

## Known limitations
All of the data structures in `lockfree` are only meant to be used for [trivial](https://en.cppreference.com/w/cpp/language/classes#Trivial_class) types.

## FAQ
### Why would I use this over locking data structures on a hosted machine?

Expand Down
2 changes: 0 additions & 2 deletions docs/mpmc/priority_queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
## When to use the Priority Queue
The Priority Queue should be used when there are distinct priorities between elements to be enqueued, for instance different urgency signals between threads or packets of different priorities.

> Note: At the moment, the Queue is only meant to be used for [trivial](https://en.cppreference.com/w/cpp/language/classes#Trivial_class) types.
## How to use
Shown here is an example of typical use:
* Initialization
Expand Down
2 changes: 0 additions & 2 deletions docs/mpmc/queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
## When to use the Queue
The Queue is the simplest data structure in the library, and it should be used when single element operations are dominant. It has the simplest API and lowest overhead per operation.

> Note: At the moment, the Queue is only meant to be used for [trivial](https://en.cppreference.com/w/cpp/language/classes#Trivial_class) types.
## How to use
Shown here is an example of typical use:
* Initialization
Expand Down
2 changes: 0 additions & 2 deletions docs/spsc/priority_queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
## When to use the Priority Queue
The Priority Queue should be used when there are distinct priorities between elements to be enqueued, for instance different urgency signals between threads or packets of different priorities.

> Note: At the moment, the Queue is only meant to be used for [trivial](https://en.cppreference.com/w/cpp/language/classes#Trivial_class) types.
## How to use
Shown here is an example of typical use:
* Initialization
Expand Down
2 changes: 0 additions & 2 deletions docs/spsc/queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@
## When to use the Queue
Queue is the simplest data structure in the library, and it should be used when single element operations are dominant. It has the simplest API and lowest overhead per operation.

> Note: At the moment, the Queue is only meant to be used for [trivial](https://en.cppreference.com/w/cpp/language/classes#Trivial_class) types.
## How to use
Shown here is an example of typical use:
* Initialization
Expand Down

0 comments on commit 27a3720

Please sign in to comment.