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.

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

Update "flatten" to be more versatile #4

Merged
merged 2 commits into from
Mar 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @theMagicalKarp
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Iter

<img align="right" height="125" src="./docs/assets/iter.png" />
<p align="center">
<img height="125" src="./docs/assets/iter.png" />
</p>

[![Go Reference](https://pkg.go.dev/badge/github.com/theMagicalKarp/iter.svg)](https://pkg.go.dev/github.com/theMagicalKarp/iter)
[![Go Report Card](https://goreportcard.com/badge/github.com/theMagicalKarp/iter)](https://goreportcard.com/report/github.com/theMagicalKarp/iter)
Expand Down
7 changes: 5 additions & 2 deletions pkg/itertools/flatten.go
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,12 @@ func (f *flattenIter[T]) Next() (T, bool) {
return empty, false
}

func Flatten[T any](chain iter.Iterable[iter.Iterable[T]]) iter.Iterable[T] {
// Flatten returns an iterable that flattens a chain of iterables into a single iterable.
// It takes a variadic argument `chain` of type `iter.Iterable[iter.Iterable[T]]`, where `T` can be any type.
// The function returns an iterable of type `iter.Iterable[T]`.
func Flatten[T any](chain ...iter.Iterable[iter.Iterable[T]]) iter.Iterable[T] {
return &flattenIter[T]{
chain: chain,
chain: Chain(chain...),
current: nil,
}
}
88 changes: 88 additions & 0 deletions pkg/itertools/flatten_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ func ExampleFlatten() {
iter.New(
iter.New(1, 2, 3),
iter.New(4, 5, 6),
),
iter.New(
iter.New(7, 8, 9),
),
)
Expand Down Expand Up @@ -45,6 +47,32 @@ func TestFlattenBasic(t *testing.T) {
assert.Equal(t, 0, v)
}

func TestFlattenBasicMulti(t *testing.T) {
t.Parallel()

items := itertools.Flatten(
iter.New(
iter.New(1, 2, 3),
iter.New(4, 5, 6),
),
iter.New(
iter.New(7, 8, 9),
),
)

for i := 1; i < 10; i++ {
v, more := items.Next()
assert.True(t, more)
assert.Equal(t, i, v)
}
v, more := items.Next()
assert.False(t, more)
assert.Equal(t, 0, v)
v, more = items.Next()
assert.False(t, more)
assert.Equal(t, 0, v)
}

func TestFlattenWithEmpties(t *testing.T) {
t.Parallel()

Expand Down Expand Up @@ -72,6 +100,49 @@ func TestFlattenWithEmpties(t *testing.T) {
assert.Equal(t, 0, v)
}

func TestFlattenWithEmptiesMulti(t *testing.T) {
t.Parallel()

items := itertools.Flatten(
iter.New(
iter.New[int](),
iter.New(1, 2, 3),
iter.New(4, 5, 6),
iter.New[int](),
iter.New(7, 8, 9),
iter.New[int](),
),
iter.New[iter.Iterable[int]](),
iter.New(
iter.New[int](),
iter.New(1, 2, 3),
iter.New(4, 5, 6),
iter.New[int](),
iter.New(7, 8, 9),
iter.New[int](),
),
)

for i := 1; i < 10; i++ {
v, more := items.Next()
assert.True(t, more)
assert.Equal(t, i, v)
}

for i := 1; i < 10; i++ {
v, more := items.Next()
assert.True(t, more)
assert.Equal(t, i, v)
}

v, more := items.Next()
assert.False(t, more)
assert.Equal(t, 0, v)
v, more = items.Next()
assert.False(t, more)
assert.Equal(t, 0, v)
}

func TestFlattenEmpty(t *testing.T) {
t.Parallel()

Expand All @@ -84,3 +155,20 @@ func TestFlattenEmpty(t *testing.T) {
assert.False(t, more)
assert.Equal(t, 0, v)
}

func TestFlattenEmptyMulti(t *testing.T) {
t.Parallel()

items := itertools.Flatten(
iter.New[iter.Iterable[int]](),
iter.New[iter.Iterable[int]](),
iter.New[iter.Iterable[int]](),
)

v, more := items.Next()
assert.False(t, more)
assert.Equal(t, 0, v)
v, more = items.Next()
assert.False(t, more)
assert.Equal(t, 0, v)
}
Loading