'optimist atomic queue' description is something different in read.md

Question

'optimist atomic queue' description is something different in read.md

jony999999 opened this issue a year ago · comments

In your bench code(benchmarks.cc), Just 'AtomicQueue/AtomicQueue' is defined with retryDecorator (i.e. busy-waits).
and Optimist alias is not defined with retryDecorator.

Maxim Egorushkin · Answer 1 · Sun Mar 19 2023 23:19:41 GMT+0800 (China Standard Time)

In your bench code(benchmarks.cc), Just 'AtomicQueue/AtomicQueue' is defined with retryDecorator (i.e. busy-waits). and Optimist alias is not defined with retryDecorator.

Correct. And..?

jony999999 · Answer 2 · Tue Mar 21 2023 07:13:16 GMT+0800 (China Standard Time)

readme.md decribes blow,

Available containers are:
AtomicQueue - a fixed size ring-buffer for atomic elements.
OptimistAtomicQueue - a faster fixed size ring-buffer for atomic elements which busy-waits when empty or full.
AtomicQueue2 - a fixed size ring-buffer for non-atomic elements.
OptimistAtomicQueue2 - a faster fixed size ring-buffer for non-atomic elements which busy-waits when empty or full.

Maxim Egorushkin · Answer 3 · Tue Mar 21 2023 10:05:56 GMT+0800 (China Standard Time)

In your bench code(benchmarks.cc), Just 'AtomicQueue/AtomicQueue' is defined with retryDecorator (i.e. busy-waits).
and Optimist alias is not defined with retryDecorator.

OptimistAtomicQueue2 - a faster fixed size ring-buffer for non-atomic elements which busy-waits when empty or full.

I believe documentation covers your question in https://github.com/max0x7ba/atomic_queue#api in paragraph starting with "Note that optimism ..."