Skip to content

Fix docstring TruncationIntersection #21

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
lkdvos merged 1 commit into from
Apr 17, 2025
Merged

Fix docstring TruncationIntersection #21

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
7 changes: 5 additions & 2 deletions src/implementations/truncation.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,14 +90,17 @@
truncabove(atol) = TruncationKeepFiltered(≤(atol) ∘ abs)

"""
TruncationIntersection(trunc1::TruncationStrategy, trunc2::TruncationStrategy)
TruncationIntersection(trunc::TruncationStrategy, truncs::TruncationStrategy...)

Compose two truncation strategies, keeping values common between the two strategies.
Composition of multiple truncation strategies, keeping values common between them.
"""
struct TruncationIntersection{T<:Tuple{Vararg{TruncationStrategy}}} <:
TruncationStrategy
components::T
end
TruncationIntersection(trunc::TruncationStrategy, truncs::TruncationStrategy...) =

Check warning on line 101 in src/implementations/truncation.jl

View check run for this annotation

Codecov / codecov/patch

src/implementations/truncation.jl#L101 

Added line #L101 was not covered by tests
TruncationIntersection((trunc, truncs...))

function Base.:&(trunc1::TruncationStrategy, trunc2::TruncationStrategy)
return TruncationIntersection((trunc1, trunc2))
end
Expand Down
Loading