Skip to content

improve atomic docs #42024

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

Merged
merged 3 commits into from
Aug 28, 2021
Merged

improve atomic docs #42024

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
454ce22
improve atomic docs
aviatesk Aug 27, 2021
5f3e909
Update base/docs/basedocs.jl
aviatesk Aug 27, 2021
32936f5
Update base/docs/basedocs.jl
aviatesk Aug 28, 2021
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
20 changes: 10 additions & 10 deletions base/docs/basedocs.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2003,24 +2003,23 @@ setfield!

These atomically perform the operations to simultaneously get and set a field:

y = getfield!(value, name)
y = getfield(value, name)
setfield!(value, name, x)
return y
```
"""
swapfield!

"""
modifyfield!(value, name::Symbol, op, x, [order::Symbol])
modifyfield!(value, i::Int, op, x, [order::Symbol])
modifyfield!(value, name::Symbol, op, x, [order::Symbol]) -> Pair
modifyfield!(value, i::Int, op, x, [order::Symbol]) -> Pair

These atomically perform the operations to get and set a field after applying
the function `op`.

y = getfield!(value, name)
y = getfield(value, name)
z = op(y, x)
setfield!(value, name, z)
return y, z
return y => z

If supported by the hardware (for example, atomic increment), this may be
optimized to the appropriate hardware instruction, otherwise it'll use a loop.
Expand All @@ -2029,18 +2028,19 @@ modifyfield!

"""
replacefield!(value, name::Symbol, expected, desired,
[success_order::Symbol, [fail_order::Symbol=success_order]) =>
(old, Bool)
[success_order::Symbol, [fail_order::Symbol=success_order]) -> (; old, success::Bool)
replacefield!(value, i::Int, expected, desired,
[success_order::Symbol, [fail_order::Symbol=success_order]) -> (; old, success::Bool)

These atomically perform the operations to get and conditionally set a field to
a given value.

y = getfield!(value, name, fail_order)
y = getfield(value, name, fail_order)
ok = y === expected
if ok
setfield!(value, name, desired, success_order)
end
return y, ok
return (; old = y, success = ok)

If supported by the hardware, this may be optimized to the appropriate hardware
instruction, otherwise it'll use a loop.
Expand Down