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

Add more docs to rcompare #2073

Merged
merged 1 commit into from
Nov 5, 2024
Merged

Add more docs to rcompare #2073

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 9 additions & 1 deletion src/Fields/fieldvector.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -497,7 +497,15 @@ end
Recursively compare given fieldvectors via `==`.
Returns `true` if `x == y` recursively.

FieldVectors with different types are considered different.
The keyword `strict = true` allows users to additionally
check that the types match. If `strict = false`, then
`rcompare` will return `true` for `FieldVector`s and
`NamedTuple`s with the same properties but permuted order.
For example:

- `rcompare((;a=1,b=2), (;b=2,a=1); strict = true)` will return `false` and
- `rcompare((;a=1,b=2), (;b=2,a=1); strict = false)` will return `true`

"""
rcompare(
x::T,
Expand Down
Loading