Skip to content

Implement iterator deduplicator #3381

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
Sep 11, 2024
Merged

Implement iterator deduplicator #3381

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
463ce02
Implement iterator deduplicator
StephenButtolph Sep 11, 2024
3cc413a
Reuse Filter
StephenButtolph Sep 11, 2024
4de908e
Merge branch 'master' into implement-deduplication-iterator
StephenButtolph Sep 11, 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
15 changes: 15 additions & 0 deletions utils/iterator/filter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

package iterator

import "github.com/ava-labs/avalanchego/utils/set"

var _ Iterator[any] = (*filtered[any])(nil)

type filtered[T any] struct {
Expand All @@ -19,6 +21,19 @@ func Filter[T any](it Iterator[T], filter func(T) bool) Iterator[T] {
}
}

// Deduplicate returns an iterator that skips the elements that have already
// been returned from [it].
func Deduplicate[T comparable](it Iterator[T]) Iterator[T] {
var seen set.Set[T]
return Filter(it, func(e T) bool {
if seen.Contains(e) {
return true
}
seen.Add(e)
return false
})
}

func (i *filtered[_]) Next() bool {
for i.it.Next() {
element := i.it.Value()
Expand Down
15 changes: 12 additions & 3 deletions utils/iterator/filter_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,9 @@ import (
"github.com/stretchr/testify/require"

"github.com/ava-labs/avalanchego/ids"
"github.com/ava-labs/avalanchego/utils/iterator"
"github.com/ava-labs/avalanchego/vms/platformvm/state"

. "github.com/ava-labs/avalanchego/utils/iterator"
)

func TestFilter(t *testing.T) {
Expand Down Expand Up @@ -40,8 +41,8 @@ func TestFilter(t *testing.T) {
stakers[3].TxID: stakers[3],
}

it := iterator.Filter(
iterator.FromSlice(stakers[:3]...),
it := Filter(
FromSlice(stakers[:3]...),
func(staker *state.Staker) bool {
_, ok := maskedStakers[staker.TxID]
return ok
Expand All @@ -55,3 +56,11 @@ func TestFilter(t *testing.T) {
it.Release()
require.False(it.Next())
}

func TestDeduplicate(t *testing.T) {
require.Equal(
t,
[]int{0, 1, 2, 3},
ToSlice(Deduplicate(FromSlice(0, 1, 2, 1, 2, 0, 3))),
)
}
Loading