Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare for release 1.0 #176

Merged
merged 2 commits into from
Dec 5, 2024
Merged

Prepare for release 1.0 #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3282c4
Prepare for release 1.0
lyrm Dec 3, 2024
65022f1
update saturn.mli
lyrm Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions CHANGES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
### 1.0.0

- Add lockfree Bag (@lyrm, @polytypic)
- Update Skiplist with better documentation and additional functions (@lyrm)
- Update Mpsc with better documentation and additional functions (@lyrm, @art-w)
- Update Michael-Scott queue with better documentation and additional functions (@lyrm, @art-w)
- Update Ws_deque with better documentation and additional functions (@lyrm, @art-w)
- Update Spsc with better documentation and additional functions (@lyrm, @art-w)
- Optimization of Ws_deque (@polytypic, @lyrm)
- Add Bounded Queue (@lyrm, @polytypic, @art-w)
- Add Bounded Stack (@lyrm, @art-w)
- Update Treiber Stack with better documentation and additional functions (@lyrm, @art-w)
- Remove Saturn_lockfree package (@lyrm)
- Remove relaxed_queue and M module in ws_deque (@lyrm)
- Add Htbl from Picos (@lyrm, @polytypic)

### 0.5.0

- Optimized Michael-Scott queue with a safe and an unsafe versions (@lyrm,
Expand Down
18 changes: 10 additions & 8 deletions src/saturn.mli
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,16 @@ Copyright (c) 2017, Nicolas ASSOUAD <[email protected]>

(** {2 Unsafe Data Structures}

Some data structures have both a normal and an {b unsafe} version. The
{b unsafe} version uses `Obj.magic`, which may be unsafe with flambda2
optimizations.

The unsafe version is provided because certain optimizations require features
not currently available in OCaml, such as arrays of atomics or atomic fields
in records. It is recommended to use the normal version unless performance
requirements necessitate the unsafe version. *)
Some data structures have both a normal and an {b unsafe} version. The
{b unsafe} version uses `Obj.magic`, which can be unsafe, especially with
flambda2 optimizations.

The unsafe version is provided to explore performance optimizations that
require features not currently available in OCaml, such as arrays of atomics
or atomic fields in records. These versions give an indication of the
potential performance improvements when such features become available.
It is recommended to use the normal version unless the performance
requirements justify the risks associated with the unsafe version. *)

(** {1 Data structures} *)

Expand Down